[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.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@365221 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/CommandGuide/llvm-readelf.rst b/docs/CommandGuide/llvm-readelf.rst
index 3ae4139ce118d48a86da23fffa360b688084147b..7a66bea69186d411b2f9dfacbf5e1d6a1a1fa1a6 100644 (file)
--- a/docs/CommandGuide/llvm-readelf.rst
+++ b/docs/CommandGuide/llvm-readelf.rst
@@ -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
 

diff --git a/docs/CommandGuide/llvm-readobj.rst b/docs/CommandGuide/llvm-readobj.rst
index bb0827927c1c04e8ad2ec3074a4abb4c12ce67ad..4999b224e5cd8c6d5bf28d1be7a1ec946addc3b8 100644 (file)
--- a/docs/CommandGuide/llvm-readobj.rst
+++ b/docs/CommandGuide/llvm-readobj.rst
@@ -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