From 9e38f510b37d5a8e750eec60e123e3a98803b294 Mon Sep 17 00:00:00 2001 From: James Henderson Date: Fri, 5 Jul 2019 16:38:52 +0000 Subject: [PATCH] [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. llvm-svn: 365221 --- llvm/docs/CommandGuide/llvm-readelf.rst | 7 +++++-- llvm/docs/CommandGuide/llvm-readobj.rst | 7 +++++-- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/llvm/docs/CommandGuide/llvm-readelf.rst b/llvm/docs/CommandGuide/llvm-readelf.rst index 3ae4139..7a66bea 100644 --- a/llvm/docs/CommandGuide/llvm-readelf.rst +++ b/llvm/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/llvm/docs/CommandGuide/llvm-readobj.rst b/llvm/docs/CommandGuide/llvm-readobj.rst index bb08279..4999b22 100644 --- a/llvm/docs/CommandGuide/llvm-readobj.rst +++ b/llvm/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 -- 2.7.4