This is an archive of the discontinued LLVM Phabricator instance.

Differential D63135

[docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin
ClosedPublic

Authored by jhenderson on Jun 11 2019, 6:22 AM.

Details

Reviewers
rupprecht
sbc100
kastiglione
MaskRay
grimar
Commits
rGbe7f5c71584c: [docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin
rL363065: [docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin
Summary

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.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jun 11 2019, 6:22 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 11 2019, 6:22 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
jhenderson retitled this revision from [docs][llvm-nm to [docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin.Jun 11 2019, 6:26 AM
jhenderson edited the summary of this revision. (Show Details)
jhenderson added reviewers: rupprecht, sbc100, kastiglione, MaskRay, grimar.
jhenderson added subscribers: gbreynoo, chrisjackson, edd and 2 others.
grimar accepted this revision.Jun 11 2019, 6:30 AM

I confirm it matches the behavior I am observing.

This revision is now accepted and ready to land.Jun 11 2019, 6:30 AM
Closed by commit rL363065: [docs][llvm-nm] Fix documentation regarding llvm-nm reading stdin (authored by jhenderson). · Explain WhyJun 11 2019, 6:43 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
trunk/
docs/
CommandGuide/
5 lines

Diff 204051

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

llvm-nm - list LLVM bitcode and object file's symbol table llvm-nm - list LLVM bitcode and object file's symbol table
========================================================== ==========================================================
SYNOPSIS SYNOPSIS
-------- --------
:program:`llvm-nm` [*options*] [*filenames...*] :program:`llvm-nm` [*options*] [*filenames...*]
DESCRIPTION DESCRIPTION
----------- -----------
The :program:`llvm-nm` utility lists the names of symbols from the LLVM bitcode 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 files, object files, or :program:`ar` archives containing them, named on the
command line. Each symbol is listed along with some simple information about 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, its provenance. If no filename is specified, *a.out* is used as the input.
:program:`llvm-nm` will process a file on its standard input stream. 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` :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 output format. Each such output record consists of an (optional) 8-digit
hexadecimal address, followed by a type code character, followed by a name, for hexadecimal address, followed by a type code character, followed by a name, for
each symbol. One record is printed per line; fields are separated by spaces. each symbol. One record is printed per line; fields are separated by spaces.
When the address is omitted, it is replaced by 8 spaces. When the address is omitted, it is replaced by 8 spaces.
Type code characters currently supported, and their meanings, are as follows: Type code characters currently supported, and their meanings, are as follows:
▲ Show 20 Lines • Show All 128 Lines • Show Last 20 Lines