[doc patch] Use plural for global debug info dir(s)

[doc patch] Use plural for global debug info dir(s)

[Jan Kratochvil]

Hi Eli,

since
	commit 36ae52d16cc9d38cfe317a79bb5d63c624359154
	Author: Jan Kratochvil <jan.kratochvil@redhat.com>
	Date:   Mon Nov 2 14:59:48 2009 +0000

GDB supports multiple paths specified in 'set debug-file-directory'.
Documentation is still inconsistent in this regard.


Thanks,
Jan


gdb/doc/
2012-05-12  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* gdb.texinfo (Separate Debug Files): Use plural form for global
	debugging information directory.

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 38ef079..d927b92 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -16201,7 +16201,7 @@ Show whether a source file may have multiple base names.
 @cindex debugging information in separate files
 @cindex @file{.debug} subdirectories
 @cindex debugging information directory, global
-@cindex global debugging information directory
+@cindex global debugging information directories
 @cindex build ID, and separate debugging files
 @cindex @file{.build-id} directory
 
@@ -16247,12 +16247,12 @@ uses two different methods of looking for the debug file:
 For the ``debug link'' method, @value{GDBN} looks up the named file in
 the directory of the executable file, then in a subdirectory of that
 directory named @file{.debug}, and finally under the global debug
-directory, in a subdirectory whose name is identical to the leading
+directories, in a subdirectory whose name is identical to the leading
 directories of the executable's absolute file name.
 
 @item
 For the ``build ID'' method, @value{GDBN} looks in the
-@file{.build-id} subdirectory of the global debug directory for a file
+@file{.build-id} subdirectory of the global debug directories for a file
 named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
 are the rest of the bit string.  (Real build ID strings are 32 or more
@@ -16262,7 +16262,7 @@ hex characters, not 10.)
 So, for example, suppose you ask @value{GDBN} to debug
 @file{/usr/bin/ls}, which has a debug link that specifies the
 file @file{ls.debug}, and a build ID whose value in hex is
-@code{abcdef1234}.  If the global debug directory is
+@code{abcdef1234}.  If the global debug directories path component is
 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
 debug information files, in the indicated order:
 
@@ -16277,7 +16277,7 @@ debug information files, in the indicated order:
 @file{/usr/lib/debug/usr/bin/ls.debug}.
 @end itemize
 
-You can set the global debugging info directory's name, and view the
+You can set the global debugging info directories, and view the
 name @value{GDBN} is currently using.
 
 @table @code

Re: [doc patch] Use plural for global debug info dir(s)

[Eli Zaretskii]

> Date: Sat, 12 May 2012 11:02:27 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> 
> since
> 	commit 36ae52d16cc9d38cfe317a79bb5d63c624359154
> 	Author: Jan Kratochvil <jan.kratochvil@redhat.com>
> 	Date:   Mon Nov 2 14:59:48 2009 +0000
> 
> GDB supports multiple paths specified in 'set debug-file-directory'.
> Documentation is still inconsistent in this regard.

Thanks for catching this.

>  For the ``debug link'' method, @value{GDBN} looks up the named file in
>  the directory of the executable file, then in a subdirectory of that
>  directory named @file{.debug}, and finally under the global debug
> -directory, in a subdirectory whose name is identical to the leading
> +directories, in a subdirectory whose name is identical to the leading
>  directories of the executable's absolute file name.

I would rephrase slightly

		      ... and finally under each one of the global debug
   directories, in a subdirectory whose name is identical to the leading
   directories of the executable's absolute file name.

>  For the ``build ID'' method, @value{GDBN} looks in the
> -@file{.build-id} subdirectory of the global debug directory for a file
> +@file{.build-id} subdirectory of the global debug directories for a file
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Likewise here: "of each one of the global debug directories".

> -@code{abcdef1234}.  If the global debug directory is
> +@code{abcdef1234}.  If the global debug directories path component is
>  @file{/usr/lib/debug}, then @value{GDBN} will look for the following
>  debug information files, in the indicated order:

   If the list of the global debug directories includes
   @file{/usr/lib/debug}, then @value{GDBN} will look ...

> -You can set the global debugging info directory's name, and view the
> +You can set the global debugging info directories, and view the
>  name @value{GDBN} is currently using.
   ^^^^
I would use "list" here, as it's no longer a single name.

OK with those changes.

[commit] [doc patch] Use plural for global debug info dir(s)

[Jan Kratochvil]

On Sat, 12 May 2012 11:32:40 +0200, Eli Zaretskii wrote:
> Thanks for catching this.

In fact I have caused it by not updating the doc while updating the code.


> OK with those changes.

Changed and checked in.


Thanks,
Jan


http://sourceware.org/ml/gdb-cvs/2012-05/msg00091.html

--- src/gdb/doc/ChangeLog	2012/05/11 22:24:22	1.1315
+++ src/gdb/doc/ChangeLog	2012/05/12 14:20:30	1.1316
@@ -1,3 +1,9 @@
+2012-05-12  Jan Kratochvil  <jan.kratochvil@redhat.com>
+	    Eli Zaretskii  <eliz@gnu.org>
+
+	* gdb.texinfo (Separate Debug Files): Use plural form for global
+	debugging information directory.
+
 2012-05-11  Stan Shebs  <stan@codesourcery.com>
 	    Kwok Cheung Yeung  <kcy@codesourcery.com>
 
--- src/gdb/doc/gdb.texinfo	2012/05/11 22:24:22	1.961
+++ src/gdb/doc/gdb.texinfo	2012/05/12 14:20:31	1.962
@@ -16287,7 +16287,7 @@
 @cindex debugging information in separate files
 @cindex @file{.debug} subdirectories
 @cindex debugging information directory, global
-@cindex global debugging information directory
+@cindex global debugging information directories
 @cindex build ID, and separate debugging files
 @cindex @file{.build-id} directory
 
@@ -16332,14 +16332,14 @@
 @item
 For the ``debug link'' method, @value{GDBN} looks up the named file in
 the directory of the executable file, then in a subdirectory of that
-directory named @file{.debug}, and finally under the global debug
-directory, in a subdirectory whose name is identical to the leading
+directory named @file{.debug}, and finally under each one of the global debug
+directories, in a subdirectory whose name is identical to the leading
 directories of the executable's absolute file name.
 
 @item
 For the ``build ID'' method, @value{GDBN} looks in the
-@file{.build-id} subdirectory of the global debug directory for a file
-named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
+@file{.build-id} subdirectory of each one of the global debug directories for
+a file named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
 are the rest of the bit string.  (Real build ID strings are 32 or more
 hex characters, not 10.)
@@ -16348,7 +16348,7 @@
 So, for example, suppose you ask @value{GDBN} to debug
 @file{/usr/bin/ls}, which has a debug link that specifies the
 file @file{ls.debug}, and a build ID whose value in hex is
-@code{abcdef1234}.  If the global debug directory is
+@code{abcdef1234}.  If the list of the global debug directories includes
 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
 debug information files, in the indicated order:
 
@@ -16363,8 +16363,8 @@
 @file{/usr/lib/debug/usr/bin/ls.debug}.
 @end itemize
 
-You can set the global debugging info directory's name, and view the
-name @value{GDBN} is currently using.
+You can set the global debugging info directories, and view the
+list @value{GDBN} is currently using.
 
 @table @code