[commit] [doc patch] auto-load: Make more set auto-load safe-path references [Re: [patch#3 5/8] set auto-load safe-path]

Jan Kratochvil
2012-05-11T18:27:20Z

On Wed, 09 May 2012 21:58:22 +0200, Joel Brobecker wrote:
> I just find it more logical to have it at the beginning, rather than
> the end. The way I see it, "set auto-load safe-path" is the first
> barrier involved in determining whether to auto-load a file or not.

While writing it I was pushing various paragraphs to the top but it has
problems that:

* Every paragraph is pretty important.
* The @node has to have some logical structure. While it may look so the
text I produce is not completely random, I try to keep it structured.

Also I believe most of the users should be enough with the warning message
about "auto-load safe-path". Who opens the documentation I believe is OK to
read at least whole that one @node.

> But I'm fine either way. I think your patch is already a good
> improvement as it is.

Checked in.

Thanks,
Jan

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

--- src/gdb/doc/ChangeLog 2012/05/11 18:20:26 1.1313
+++ src/gdb/doc/ChangeLog 2012/05/11 18:23:11 1.1314
@@ -1,5 +1,12 @@
2012-05-11 Jan Kratochvil <jan.kratochvil@redhat.com>

+ * gdb.texinfo (Auto-loading, Init File in the Current Directory)
+ (libthread_db.so.1 file, objfile-gdb.gdb file, objfile-gdb.py file)
+ (dotdebug_gdb_scripts section): Add reference
+ to 'Auto-loading safe path'.
+
+2012-05-11 Jan Kratochvil <jan.kratochvil@redhat.com>
+
Implement multi-component --with-auto-load-dir.
* gdb.texinfo (Auto-loading): New references
for 'set auto-load scripts-directory'
--- src/gdb/doc/gdb.texinfo 2012/05/11 18:20:26 1.959
+++ src/gdb/doc/gdb.texinfo 2012/05/11 18:23:11 1.960
@@ -20973,6 +20973,10 @@
results or introduce security risks (e.g., if the file comes from untrusted
sources).

+Note that loading of these associated files (including the local @file{.gdbinit}
+file) requires accordingly configured @code{auto-load safe-path}
+(@pxref{Auto-loading safe path}).
+
For these reasons, @value{GDBN} includes commands and options to let you
control when to auto-load files and which files should be auto-loaded.

@@ -21112,6 +21116,9 @@
from init file (if any) in the current working directory,
see @ref{Init File in the Current Directory during Startup}.

+Note that loading of this local @file{.gdbinit} file also requires accordingly
+configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
+
@table @code
@anchor{set auto-load local-gdbinit}
@kindex set auto-load local-gdbinit
@@ -21148,6 +21155,9 @@
auto-load libthread-db} is enabled before trying to open such thread debugging
library.

+Note that loading of this debugging library also requires accordingly configured
+@code{auto-load safe-path} (@pxref{Auto-loading safe path}).
+
@table @code
@anchor{set auto-load libthread-db}
@kindex set auto-load libthread-db
@@ -21175,6 +21185,9 @@
canned sequences of commands (@pxref{Sequences}), as long as @samp{set
auto-load gdb-scripts} is set to @samp{on}.

+Note that loading of this script file also requires accordingly configured
+@code{auto-load safe-path} (@pxref{Auto-loading safe path}).
+
For more background refer to the similar Python scripts auto-loading
description (@pxref{objfile-gdb.py file}).

@@ -25465,7 +25478,10 @@
directories mentioned in the value of @code{debug-file-directory}.

Finally, if this file does not exist, then @value{GDBN} will look for
-@var{script-name} file in all of the directories specified by:
+@var{script-name} file in all of the directories as specified below.
+
+Note that loading of this script file also requires accordingly configured
+@code{auto-load safe-path} (@pxref{Auto-loading safe path}).

@table @code
@anchor{set auto-load scripts-directory}
@@ -25542,6 +25558,9 @@

The script name may include directories if desired.

+Note that loading of this script file also requires accordingly configured
+@code{auto-load safe-path} (@pxref{Auto-loading safe path}).
+
If the macro is put in a header, any application or library
using this header will get a reference to the specified script.