From 778a5e57349e78b0fb7dbacd131d92b98ad0e92e Mon Sep 17 00:00:00 2001 From: James Henderson Date: Tue, 17 Sep 2019 11:43:42 +0000 Subject: [PATCH] [docs] Make --version text more correct Follow-up to r371983. Referring to "this program" in the description of the --version option in the documentation isn't exactly correct, because the docs are not part of the program, and so "this program" doesn't really refer to anything. This patch brings the other users of this terminology into line with the new updates to llvm-size and llvm-strings. Reviewed by: alexshap, MaskRay Differential Revision: https://reviews.llvm.org/D67618 llvm-svn: 372107 --- llvm/docs/CommandGuide/llvm-cxxfilt.rst | 2 +- llvm/docs/CommandGuide/llvm-nm.rst | 3 ++- llvm/docs/CommandGuide/llvm-objcopy.rst | 4 ++-- llvm/docs/CommandGuide/llvm-objdump.rst | 3 ++- llvm/docs/CommandGuide/llvm-readelf.rst | 2 +- llvm/docs/CommandGuide/llvm-readobj.rst | 2 +- llvm/docs/CommandGuide/llvm-strip.rst | 4 ++-- 7 files changed, 11 insertions(+), 9 deletions(-) diff --git a/llvm/docs/CommandGuide/llvm-cxxfilt.rst b/llvm/docs/CommandGuide/llvm-cxxfilt.rst index 1b6f9c6..5d257b9 100644 --- a/llvm/docs/CommandGuide/llvm-cxxfilt.rst +++ b/llvm/docs/CommandGuide/llvm-cxxfilt.rst @@ -63,7 +63,7 @@ OPTIONS .. option:: --version - Display the version of this program. + Display the version of the :program:`llvm-cxxfilt` executable. .. option:: @ diff --git a/llvm/docs/CommandGuide/llvm-nm.rst b/llvm/docs/CommandGuide/llvm-nm.rst index 1efa15e..71efac7 100644 --- a/llvm/docs/CommandGuide/llvm-nm.rst +++ b/llvm/docs/CommandGuide/llvm-nm.rst @@ -227,7 +227,8 @@ OPTIONS .. option:: --version - Display the version of this program. Does not stack with other commands. + Display the version of the :program:`llvm-nm` executable. Does not stack with + other commands. .. option:: --without-aliases diff --git a/llvm/docs/CommandGuide/llvm-objcopy.rst b/llvm/docs/CommandGuide/llvm-objcopy.rst index f392680..df51f2ec 100644 --- a/llvm/docs/CommandGuide/llvm-objcopy.rst +++ b/llvm/docs/CommandGuide/llvm-objcopy.rst @@ -131,11 +131,11 @@ multiple file formats. .. option:: --version, -V - Display the version of this program. + Display the version of the :program:`llvm-objcopy` executable. .. option:: @ - Read command-line options and commands from response file ``. + Read command-line options and commands from response file ``. COFF-SPECIFIC OPTIONS --------------------- diff --git a/llvm/docs/CommandGuide/llvm-objdump.rst b/llvm/docs/CommandGuide/llvm-objdump.rst index d65e490..1b8273b 100644 --- a/llvm/docs/CommandGuide/llvm-objdump.rst +++ b/llvm/docs/CommandGuide/llvm-objdump.rst @@ -91,7 +91,8 @@ combined with other commands: .. option:: --version - Display the version of this program. Does not stack with other commands. + Display the version of the :program:`llvm-objdump` executable. Does not stack + with other commands. .. option:: -x, --all-headers diff --git a/llvm/docs/CommandGuide/llvm-readelf.rst b/llvm/docs/CommandGuide/llvm-readelf.rst index 6aa9047..efb3f6a 100644 --- a/llvm/docs/CommandGuide/llvm-readelf.rst +++ b/llvm/docs/CommandGuide/llvm-readelf.rst @@ -181,7 +181,7 @@ OPTIONS .. option:: --version - Display the version of this program. + Display the version of the :program:`llvm-readelf` executable. .. option:: --version-info, -V diff --git a/llvm/docs/CommandGuide/llvm-readobj.rst b/llvm/docs/CommandGuide/llvm-readobj.rst index 30f7976..ece7979 100644 --- a/llvm/docs/CommandGuide/llvm-readobj.rst +++ b/llvm/docs/CommandGuide/llvm-readobj.rst @@ -133,7 +133,7 @@ file formats. .. option:: --version - Display the version of this program. + Display the version of the :program:`llvm-readobj` executable. .. option:: @ diff --git a/llvm/docs/CommandGuide/llvm-strip.rst b/llvm/docs/CommandGuide/llvm-strip.rst index 546a0a2..779c67c 100644 --- a/llvm/docs/CommandGuide/llvm-strip.rst +++ b/llvm/docs/CommandGuide/llvm-strip.rst @@ -102,11 +102,11 @@ multiple file formats. .. option:: --version, -V - Display the version of this program. + Display the version of the :program:`llvm-strip` executable. .. option:: @ - Read command-line options and commands from response file ``. + Read command-line options and commands from response file ``. COFF-SPECIFIC OPTIONS --------------------- -- 2.7.4