[llvm] r365221 - [docs][llvm-readobj] Add a note to options that do nothing in GNU output

[James Henderson via llvm-commits]

Author: jhenderson
Date: Fri Jul  5 09:38:52 2019
New Revision: 365221

URL: http://llvm.org/viewvc/llvm-project?rev=365221&view=rev
Log:
[docs][llvm-readobj] Add a note to options that do nothing in GNU output

--section-data, --section-relocations and --section-symbols have no
effect for GNU style ouput. This patch changes the docs to point this
out, as it has caught me out on a couple of occasions.

See also https://bugs.llvm.org/show_bug.cgi?id=42522.

Modified:
    llvm/trunk/docs/CommandGuide/llvm-readelf.rst
    llvm/trunk/docs/CommandGuide/llvm-readobj.rst

Modified: llvm/trunk/docs/CommandGuide/llvm-readelf.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readelf.rst?rev=365221&r1=365220&r2=365221&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readelf.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-readelf.rst Fri Jul  5 09:38:52 2019
@@ -139,7 +139,8 @@ OPTIONS
 
 .. option:: --section-data
 
- When used with :option:`--sections`, display section data for each section shown.
+ When used with :option:`--sections`, display section data for each section
+ shown. This option has no effect for GNU style output.
 
 .. option:: --section-mapping
 
@@ -147,11 +148,13 @@ OPTIONS
 
 .. option:: --section-relocations
 
- When used with :option:`--sections`, display relocations for each section shown.
+ When used with :option:`--sections`, display relocations for each section
+ shown. This option has no effect for GNU style output.
 
 .. option:: --section-symbols
 
  When used with :option:`--sections`, display symbols for each section shown.
+ This option has no effect for GNU style output.
 
 .. option:: --stackmap
 

Modified: llvm/trunk/docs/CommandGuide/llvm-readobj.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readobj.rst?rev=365221&r1=365220&r2=365221&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readobj.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-readobj.rst Fri Jul  5 09:38:52 2019
@@ -101,15 +101,18 @@ file formats.
 
 .. option:: --section-data, --sd
 
- When used with :option:`--sections`, display section data for each section shown.
+ When used with :option:`--sections`, display section data for each section
+ shown. This option has no effect for GNU style output.
 
 .. option:: --section-relocations, --sr
 
- When used with :option:`--sections`, display relocations for each section shown.
+ When used with :option:`--sections`, display relocations for each section
+ shown. This option has no effect for GNU style output.
 
 .. option:: --section-symbols, --st
 
  When used with :option:`--sections`, display symbols for each section shown.
+ This option has no effect for GNU style output.
 
 .. option:: --stackmap