Re: [PATCH, Ada, DOC] PR15479: Fix markup of "GDB" and "gnat1".

[Markus Milleder <markus dot milleder at generali dot at>]

If I may intrude,

Ralf Wildenhues schrieb am 22.07.2008 07:41:01:

> diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi
> index b55f398..22a625a 100644
> --- a/gcc/ada/gnat_ugn.texi
> +++ b/gcc/ada/gnat_ugn.texi
> @@ -3686,7 +3686,7 @@ containing the directory information.
>  @findex gnat1
>  @command{gcc} is actually a driver program that looks at the extensions of
>  the file arguments and loads the appropriate compiler. For example, the
> -GNU C compiler is @file{cc1}, and the Ada compiler is @file{gnat1}.
> +GNU C compiler is @file{cc1}, and the Ada compiler is @command{gnat1}.
>  These programs are in directories known to the driver program (in some
>  configurations via environment variables you set), but need not be in
>  your path. The @command{gcc} driver also calls the assembler and any other
> @@ -3703,7 +3703,7 @@ $ gcc -c x.adb y.adb z.c
>  @end smallexample

shouldn't that be

+GNU C compiler is @command{cc1}, and the Ada compiler is @command{gnat1}.

for consistency ?


Also noticed:
>+GNAT. The latest versions of GDB are Ada-aware and can handle

Latest ? As a question to the Ada people, could you suggest a
minimum version ? Should this say "current versions" by now ?



A few places where I'd decide different from you below.

As a rough guideline, I'd say it's GDB for the concept and
@command{gdb} is about a concrete invocation.


> @@ -22792,7 +22792,7 @@ details about Ada types and variables to be
> encoded into these
>  standard C formats. Details of this encoding scheme may be found in
>  the file exp_dbug.ads in the GNAT source distribution. However, the
>  details of this encoding are, in general, of no interest to a user,
> -since @code{GDB} automatically performs the necessary decoding.
> +since @command{gdb} automatically performs the necessary decoding.
I'd suggest plain GDB in line with plain GNAT above.

> @@ -22898,7 +22898,7 @@ then a breakpoint will occur when any
> exception is raised.
>
>  @item print @var{expression}
>  This will print the value of the given expression. Most simple
> -Ada expression formats are properly handled by @code{GDB}, so the expression
> +Ada expression formats are properly handled by @command{gdb}, so
"GDB" as this is a design. not an implementation detail ? (and in line
with the use in the Ada expressions section)


> @@ -23000,13 +23000,13 @@ call subprogram-name (parameters)
>  @noindent
>  The keyword @code{call} can be omitted in the normal case where the
>  @code{subprogram-name} does not coincide with any of the predefined
> -@code{GDB} commands.
> +@command{gdb} commands.
"GDB commands" as a compound noun, IMO.

> @@ -23088,7 +23088,7 @@ argument, prints out only those exceptions
> whose name matches @var{regexp}.
>  @cindex Tasks
>
>  @noindent
> -@code{GDB} allows the following task-related commands:
> +@command{gdb} allows the following task-related commands:
I feel a slight preference for "GDB" :-)

> @@ -23248,13 +23248,13 @@ for the back end. The system prints the
...
>  would on a C program (but @pxref{The GNAT Debugger GDB} for caveats). The
Does @pxref expant to "see", or should that be "but see @pxref" ?


      Markus Milleder