[binutils-gdb] Note that the linker's --compress-debug-sections option overrides the compression status of any inpu

[Nick Clifton <nickc at sourceware dot org>]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=9af89fbaecca21b2ca34c142584165066807fb10

commit 9af89fbaecca21b2ca34c142584165066807fb10
Author: Nick Clifton <nickc@redhat.com>
Date:   Mon Nov 7 12:28:16 2016 +0000

    Note that the linker's --compress-debug-sections option overrides the compression status of any input debug sections.
    
    	* ld.texinfo (--compress-debug-sections): Expand documentation of
    	this option.

Diff:
---
 ld/ChangeLog  |  5 +++++
 ld/ld.texinfo | 33 ++++++++++++++++++++++-----------
 2 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/ld/ChangeLog b/ld/ChangeLog
index 0513d2e..ae6d732 100644
--- a/ld/ChangeLog
+++ b/ld/ChangeLog
@@ -1,3 +1,8 @@
+2016-11-07  Nick Clifton  <nickc@redhat.com>
+
+	* ld.texinfo (--compress-debug-sections): Expand documentation of
+	this option.
+
 2016-11-04  Nick Clifton  <nickc@redhat.com>
 
 	* emultempl/elf32.em (search_needed): Remove use of getauxval and
diff --git a/ld/ld.texinfo b/ld/ld.texinfo
index 500fda6..698d366 100644
--- a/ld/ld.texinfo
+++ b/ld/ld.texinfo
@@ -2319,17 +2319,28 @@ hash tables.  The default is @code{sysv}.
 @itemx --compress-debug-sections=zlib
 @itemx --compress-debug-sections=zlib-gnu
 @itemx --compress-debug-sections=zlib-gabi
-On ELF platforms , these options control how DWARF debug sections are
-compressed using zlib.  @option{--compress-debug-sections=none} doesn't
-compress DWARF debug sections.
-@option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
-sections and rename debug section names to begin with @samp{.zdebug}
-instead of @samp{.debug}.  @option{--compress-debug-sections=zlib}
-and @option{--compress-debug-sections=zlib-gabi}
-compress DWARF debug sections with SHF_COMPRESSED from the ELF ABI.
-The default behaviour varies depending upon the target involved and
-the configure options used to build the toolchain.  The default can be
-determined by examing the output from the linker's @option{--help} option.
+On ELF platforms, these options control how DWARF debug sections are
+compressed using zlib.
+
+@option{--compress-debug-sections=none} doesn't compress DWARF debug
+sections.  @option{--compress-debug-sections=zlib-gnu} compresses
+DWARF debug sections and renames them to begin with @samp{.zdebug}
+instead of @samp{.debug}.  @option{--compress-debug-sections=zlib-gabi}
+also compresses DWARF debug sections, but rather than renaming them it
+sets the SHF_COMPRESSED flag in the sections' headers.
+
+The @option{--compress-debug-sections=zlib} option is an alias for
+@option{--compress-debug-sections=zlib-gabi}.
+
+Note that this option overrides any compression in input debug
+sections, so if a binary is linked with @option{--compress-debug-sections=none}
+for example, then any compressed debug sections in input files will be
+uncompressed before they are copied into the output binary.
+
+The default compression behaviour varies depending upon the target
+involved and the configure options used to build the toolchain.  The
+default can be determined by examining the output from the linker's
+@option{--help} option.
 
 @kindex --reduce-memory-overheads
 @item --reduce-memory-overheads