summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide/llvm-nm.rst
diff options
context:
space:
mode:
authorJames Henderson <jh7370@my.bristol.ac.uk>2019-06-11 13:46:52 +0000
committerJames Henderson <jh7370@my.bristol.ac.uk>2019-06-11 13:46:52 +0000
commitbe7f5c71584c2cdbb9d47f9f7ba8b9a955c94b05 (patch)
tree817d2bcc728b973b89ba7f1f3806b84c54c6e933 /llvm/docs/CommandGuide/llvm-nm.rst
parent47d77365aa7148bc7d7b2883cb93ed14bd88999d (diff)
downloadbcm5719-llvm-be7f5c71584c2cdbb9d47f9f7ba8b9a955c94b05.tar.gz
bcm5719-llvm-be7f5c71584c2cdbb9d47f9f7ba8b9a955c94b05.zip
[docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin
llvm-nm reads a.out NOT stdin when no input file is specified. This patch fixes the doc accordingly, and rephrases the surrounding sentence slightly. Reviewed by: grimar Differential Revision: https://reviews.llvm.org/D63135 llvm-svn: 363065
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-nm.rst')
-rw-r--r--llvm/docs/CommandGuide/llvm-nm.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/llvm/docs/CommandGuide/llvm-nm.rst b/llvm/docs/CommandGuide/llvm-nm.rst
index 2a2f8275ffc..f679a04d45a 100644
--- a/llvm/docs/CommandGuide/llvm-nm.rst
+++ b/llvm/docs/CommandGuide/llvm-nm.rst
@@ -12,8 +12,9 @@ DESCRIPTION
The :program:`llvm-nm` utility lists the names of symbols from the LLVM bitcode
files, object files, or :program:`ar` archives containing them, named on the
command line. Each symbol is listed along with some simple information about
-its provenance. If no file name is specified, or *-* is used as a file name,
-:program:`llvm-nm` will process a file on its standard input stream.
+its provenance. If no filename is specified, *a.out* is used as the input.
+If *-* is used as a filename, :program:`llvm-nm` will read a file from its
+standard input stream.
:program:`llvm-nm`'s default output format is the traditional BSD :program:`nm`
output format. Each such output record consists of an (optional) 8-digit
OpenPOWER on IntegriCloud