[doc patch] auto-load safe-path formatting fix

[doc patch] auto-load safe-path formatting fix

[Jan Kratochvil]

Hi Eli,

the first line was not separate from its text, in both .info and in .pdf,
mostly obvious.

I would prefer just '@table' without formatting (not '@table @code') but one
has to put something there.  Most of the items override the formatting anyway.


Thanks,
Jan


gdb/doc/
2012-04-22  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* gdb.texinfo (Auto-loading safe path): Replace @itemize @bullet
	by @table @code.  Fix formatting of one item.

--- ./gdb/doc/gdb.texinfo	18 Apr 2012 07:03:58 -0000	1.945
+++ ./gdb/doc/gdb.texinfo	22 Apr 2012 15:21:35 -0000
@@ -21136,8 +21136,8 @@ init file in the current directory
 To force @value{GDBN} to load the files it declined to load in the previous
 example, you could use one of the following ways:
 
-@itemize @bullet
-@item ~/.gdbinit: add-auto-load-safe-path ~/src/gdb
+@table @code
+@item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
 Specify this trusted directory (or a file) as additional component of the list.
 You have to specify also any existing directories displayed by
 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
@@ -21155,20 +21155,20 @@ from trusted sources.
 During compilation of @value{GDBN} you may disable any auto-loading safety.
 This assumes all the files you will ever debug with this @value{GDBN} come from
 trusted sources.
-@end itemize
+@end table
 
 On the other hand you can also explicitly forbid automatic files loading which
 also suppresses any such warning messages:
 
-@itemize @bullet
+@table @code
 @item @kbd{gdb -iex "set auto-load no" [@dots{}]}
 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
 
-@item @samp{~/.gdbinit}: @samp{set auto-load no}
+@item @file{~/.gdbinit}: @samp{set auto-load no}
 Disable auto-loading globally for the user
 (@pxref{Home Directory Init File}).  While it is improbable, you could also
 use system init file instead (@pxref{System-wide configuration}).
-@end itemize
+@end table
 
 This setting applies to the file names as entered by user.  If no entry matches
 @value{GDBN} tries as a last resort to also resolve all the file names into

Re: [doc patch] auto-load safe-path formatting fix

[Eli Zaretskii]

> Date: Sun, 22 Apr 2012 17:32:50 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> 
> the first line was not separate from its text, in both .info and in .pdf,
> mostly obvious.

Thanks.

> I would prefer just '@table' without formatting (not '@table @code') but one
> has to put something there.

That's what "@asis" is for.

However,...

> -@itemize @bullet
> -@item ~/.gdbinit: add-auto-load-safe-path ~/src/gdb
> +@table @code
> +@item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
>  Specify this trusted directory (or a file) as additional component of the list.

The problem here was that the formatting of the original @item line
was incorrect.  In an itemized list, @item should be on a line by
itself, like this:

  @itemize @bullet
  @item
  In @file{~/.gdbinit}: @code{add-auto-load-safe-path ~/src/gdb}.
  Specify this trusted directory (or a file) as additional component of the list.

Etc.

I don't mind going to @table, if you find that prettier.  But please
do use @asis, and then give each part its correct markup (@file,
@code, @kbd, etc.).

Thanks.

[commit] [doc patch] auto-load safe-path formatting fix

[Jan Kratochvil]

On Sun, 22 Apr 2012 17:41:09 +0200, Eli Zaretskii wrote:
> > I would prefer just '@table' without formatting (not '@table @code') but one
> > has to put something there.
> 
> That's what "@asis" is for.

Sorry I missed that.


> I don't mind going to @table, if you find that prettier.

I guess I originally meant @table.


Checked it in.


Thanks,
Jan


http://sourceware.org/ml/gdb-cvs/2012-04/msg00178.html

--- src/gdb/doc/ChangeLog	2012/04/18 07:03:57	1.1298
+++ src/gdb/doc/ChangeLog	2012/04/22 15:49:21	1.1299
@@ -1,3 +1,8 @@
+2012-04-22  Jan Kratochvil  <jan.kratochvil@redhat.com>
+
+	* gdb.texinfo (Auto-loading safe path): Replace @itemize @bullet
+	by @table @asis.  Fix formatting of one item.
+
 2012-04-18  Jan Kratochvil  <jan.kratochvil@redhat.com>
 
 	* gdb.texinfo (Auto-loading verbose mode): Fix smallexample typo.
--- src/gdb/doc/gdb.texinfo	2012/04/18 07:03:58	1.945
+++ src/gdb/doc/gdb.texinfo	2012/04/22 15:49:21	1.946
@@ -21136,8 +21136,8 @@
 To force @value{GDBN} to load the files it declined to load in the previous
 example, you could use one of the following ways:
 
-@itemize @bullet
-@item ~/.gdbinit: add-auto-load-safe-path ~/src/gdb
+@table @asis
+@item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
 Specify this trusted directory (or a file) as additional component of the list.
 You have to specify also any existing directories displayed by
 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
@@ -21155,20 +21155,20 @@
 During compilation of @value{GDBN} you may disable any auto-loading safety.
 This assumes all the files you will ever debug with this @value{GDBN} come from
 trusted sources.
-@end itemize
+@end table
 
 On the other hand you can also explicitly forbid automatic files loading which
 also suppresses any such warning messages:
 
-@itemize @bullet
+@table @asis
 @item @kbd{gdb -iex "set auto-load no" [@dots{}]}
 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
 
-@item @samp{~/.gdbinit}: @samp{set auto-load no}
+@item @file{~/.gdbinit}: @samp{set auto-load no}
 Disable auto-loading globally for the user
 (@pxref{Home Directory Init File}).  While it is improbable, you could also
 use system init file instead (@pxref{System-wide configuration}).
-@end itemize
+@end table
 
 This setting applies to the file names as entered by user.  If no entry matches
 @value{GDBN} tries as a last resort to also resolve all the file names into