This is an archive of the discontinued LLVM Phabricator instance.

Differential D67618

[docs] Make --version text more correct
ClosedPublic

Authored by jhenderson on Sep 16 2019, 6:50 AM.

Details

Reviewers
MaskRay
alexander-shaposhnikov
Commits
rG778a5e57349e: [docs] Make --version text more correct
rL372107: [docs] Make --version text more correct
Summary

Follow-up to D67555. 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.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Sep 16 2019, 6:50 AM
Herald added a reviewer: alexander-shaposhnikov. · View Herald TranscriptSep 16 2019, 6:50 AM
Herald added a project: Restricted Project. · View Herald Transcript
alexander-shaposhnikov accepted this revision.Sep 16 2019, 3:14 PM
This revision is now accepted and ready to land.Sep 16 2019, 3:14 PM
MaskRay accepted this revision.Sep 17 2019, 3:44 AM
Closed by commit rL372107: [docs] Make --version text more correct (authored by jhenderson). · Explain WhySep 17 2019, 4:44 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
trunk/
docs/
CommandGuide/
2 lines
3 lines
4 lines
3 lines
2 lines
2 lines
4 lines

Diff 220474

llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst

Show First 20 Lines • Show All 57 Lines • ▼ Show 20 Lines.. option:: --strip-underscore, -_
demangling. demangling.
.. option:: --types, -t .. option:: --types, -t
Attempt to demangle names as type names as well as function names. Attempt to demangle names as type names as well as function names.
.. option:: --version .. option:: --version
Display the version of this program. Display the version of the :program:`llvm-cxxfilt` executable.
.. option:: @<FILE> .. option:: @<FILE>
Read command-line options from response file `<FILE>`. Read command-line options from response file `<FILE>`.
EXIT STATUS EXIT STATUS
----------- -----------
:program:`llvm-cxxfilt` returns 0 unless it encounters a usage error, in which :program:`llvm-cxxfilt` returns 0 unless it encounters a usage error, in which
case a non-zero exit code is returned. case a non-zero exit code is returned.
SEE ALSO SEE ALSO
-------- --------
:manpage:`llvm-nm(1)` :manpage:`llvm-nm(1)`

llvm/trunk/docs/CommandGuide/llvm-nm.rst

Show First 20 Lines • Show All 221 Lines • ▼ Show 20 Lines
Ignored. For GNU compatibility only. Ignored. For GNU compatibility only.
.. option:: --undefined-only, -u .. option:: --undefined-only, -u
Print only undefined symbols. Print only undefined symbols.
.. option:: --version .. 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 .. option:: --without-aliases
Exclude aliases from the output. Exclude aliases from the output.
.. option:: @<FILE> .. option:: @<FILE>
Read command-line options from response file `<FILE>`. Read command-line options from response file `<FILE>`.
▲ Show 20 Lines • Show All 45 Lines • Show Last 20 Lines

llvm/trunk/docs/CommandGuide/llvm-objcopy.rst

Show First 20 Lines • Show All 125 Lines • ▼ Show 20 Lines
.. option:: --strip-unneeded .. option:: --strip-unneeded
Remove from the output all local or undefined symbols that are not required by Remove from the output all local or undefined symbols that are not required by
relocations. Also remove all debug sections. relocations. Also remove all debug sections.
.. option:: --version, -V .. option:: --version, -V
Display the version of this program. Display the version of the :program:`llvm-objcopy` executable.
.. option:: @<FILE> .. 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 COFF-SPECIFIC OPTIONS
--------------------- ---------------------
The following options are implemented only for COFF objects. If used with other The following options are implemented only for COFF objects. If used with other
objects, :program:`llvm-objcopy` will either emit an error or silently ignore objects, :program:`llvm-objcopy` will either emit an error or silently ignore
them. them.
▲ Show 20 Lines • Show All 355 Lines • Show Last 20 Lines

llvm/trunk/docs/CommandGuide/llvm-objdump.rst

Show First 20 Lines • Show All 85 Lines • ▼ Show 20 Lines.. option:: -t, --syms
Display the symbol table. Display the symbol table.
.. option:: -u, --unwind-info .. option:: -u, --unwind-info
Display the unwind info of the input(s). Display the unwind info of the input(s).
.. option:: --version .. 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 .. option:: -x, --all-headers
Display all available header information. Equivalent to specifying Display all available header information. Equivalent to specifying
:option:`--archive-headers`, :option:`--file-headers`, :option:`--archive-headers`, :option:`--file-headers`,
:option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`, :option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`,
and :option:`--syms`. and :option:`--syms`.
▲ Show 20 Lines • Show All 229 Lines • Show Last 20 Lines

llvm/trunk/docs/CommandGuide/llvm-readelf.rst

Show First 20 Lines • Show All 175 Lines • ▼ Show 20 Lines
Display the symbol table. Display the symbol table.
.. option:: --unwind, -u .. option:: --unwind, -u
Display unwind information. Display unwind information.
.. option:: --version .. option:: --version
Display the version of this program. Display the version of the :program:`llvm-readelf` executable.
.. option:: --version-info, -V .. option:: --version-info, -V
Display version sections. Display version sections.
.. option:: @<FILE> .. option:: @<FILE>
Read command-line options from response file `<FILE>`. Read command-line options from response file `<FILE>`.
Show All 11 Lines

llvm/trunk/docs/CommandGuide/llvm-readobj.rst

Show First 20 Lines • Show All 127 Lines • ▼ Show 20 Lines
Display the symbol table. Display the symbol table.
.. option:: --unwind, -u .. option:: --unwind, -u
Display unwind information. Display unwind information.
.. option:: --version .. option:: --version
Display the version of this program. Display the version of the :program:`llvm-readobj` executable.
.. option:: @<FILE> .. option:: @<FILE>
Read command-line options from response file `<FILE>`. Read command-line options from response file `<FILE>`.
ELF SPECIFIC OPTIONS ELF SPECIFIC OPTIONS
-------------------- --------------------
▲ Show 20 Lines • Show All 170 Lines • Show Last 20 Lines

llvm/trunk/docs/CommandGuide/llvm-strip.rst

Show First 20 Lines • Show All 96 Lines • ▼ Show 20 Lines
.. option:: --strip-unneeded .. option:: --strip-unneeded
Remove from the output all local or undefined symbols that are not required by Remove from the output all local or undefined symbols that are not required by
relocations. Also remove all debug sections. relocations. Also remove all debug sections.
.. option:: --version, -V .. option:: --version, -V
Display the version of this program. Display the version of the :program:`llvm-strip` executable.
.. option:: @<FILE> .. 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 COFF-SPECIFIC OPTIONS
--------------------- ---------------------
The following options are implemented only for COFF objects. If used with other The following options are implemented only for COFF objects. If used with other
objects, :program:`llvm-strip` will either emit an error or silently ignore objects, :program:`llvm-strip` will either emit an error or silently ignore
them. them.
▲ Show 20 Lines • Show All 54 Lines • Show Last 20 Lines