]> granicus.if.org Git - llvm/commitdiff
[docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin
authorJames Henderson <jh7370@my.bristol.ac.uk>
Tue, 11 Jun 2019 13:46:52 +0000 (13:46 +0000)
committerJames Henderson <jh7370@my.bristol.ac.uk>
Tue, 11 Jun 2019 13:46:52 +0000 (13:46 +0000)
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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363065 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CommandGuide/llvm-nm.rst

index 2a2f8275ffc96ff0fd81e25ccab76cf0d48aa44c..f679a04d45a1b473866a58bf3287f8008241fe1f 100644 (file)
@@ -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