[9/9] Document "target:" sysroot changes

Message ID 1426870087-32654-10-git-send-email-gbenson@redhat.com
State Superseded
Headers

Commit Message

Gary Benson March 20, 2015, 4:48 p.m. UTC
  This commit documents the newly added "target:" sysroot feature.

gdb/ChangeLog:

	* NEWS: Announce the new default sysroot of "target:".

gdb/doc/ChangeLog:

	* gdb.texinfo (set sysroot): Document "target:".
---
 gdb/ChangeLog       |    4 ++++
 gdb/NEWS            |    5 +++++
 gdb/doc/ChangeLog   |    4 ++++
 gdb/doc/gdb.texinfo |   23 ++++++++++++++---------
 4 files changed, 27 insertions(+), 9 deletions(-)
  

Comments

Eli Zaretskii March 20, 2015, 5:51 p.m. UTC | #1
> From: Gary Benson <gbenson@redhat.com>
> Date: Fri, 20 Mar 2015 16:48:07 +0000
> 
> This commit documents the newly added "target:" sysroot feature.

Thanks.

> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -7,6 +7,11 @@
>    present in the debug info.  This typically includes the compiler version
>    and may include things like its command line arguments.
>  
> +* Paths supplied to the "set sysroot" commands may be prefixed with
> +  "target:" to tell GDB to access shared libraries from the target
> +  system, be it local or remote.  This replaces the prefix "remote:".
> +  The default sysroot has been changed from "" to "target:".

The Gnu Coding Standards frown on using "path" for anything but
PATH-style directory lists.  Please use "directory name" instead.

> +root prefix on the remote file system.  If @var{path} starts with the
> +sequence @file{remote:} this will be converted to the sequence
> +@file{target:} by @code{set sysroot}. @footnote{Historically the

The @footnote should be before the period, and without any whitespace
before it.

> +functionality to retrieve binaries from the remote system was
> +provided by prefixing @var{path} with @file{remote:}} @footnote{If you
> +want to specify a local system root using a directory that happens to
> +be named @file{target:} or @file{remote:}, you need to use some
> +equivalent variant of the name like @file{./target:}.}

The second footnote should not be a footnote, as it is an important
part of the description.

Thanks.
  
Pedro Alves April 1, 2015, 12:15 p.m. UTC | #2
On 03/20/2015 04:48 PM, Gary Benson wrote:
> This commit documents the newly added "target:" sysroot feature.
> 
> gdb/ChangeLog:
> 
> 	* NEWS: Announce the new default sysroot of "target:".
> 
> gdb/doc/ChangeLog:
> 
> 	* gdb.texinfo (set sysroot): Document "target:".
> ---
>  gdb/ChangeLog       |    4 ++++
>  gdb/NEWS            |    5 +++++
>  gdb/doc/ChangeLog   |    4 ++++
>  gdb/doc/gdb.texinfo |   23 ++++++++++++++---------
>  4 files changed, 27 insertions(+), 9 deletions(-)
> 
> diff --git a/gdb/NEWS b/gdb/NEWS
> index bda4a35..3d4f98d 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -7,6 +7,11 @@
>    present in the debug info.  This typically includes the compiler version
>    and may include things like its command line arguments.
>  
> +* Paths supplied to the "set sysroot" commands may be prefixed with
> +  "target:" to tell GDB to access shared libraries from the target
> +  system, be it local or remote.  This replaces the prefix "remote:".
> +  The default sysroot has been changed from "" to "target:".

I think you should mention also what happens if you still use "remote:".
Something around '"remote:" is automatically converted to "target:" for
backward compatibility'.

> +If @var{path} starts with the sequence @file{target:} and the target
> +system is remote then @value{GDBN} will retrieve the target binaries
> +from the remote system.  This is only supported when using a remote
> +target that supports the @code{remote get} command (@pxref{File
> +Transfer,,Sending files to a remote system}).  The part of @var{path}
> +following the initial @file{target:} (if present) is used as system
> +root prefix on the remote file system.  If @var{path} starts with the
> +sequence @file{remote:} this will be converted to the sequence

s/this will be converted/this is converted/

> +@file{target:} by @code{set sysroot}. @footnote{Historically the
> +functionality to retrieve binaries from the remote system was
> +provided by prefixing @var{path} with @file{remote:}} @footnote{If you
> +want to specify a local system root using a directory that happens to
> +be named @file{target:} or @file{remote:}, you need to use some
> +equivalent variant of the name like @file{./target:}.}
>  
>  For targets with an MS-DOS based filesystem, such as MS-Windows and
>  SymbianOS, @value{GDBN} tries prefixing a few variants of the target
> 


Thanks,
Pedro Alves
  

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index bda4a35..3d4f98d 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -7,6 +7,11 @@ 
   present in the debug info.  This typically includes the compiler version
   and may include things like its command line arguments.
 
+* Paths supplied to the "set sysroot" commands may be prefixed with
+  "target:" to tell GDB to access shared libraries from the target
+  system, be it local or remote.  This replaces the prefix "remote:".
+  The default sysroot has been changed from "" to "target:".
+
 * Python Scripting
 
   ** gdb.Objfile objects have a new attribute "username",
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 552da31..c5c3724 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -17814,15 +17814,20 @@  libraries, they need to be laid out in the same way that they are on
 the target, with e.g.@: a @file{/lib} and @file{/usr/lib} hierarchy
 under @var{path}.
 
-If @var{path} starts with the sequence @file{remote:}, @value{GDBN} will 
-retrieve the target libraries from the remote system.  This is only
-supported when using a remote target that supports the @code{remote get}
-command (@pxref{File Transfer,,Sending files to a remote system}).
-The part of @var{path} following the initial @file{remote:}
-(if present) is used as system root prefix on the remote file system.
-@footnote{If you want to specify a local system root using a directory
-that happens to be named @file{remote:}, you need to use some equivalent
-variant of the name like @file{./remote:}.}
+If @var{path} starts with the sequence @file{target:} and the target
+system is remote then @value{GDBN} will retrieve the target binaries
+from the remote system.  This is only supported when using a remote
+target that supports the @code{remote get} command (@pxref{File
+Transfer,,Sending files to a remote system}).  The part of @var{path}
+following the initial @file{target:} (if present) is used as system
+root prefix on the remote file system.  If @var{path} starts with the
+sequence @file{remote:} this will be converted to the sequence
+@file{target:} by @code{set sysroot}. @footnote{Historically the
+functionality to retrieve binaries from the remote system was
+provided by prefixing @var{path} with @file{remote:}} @footnote{If you
+want to specify a local system root using a directory that happens to
+be named @file{target:} or @file{remote:}, you need to use some
+equivalent variant of the name like @file{./target:}.}
 
 For targets with an MS-DOS based filesystem, such as MS-Windows and
 SymbianOS, @value{GDBN} tries prefixing a few variants of the target