[RFA/doco] document gdb.init check only performed in home directory

[RFA/doco] document gdb.init check only performed in home directory

[Joel Brobecker]

Hello,

One of my coworkers working on Windows pointed out that GDB wasn't
warning him if a gdb.ini file existed in the current directory.
The documentation is a little ambiguous and might be suggesting that
GDB checks all locations where a gdbinit might be located for gdb.ini
files.

As far as I can tell, the use of gdb.ini for Windows was discontinued
around the end of 2001. I really don't see the point of adding even
more code to try to warn users about a file that we haven't used in
over 10 years. For now, I suggest the attached patch, which just
clarifies the current situation regarding this warning.

gdb/doc/ChangeLog:

        * gdb.texinfo (Startup): Clarify scope of gdb.ini warning for
        Windows ports.

Tested on x86_64-linux. OK to apply?

Thanks,
-- 
Joel

---
 gdb/doc/gdb.texinfo |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index c2c7745..19c329b 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -1367,8 +1367,8 @@ The @value{GDBN} init files are normally called @file{.gdbinit}.
 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
 the limitations of file names imposed by DOS filesystems.  The Windows
 ports of @value{GDBN} use the standard name, but if they find a
-@file{gdb.ini} file, they warn you about that and suggest to rename
-the file to the standard name.
+@file{gdb.ini} file in your home directory, they warn you about that
+and suggest to rename the file to the standard name.
 
 
 @node Quitting GDB
-- 
1.7.9.5

Re: [RFA/doco] document gdb.init check only performed in home directory

[Eli Zaretskii]

> From: Joel Brobecker <brobecker@adacore.com>
> Cc: Joel Brobecker <brobecker@adacore.com>
> Date: Thu,  8 Nov 2012 13:56:07 -0800
> 
> gdb/doc/ChangeLog:
> 
>         * gdb.texinfo (Startup): Clarify scope of gdb.ini warning for
>         Windows ports.
> 
> Tested on x86_64-linux. OK to apply?

Yes, thanks.  However, I would suggest to lose the plural form, and
just use "The Windows port" in singular.  A GDB user who uses GDB on
Windows only cares about that one port she is using.

Re: [RFA/doco] document gdb.init check only performed in home directory

[Joel Brobecker]

[-- Attachment #1: Type: text/plain, Size: 500 bytes --]

> > gdb/doc/ChangeLog:
> > 
> >         * gdb.texinfo (Startup): Clarify scope of gdb.ini warning for
> >         Windows ports.
> > 
> > Tested on x86_64-linux. OK to apply?
> 
> Yes, thanks.  However, I would suggest to lose the plural form, and
> just use "The Windows port" in singular.  A GDB user who uses GDB on
> Windows only cares about that one port she is using.

Thanks! Attached is the patch I checked in, after incorporating
your suggestion. I agree it sounds more natural...

-- 
Joel

[-- Attachment #2: 0001-document-gdb.init-check-only-performed-in-home-direc.patch --]
[-- Type: text/x-diff, Size: 1850 bytes --]

From 170c663a6dfec88c11055afa4e605f68e69cd20c Mon Sep 17 00:00:00 2001
From: Joel Brobecker <brobecker@adacore.com>
Date: Thu, 8 Nov 2012 13:47:45 -0800
Subject: [PATCH] document gdb.init check only performed in home directory

The documentation is a little ambiguous and might be suggesting that
GDB checks all locations where a gdbinit might be located for gdb.ini
files.  This clarifies the current situation.

gdb/doc/ChangeLog:

        * gdb.texinfo (Startup): Minor rewording, and clarify scope of
        gdb.ini warning for Windows port.
---
 gdb/doc/ChangeLog   |    5 +++++
 gdb/doc/gdb.texinfo |    6 +++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index fd776bf..7e83709 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2012-11-08  Joel Brobecker  <brobecker@adacore.com>
+
+	* gdb.texinfo (Startup): Minor rewording, and clarify scope of
+	gdb.ini warning for Windows port.
+
 2012-11-08  Yao Qi  <yao@codesourcery.com>
 
 	* gdb.texinfo (Search): Add kindex for 'fo'.
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index c7777e6..7382352 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -1366,9 +1366,9 @@ can use @kbd{gdb --help}.
 The @value{GDBN} init files are normally called @file{.gdbinit}.
 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
 the limitations of file names imposed by DOS filesystems.  The Windows
-ports of @value{GDBN} use the standard name, but if they find a
-@file{gdb.ini} file, they warn you about that and suggest to rename
-the file to the standard name.
+port of @value{GDBN} uses the standard name, but if it finds a
+@file{gdb.ini} file in your home directory, it warns you about that
+and suggests to rename the file to the standard name.
 
 
 @node Quitting GDB
-- 
1.7.9.5

Re: [RFA/doco] document gdb.init check only performed in home directory

[Eli Zaretskii]

> Date: Thu, 8 Nov 2012 14:27:39 -0800
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb-patches@sourceware.org
> 
> > > gdb/doc/ChangeLog:
> > > 
> > >         * gdb.texinfo (Startup): Clarify scope of gdb.ini warning for
> > >         Windows ports.
> > > 
> > > Tested on x86_64-linux. OK to apply?
> > 
> > Yes, thanks.  However, I would suggest to lose the plural form, and
> > just use "The Windows port" in singular.  A GDB user who uses GDB on
> > Windows only cares about that one port she is using.
> 
> Thanks! Attached is the patch I checked in, after incorporating
> your suggestion. I agree it sounds more natural...

Great, this can go in, then.