From: James Henderson Date: Fri, 5 Jul 2019 16:38:52 +0000 (+0000) Subject: [docs][llvm-readobj] Add a note to options that do nothing in GNU output X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4ac06bbc6bc4fa900a816eb32749af385c0b2e08;p=llvm [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 3ae4139ce11..7a66bea6918 100644 --- 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 bb0827927c1..4999b224e5c 100644 --- 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