[llvm] r372107 - [docs] Make --version text more correct

James Henderson via llvm-commits llvm-commits at lists.llvm.org
Tue Sep 17 04:43:43 PDT 2019


Author: jhenderson
Date: Tue Sep 17 04:43:42 2019
New Revision: 372107

URL: http://llvm.org/viewvc/llvm-project?rev=372107&view=rev
Log:
[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

Modified:
    llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst
    llvm/trunk/docs/CommandGuide/llvm-nm.rst
    llvm/trunk/docs/CommandGuide/llvm-objcopy.rst
    llvm/trunk/docs/CommandGuide/llvm-objdump.rst
    llvm/trunk/docs/CommandGuide/llvm-readelf.rst
    llvm/trunk/docs/CommandGuide/llvm-readobj.rst
    llvm/trunk/docs/CommandGuide/llvm-strip.rst

Modified: llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst Tue Sep 17 04:43:42 2019
@@ -63,7 +63,7 @@ OPTIONS
 
 .. option:: --version
 
-  Display the version of this program.
+  Display the version of the :program:`llvm-cxxfilt` executable.
 
 .. option:: @<FILE>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-nm.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-nm.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-nm.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-nm.rst Tue Sep 17 04:43:42 2019
@@ -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
 

Modified: llvm/trunk/docs/CommandGuide/llvm-objcopy.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-objcopy.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-objcopy.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-objcopy.rst Tue Sep 17 04:43:42 2019
@@ -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:: @<FILE>
 
-  Read command-line options and commands from response file `<FILE>`.
+ Read command-line options and commands from response file `<FILE>`.
 
 COFF-SPECIFIC OPTIONS
 ---------------------

Modified: llvm/trunk/docs/CommandGuide/llvm-objdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-objdump.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-objdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-objdump.rst Tue Sep 17 04:43:42 2019
@@ -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
 

Modified: llvm/trunk/docs/CommandGuide/llvm-readelf.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readelf.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readelf.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-readelf.rst Tue Sep 17 04:43:42 2019
@@ -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
 

Modified: llvm/trunk/docs/CommandGuide/llvm-readobj.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readobj.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readobj.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-readobj.rst Tue Sep 17 04:43:42 2019
@@ -133,7 +133,7 @@ file formats.
 
 .. option:: --version
 
- Display the version of this program.
+ Display the version of the :program:`llvm-readobj` executable.
 
 .. option:: @<FILE>
 

Modified: llvm/trunk/docs/CommandGuide/llvm-strip.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-strip.rst?rev=372107&r1=372106&r2=372107&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-strip.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-strip.rst Tue Sep 17 04:43:42 2019
@@ -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:: @<FILE>
 
-  Read command-line options and commands from response file `<FILE>`.
+ Read command-line options and commands from response file `<FILE>`.
 
 COFF-SPECIFIC OPTIONS
 ---------------------




More information about the llvm-commits mailing list