public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: John Baldwin <jhb@FreeBSD.org>
To: gdb-patches@sourceware.org
Subject: [PATCH v3 8/8] Make the "info proc" documentation more consistent.
Date: Tue, 18 Sep 2018 18:55:00 -0000	[thread overview]
Message-ID: <20180918185444.89533-9-jhb@FreeBSD.org> (raw)
In-Reply-To: <20180918185444.89533-1-jhb@FreeBSD.org>

Remove "running" in a few places since "info proc" can be used with
core dumps as well as running processes on both Linux and FreeBSD.

Use "the specified process" in the description of most "info proc"
subcommands.

Use "additional information" instead of "/proc process information" in
the "info proc" description to more closely match the language in the
manual.

gdb/ChangeLog:

	* infcmd.c (_initialize_infcmd): Remove "running" from "info proc"
	description.  Make "info proc" command descriptions more
	consistent.

gdb/doc/ChangeLog:

	* gdb.texinfo (info proc): Remove "running".
	(info proc mappings): Replace "program" with "process".
---
 gdb/ChangeLog       |  6 ++++++
 gdb/doc/ChangeLog   |  5 +++++
 gdb/doc/gdb.texinfo |  4 ++--
 gdb/infcmd.c        | 12 ++++++------
 4 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 5ae5a2dbee..0523dde860 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,9 @@
+2018-09-17  John Baldwin  <jhb@FreeBSD.org>
+
+	* infcmd.c (_initialize_infcmd): Remove "running" from "info proc"
+	description.  Make "info proc" command descriptions more
+	consistent.
+
 2018-09-17  John Baldwin  <jhb@FreeBSD.org>
 
 	* NEWS: Mention 'info proc files' command.
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 2128923515..05d4f8a890 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2018-09-17  John Baldwin  <jhb@FreeBSD.org>
+
+	* gdb.texinfo (info proc): Remove "running".
+	(info proc mappings): Replace "program" with "process".
+
 2018-09-17  John Baldwin  <jhb@FreeBSD.org>
 
 	* gdb.texinfo (Process Information): Document "info proc files"
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 233af61405..b5b6089153 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -22219,7 +22219,7 @@ systems.
 @cindex process ID
 @item info proc
 @itemx info proc @var{process-id}
-Summarize available information about any running process.  If a
+Summarize available information about a process.  If a
 process ID is specified by @var{process-id}, display information about
 that process; otherwise display information about the program being
 debugged.  The summary includes the debugged process ID, the command
@@ -22280,7 +22280,7 @@ Open files:
 
 @item info proc mappings
 @cindex memory address space mappings
-Report the memory address space ranges accessible in the program.  On
+Report the memory address space ranges accessible in a process.  On
 Solaris and FreeBSD systems, each memory range includes information on
 whether the process has read, write, or execute access rights to each
 range.  On @sc{gnu}/Linux and FreeBSD systems, each memory range
diff --git a/gdb/infcmd.c b/gdb/infcmd.c
index d3d47cd222..da0cb340ac 100644
--- a/gdb/infcmd.c
+++ b/gdb/infcmd.c
@@ -3522,13 +3522,13 @@ in the named register groups."));
 
   add_prefix_cmd ("proc", class_info, info_proc_cmd,
 		  _("\
-Show /proc process information about any running process.\n\
+Show additional information about a process.\n\
 Specify any process id, or use the program being debugged by default."),
 		  &info_proc_cmdlist, "info proc ",
 		  1/*allow-unknown*/, &infolist);
 
   add_cmd ("mappings", class_info, info_proc_cmd_mappings, _("\
-List of mapped memory regions."),
+List memory regions mapped by the specified process."),
 	   &info_proc_cmdlist);
 
   add_cmd ("stat", class_info, info_proc_cmd_stat, _("\
@@ -3540,15 +3540,15 @@ List process info from /proc/PID/status."),
 	   &info_proc_cmdlist);
 
   add_cmd ("cwd", class_info, info_proc_cmd_cwd, _("\
-List current working directory of the process."),
+List current working directory of the specified process."),
 	   &info_proc_cmdlist);
 
   add_cmd ("cmdline", class_info, info_proc_cmd_cmdline, _("\
-List command line arguments of the process."),
+List command line arguments of the specified process."),
 	   &info_proc_cmdlist);
 
   add_cmd ("exe", class_info, info_proc_cmd_exe, _("\
-List absolute filename for executable of the process."),
+List absolute filename for executable of the specified process."),
 	   &info_proc_cmdlist);
 
   add_cmd ("files", class_info, info_proc_cmd_files, _("\
@@ -3556,6 +3556,6 @@ List files opened by the specified process."),
 	   &info_proc_cmdlist);
 
   add_cmd ("all", class_info, info_proc_cmd_all, _("\
-List all available /proc info."),
+List all available info about the specified process."),
 	   &info_proc_cmdlist);
 }
-- 
2.18.0

  parent reply	other threads:[~2018-09-18 18:55 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-18 18:55 [PATCH v3 0/8] Add a new 'info proc files' command John Baldwin
2018-09-18 18:55 ` [PATCH v3 2/8] Generate aclocal-m4-deps.mk more deterministically and portably John Baldwin
2018-09-18 20:27   ` Simon Marchi
2018-09-19  3:01     ` Sergio Durigan Junior
2018-09-18 18:55 ` John Baldwin [this message]
2018-09-18 19:16   ` [PATCH v3 8/8] Make the "info proc" documentation more consistent Eli Zaretskii
2018-10-06 15:26   ` [PATCH] Update string expected from "help info proc" on gdb.base/info-proc.exp Sergio Durigan Junior
2018-10-08 15:55     ` John Baldwin
2018-09-18 18:55 ` [PATCH v3 7/8] Document the 'info proc files' command John Baldwin
2018-09-18 19:16   ` Eli Zaretskii
2018-09-18 18:55 ` [PATCH v3 1/8] Use KF_PATH to verify the size of a struct kinfo_file John Baldwin
2018-09-18 18:55 ` [PATCH v3 3/8] Import gnulib's inet_ntop module John Baldwin
2018-09-18 18:55 ` [PATCH v3 6/8] Support 'info proc files' on live FreeBSD processes John Baldwin
2018-09-18 19:04 ` [PATCH v3 5/8] Add support for 'info proc files' on FreeBSD core dumps John Baldwin
2018-09-18 19:04 ` [PATCH v3 4/8] Add a new 'info proc files' subcommand of 'info proc' John Baldwin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180918185444.89533-9-jhb@FreeBSD.org \
    --to=jhb@freebsd.org \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).