[PATCH] Make cygwin use .gdbinit

[PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

I've changed the default initialization file for cygwin to '.gdbinit',
issuing a warning if the old style initialization filename was found.

Since this changes documented behavior, I also modified the documentation
as an obvious fix.

FYI,
cgf

ChangeLog:
2001-11-24  Christopher Faylor  <cgf@redhat.com>

	* win32-nat.c (_initialize_check_for_gdb_ini): New function.

doc/ChangeLog:
2001-11-24  Christopher Faylor  <cgf@redhat.com>

	* gdb.texinfo (File Options): Change description of -nx and gdb.ini to
	specifically refer to MS-DOS.
	(command files): Mention gdb.ini is only used on MS-DOS.

Index: win32-nat.c
===================================================================
RCS file: /cvs/uberbaum/gdb/win32-nat.c,v
retrieving revision 1.36
diff -u -p -r1.36 win32-nat.c
--- win32-nat.c	2001/11/01 16:17:08	1.36
+++ win32-nat.c	2001/11/24 18:17:38
@@ -32,6 +32,7 @@
 #include "command.h"
 #include "completer.h"
 #include "regcache.h"
+#include "top.h"
 #include <signal.h>
 #include <sys/types.h>
 #include <fcntl.h>
@@ -1752,4 +1753,32 @@ void
 _initialize_core_win32 (void)
 {
   add_core_fns (&win32_elf_core_fns);
+}
+
+void
+_initialize_check_for_gdb_ini (void)
+{
+  char *homedir;
+  if (inhibit_gdbinit)
+    return;
+
+  homedir = getenv ("HOME");
+  if (homedir)
+    {
+      char *p;
+      char *oldini = (char *) alloca (strlen (homedir) +
+				      sizeof ("/gdb.ini"));
+      strcpy (oldini, homedir);
+      p = strchr (oldini, '\0');
+      if (p > oldini && p[-1] != '/')
+	*p++ = '/';
+      strcpy (p, "gdb.ini");
+      if (access (oldini, 0) == 0)
+	{
+	  int len = strlen (oldini);
+	  char *newini = alloca (len + 1);
+	  sprintf (newini, "%.*s.gdbinit", len - (sizeof ("gdb.ini") - 1), oldini);
+	  warning ("obsolete '%s' found. Rename to '%s'.", oldini, newini);
+	}
+    }
 }
Index: config/i386/xm-cygwin.h
===================================================================
RCS file: /cvs/uberbaum/gdb/config/i386/xm-cygwin.h,v
retrieving revision 1.4
diff -u -p -r1.4 xm-cygwin.h
--- xm-cygwin.h	2001/08/27 22:39:56	1.4
+++ xm-cygwin.h	2001/11/24 18:17:38
@@ -22,15 +22,5 @@
 
 #include "fopen-bin.h"
 
-#define GDBINIT_FILENAME "gdb.ini"
-
 /* Define this if source files use \r\n rather than just \n.  */
 #define CRLF_SOURCE_FILES
-
-/* If under Cygwin, provide backwards compatibility with older
-   Cygwin compilers that don't define the current cpp define. */
-#ifdef __CYGWIN32__
-#ifndef __CYGWIN__
-#define __CYGWIN__
-#endif
-#endif 
Index: doc/gdb.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/gdb.texinfo,v
retrieving revision 1.55
diff -u -p -r1.55 gdb.texinfo
--- gdb.texinfo	2001/11/22 00:21:45	1.55
+++ gdb.texinfo	2001/11/24 18:17:49
@@ -913,7 +913,7 @@ batch mode or quiet mode.
 @cindex @code{--nx}
 @cindex @code{-n}
 Do not execute commands found in any initialization files (normally
-called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
+called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
 @value{GDBN} executes the commands in these files after all the command
 options and arguments have been processed.  @xref{Command Files,,Command
 files}.
@@ -13067,8 +13067,9 @@ the last command, as it would from the t
 @cindex @file{.gdbinit}
 @cindex @file{gdb.ini}
 When you start @value{GDBN}, it automatically executes commands from its
-@dfn{init files}.  These are files named @file{.gdbinit} on Unix and
-@file{gdb.ini} on DOS/Windows.  During startup, @value{GDBN} does the
+@dfn{init files}.  These files are normally named @file{.gdbinit} although
+filename limitations require that they be named @file{gdb.ini} on MS-DOS.
+During startup, @value{GDBN} does the
 following:
 
 @enumerate

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Sat, 24 Nov 2001 13:23:17 -0500
> From: Christopher Faylor <cgf@redhat.com>
> 
> @@ -13067,8 +13067,9 @@ the last command, as it would from the t
>  @cindex @file{.gdbinit}
>  @cindex @file{gdb.ini}
>  When you start @value{GDBN}, it automatically executes commands from its
> -@dfn{init files}.  These are files named @file{.gdbinit} on Unix and
> -@file{gdb.ini} on DOS/Windows.  During startup, @value{GDBN} does the
> +@dfn{init files}.  These files are normally named @file{.gdbinit} although
> +filename limitations require that they be named @file{gdb.ini} on MS-DOS.

Sigh.  Unfortunately, this wording is inaccurate and might be
misleading: it gives an impression that gdb.ini is only used on
MS-DOS.  This is not true, since the DJGPP port works on Windows as
well, but still uses gdb.ini there.

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Sun, Nov 25, 2001 at 11:01:00AM +0200, Eli Zaretskii wrote:
>> Date: Sat, 24 Nov 2001 13:23:17 -0500
>> From: Christopher Faylor <cgf@redhat.com>
>> 
>> @@ -13067,8 +13067,9 @@ the last command, as it would from the t
>>  @cindex @file{.gdbinit}
>>  @cindex @file{gdb.ini}
>>  When you start @value{GDBN}, it automatically executes commands from its
>> -@dfn{init files}.  These are files named @file{.gdbinit} on Unix and
>> -@file{gdb.ini} on DOS/Windows.  During startup, @value{GDBN} does the
>> +@dfn{init files}.  These files are normally named @file{.gdbinit} although
>> +filename limitations require that they be named @file{gdb.ini} on MS-DOS.
>
>Sigh.  Unfortunately, this wording is inaccurate and might be
>misleading: it gives an impression that gdb.ini is only used on
>MS-DOS.  This is not true, since the DJGPP port works on Windows as
>well, but still uses gdb.ini there.

From www.delorie.com/djgpp:

"DJGPP is a complete 32-bit C/C++ development system for Intel 80386
(and higher) PCs running DOS."

I guess this documentation is about as misleading as the first sentence
of this web page.

cgf

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Sun, 25 Nov 2001 13:58:07 -0500
> From: Christopher Faylor <cgf@redhat.com>
> >
> >Sigh.  Unfortunately, this wording is inaccurate and might be
> >misleading: it gives an impression that gdb.ini is only used on
> >MS-DOS.  This is not true, since the DJGPP port works on Windows as
> >well, but still uses gdb.ini there.
> 
> >From www.delorie.com/djgpp:
> 
> "DJGPP is a complete 32-bit C/C++ development system for Intel 80386
> (and higher) PCs running DOS."
> 
> I guess this documentation is about as misleading as the first sentence
> of this web page.

Perhaps.  However, DJ's Web page is not something I need to approve ;-)

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Sun, Nov 25, 2001 at 09:14:00PM +0200, Eli Zaretskii wrote:
>> Date: Sun, 25 Nov 2001 13:58:07 -0500
>> From: Christopher Faylor <cgf@redhat.com>
>> >
>> >Sigh.  Unfortunately, this wording is inaccurate and might be
>> >misleading: it gives an impression that gdb.ini is only used on
>> >MS-DOS.  This is not true, since the DJGPP port works on Windows as
>> >well, but still uses gdb.ini there.
>> 
>> >From www.delorie.com/djgpp:
>> 
>> "DJGPP is a complete 32-bit C/C++ development system for Intel 80386
>> (and higher) PCs running DOS."
>> 
>> I guess this documentation is about as misleading as the first sentence
>> of this web page.
>
>Perhaps.  However, DJ's Web page is not something I need to approve ;-)

Ok.  You're obviously critical of the wording changes and I apologize
for assuming that this was an obvious fix.  I will note that while DJGPP
is mentioned in the documentation as "development tools to MS-DOS and
MS-Windows".  This sentence is followed by "djgpp programs are 32-bit
protected-mode programs that use the DPMI (DOS Protected-Mode Interface)
API to run on top of real-mode DOS systems and their emulations."

There's a lot of "DOS" in the above.  And there's a lot of "DOS" in the
subsequent paragraphs.

However, neither your sighing nor my nit picking is going to improve
the documentation to what you would consider acceptable.  What are your
suggestions for how I can improve the documentation?  Do you just want
me to revert it?  Do you want me to change the MS-DOS's to DJGPP's?
Should I keep the existing documentation and just say Unix/Cygwin?

cgf

Re: [PATCH] Make cygwin use .gdbinit

[DJ Delorie]

I suggest something like:

  These files are normally named @file{.gdbinit} although filesystem
  limitations require that they be named @file{gdb.ini} on some
  platforms, such as DJGPP.

Although DJGPP also could look for .gdbinit first, then gdb.ini.  It
will work on LFN-enabled systems.  But the complaint about gdb.ini
would have to be silenced for DJGPP.

Also, there's no reason not to look for first .gdbinit and then
gdb.ini on *all* platforms, and warn the user only if *both* are
found.

PS: While DJGPP is indeed dos-based, most people don't realize it uses
the DOS simulator within Windows.  So a technically true statement can
still be misleading.  In the long war against MS trying to kill DOS,
we run into this kind of problem all the time.

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Sun, 25 Nov 2001 23:04:26 -0500
> From: DJ Delorie <dj@redhat.com>
> 
> I suggest something like:
> 
>   These files are normally named @file{.gdbinit} although filesystem
>   limitations require that they be named @file{gdb.ini} on some
>   platforms, such as DJGPP.

My suggestion is similar:

  When you start @value{GDBN}, it automatically executes commands from its
  @dfn{init files}, normally called @file{.gdbinit}@footnote{The DJGPP
  port of @value{GDBN} uses the name @file{gdb.ini} instead, due to the
  limitations of file names imposed by DOS filesystems.}.

This banishes the difference into a footnote, where it is less
prominent, and also avoids the pitfall of saying that gdb.ini is only
used on DOS.

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Mon, Nov 26, 2001 at 09:55:17AM +0200, Eli Zaretskii wrote:
>> Date: Sun, 25 Nov 2001 23:04:26 -0500
>> From: DJ Delorie <dj@redhat.com>
>> 
>> I suggest something like:
>> 
>>   These files are normally named @file{.gdbinit} although filesystem
>>   limitations require that they be named @file{gdb.ini} on some
>>   platforms, such as DJGPP.
>
>My suggestion is similar:
>
>  When you start @value{GDBN}, it automatically executes commands from its
>  @dfn{init files}, normally called @file{.gdbinit}@footnote{The DJGPP
>  port of @value{GDBN} uses the name @file{gdb.ini} instead, due to the
>  limitations of file names imposed by DOS filesystems.}.
>
>This banishes the difference into a footnote, where it is less
>prominent, and also avoids the pitfall of saying that gdb.ini is only
>used on DOS.

That looks right to me.  How about the other section of the patch, though:

 @cindex @code{--nx}
 @cindex @code{-n}
 Do not execute commands found in any initialization files (normally
-called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
+called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
 @value{GDBN} executes the commands in these files after all the command
 options and arguments have been processed.  @xref{Command Files,,Command
 files}.

How about just removing the parenthetical expression entirely?  It was
never right to begin with.  What's a "PC"?  Isn't my linux system running
on a PC?

Since the next sentence references the section which discusses initialization
files can we just delete this entirely?

cgf

Re: [PATCH] Make cygwin use .gdbinit

[DJ Delorie]

> Since the next sentence references the section which discusses
> initialization files can we just delete this entirely?

Sounds good to me.

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Mon, 26 Nov 2001 13:32:28 -0500
> From: Christopher Faylor <cgf@redhat.com>
> 
>  @cindex @code{--nx}
>  @cindex @code{-n}
>  Do not execute commands found in any initialization files (normally
> -called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
> +called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
>  @value{GDBN} executes the commands in these files after all the command
>  options and arguments have been processed.  @xref{Command Files,,Command
>  files}.
> 
> How about just removing the parenthetical expression entirely?

Yes, I agree.

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Mon, Nov 26, 2001 at 09:22:16PM +0200, Eli Zaretskii wrote:
>> Date: Mon, 26 Nov 2001 13:32:28 -0500
>> From: Christopher Faylor <cgf@redhat.com>
>> 
>>  @cindex @code{--nx}
>>  @cindex @code{-n}
>>  Do not execute commands found in any initialization files (normally
>> -called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
>> +called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
>>  @value{GDBN} executes the commands in these files after all the command
>>  options and arguments have been processed.  @xref{Command Files,,Command
>>  files}.
>> 
>> How about just removing the parenthetical expression entirely?
>
>Yes, I agree.

Ok.  I've checked in that change with the below ChangeLog.

cgf

2001-07-26  Christopher Faylor  <cgf@redhat.com>

	* gdb.texinfo (Options): Eliminate attempt to explain .gdbinit/gdb.ini
	use since it is described in the referenced section.

	From Eli Zaretskii <eliz@is.elta.co.il>
	* gdb.texinfo (Command Files): Reword to make gdb.ini requirement
	clearer when using DJGPP.

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Sun, 25 Nov 2001 13:58:07 -0500
> From: Christopher Faylor <cgf@redhat.com>
> >
> >Sigh.  Unfortunately, this wording is inaccurate and might be
> >misleading: it gives an impression that gdb.ini is only used on
> >MS-DOS.  This is not true, since the DJGPP port works on Windows as
> >well, but still uses gdb.ini there.
> 
> >From www.delorie.com/djgpp:
> 
> "DJGPP is a complete 32-bit C/C++ development system for Intel 80386
> (and higher) PCs running DOS."
> 
> I guess this documentation is about as misleading as the first sentence
> of this web page.

Perhaps.  However, DJ's Web page is not something I need to approve ;-)

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Sun, Nov 25, 2001 at 09:14:00PM +0200, Eli Zaretskii wrote:
>> Date: Sun, 25 Nov 2001 13:58:07 -0500
>> From: Christopher Faylor <cgf@redhat.com>
>> >
>> >Sigh.  Unfortunately, this wording is inaccurate and might be
>> >misleading: it gives an impression that gdb.ini is only used on
>> >MS-DOS.  This is not true, since the DJGPP port works on Windows as
>> >well, but still uses gdb.ini there.
>> 
>> >From www.delorie.com/djgpp:
>> 
>> "DJGPP is a complete 32-bit C/C++ development system for Intel 80386
>> (and higher) PCs running DOS."
>> 
>> I guess this documentation is about as misleading as the first sentence
>> of this web page.
>
>Perhaps.  However, DJ's Web page is not something I need to approve ;-)

Ok.  You're obviously critical of the wording changes and I apologize
for assuming that this was an obvious fix.  I will note that while DJGPP
is mentioned in the documentation as "development tools to MS-DOS and
MS-Windows".  This sentence is followed by "djgpp programs are 32-bit
protected-mode programs that use the DPMI (DOS Protected-Mode Interface)
API to run on top of real-mode DOS systems and their emulations."

There's a lot of "DOS" in the above.  And there's a lot of "DOS" in the
subsequent paragraphs.

However, neither your sighing nor my nit picking is going to improve
the documentation to what you would consider acceptable.  What are your
suggestions for how I can improve the documentation?  Do you just want
me to revert it?  Do you want me to change the MS-DOS's to DJGPP's?
Should I keep the existing documentation and just say Unix/Cygwin?

cgf

Re: [PATCH] Make cygwin use .gdbinit

[DJ Delorie]

I suggest something like:

  These files are normally named @file{.gdbinit} although filesystem
  limitations require that they be named @file{gdb.ini} on some
  platforms, such as DJGPP.

Although DJGPP also could look for .gdbinit first, then gdb.ini.  It
will work on LFN-enabled systems.  But the complaint about gdb.ini
would have to be silenced for DJGPP.

Also, there's no reason not to look for first .gdbinit and then
gdb.ini on *all* platforms, and warn the user only if *both* are
found.

PS: While DJGPP is indeed dos-based, most people don't realize it uses
the DOS simulator within Windows.  So a technically true statement can
still be misleading.  In the long war against MS trying to kill DOS,
we run into this kind of problem all the time.

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Sun, 25 Nov 2001 23:04:26 -0500
> From: DJ Delorie <dj@redhat.com>
> 
> I suggest something like:
> 
>   These files are normally named @file{.gdbinit} although filesystem
>   limitations require that they be named @file{gdb.ini} on some
>   platforms, such as DJGPP.

My suggestion is similar:

  When you start @value{GDBN}, it automatically executes commands from its
  @dfn{init files}, normally called @file{.gdbinit}@footnote{The DJGPP
  port of @value{GDBN} uses the name @file{gdb.ini} instead, due to the
  limitations of file names imposed by DOS filesystems.}.

This banishes the difference into a footnote, where it is less
prominent, and also avoids the pitfall of saying that gdb.ini is only
used on DOS.

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Mon, Nov 26, 2001 at 09:55:17AM +0200, Eli Zaretskii wrote:
>> Date: Sun, 25 Nov 2001 23:04:26 -0500
>> From: DJ Delorie <dj@redhat.com>
>> 
>> I suggest something like:
>> 
>>   These files are normally named @file{.gdbinit} although filesystem
>>   limitations require that they be named @file{gdb.ini} on some
>>   platforms, such as DJGPP.
>
>My suggestion is similar:
>
>  When you start @value{GDBN}, it automatically executes commands from its
>  @dfn{init files}, normally called @file{.gdbinit}@footnote{The DJGPP
>  port of @value{GDBN} uses the name @file{gdb.ini} instead, due to the
>  limitations of file names imposed by DOS filesystems.}.
>
>This banishes the difference into a footnote, where it is less
>prominent, and also avoids the pitfall of saying that gdb.ini is only
>used on DOS.

That looks right to me.  How about the other section of the patch, though:

 @cindex @code{--nx}
 @cindex @code{-n}
 Do not execute commands found in any initialization files (normally
-called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
+called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
 @value{GDBN} executes the commands in these files after all the command
 options and arguments have been processed.  @xref{Command Files,,Command
 files}.

How about just removing the parenthetical expression entirely?  It was
never right to begin with.  What's a "PC"?  Isn't my linux system running
on a PC?

Since the next sentence references the section which discusses initialization
files can we just delete this entirely?

cgf

Re: [PATCH] Make cygwin use .gdbinit

[DJ Delorie]

> Since the next sentence references the section which discusses
> initialization files can we just delete this entirely?

Sounds good to me.

Re: [PATCH] Make cygwin use .gdbinit

[Eli Zaretskii]

> Date: Mon, 26 Nov 2001 13:32:28 -0500
> From: Christopher Faylor <cgf@redhat.com>
> 
>  @cindex @code{--nx}
>  @cindex @code{-n}
>  Do not execute commands found in any initialization files (normally
> -called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
> +called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
>  @value{GDBN} executes the commands in these files after all the command
>  options and arguments have been processed.  @xref{Command Files,,Command
>  files}.
> 
> How about just removing the parenthetical expression entirely?

Yes, I agree.

Re: [PATCH] Make cygwin use .gdbinit

[Christopher Faylor]

On Mon, Nov 26, 2001 at 09:22:16PM +0200, Eli Zaretskii wrote:
>> Date: Mon, 26 Nov 2001 13:32:28 -0500
>> From: Christopher Faylor <cgf@redhat.com>
>> 
>>  @cindex @code{--nx}
>>  @cindex @code{-n}
>>  Do not execute commands found in any initialization files (normally
>> -called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
>> +called @file{.gdbinit} or @file{gdb.ini} under MS-DOS).  Normally,
>>  @value{GDBN} executes the commands in these files after all the command
>>  options and arguments have been processed.  @xref{Command Files,,Command
>>  files}.
>> 
>> How about just removing the parenthetical expression entirely?
>
>Yes, I agree.

Ok.  I've checked in that change with the below ChangeLog.

cgf

2001-07-26  Christopher Faylor  <cgf@redhat.com>

	* gdb.texinfo (Options): Eliminate attempt to explain .gdbinit/gdb.ini
	use since it is described in the referenced section.

	From Eli Zaretskii <eliz@is.elta.co.il>
	* gdb.texinfo (Command Files): Reword to make gdb.ini requirement
	clearer when using DJGPP.