diff mbox

[v3,8/8] Make the "info proc" documentation more consistent.

Message ID 20180918185444.89533-9-jhb@FreeBSD.org
State New
Headers show

Commit Message

John Baldwin Sept. 18, 2018, 6:54 p.m. UTC
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(-)

Comments

Eli Zaretskii Sept. 18, 2018, 7:16 p.m. UTC | #1
> From: John Baldwin <jhb@FreeBSD.org>
> Date: Tue, 18 Sep 2018 11:54:44 -0700
> 
> 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".

OK, thanks.
diff mbox

Patch

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);
 }