This is an archive of the discontinued LLVM Phabricator instance.

Differential D130292

[AIX][NFC] modify the llvm-ar help information for big archive.
ClosedPublic

Authored by DiggerLin on Jul 21 2022, 11:04 AM.

Details

Reviewers
jhenderson
hubert.reinterpretcast
MaskRay
daltenty
Commits
rG74cb8dfaac09: [AIX][NFC] modify the llvm-ar help information for big archive.

Diff Detail

Event Timeline

DiggerLin created this revision.Jul 21 2022, 11:04 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 21 2022, 11:04 AM
Herald added subscribers: StephenFan, rupprecht. · View Herald Transcript
DiggerLin requested review of this revision.Jul 21 2022, 11:04 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 21 2022, 11:04 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B176823: Diff 446579.Jul 21 2022, 11:49 AM
jhenderson accepted this revision.Jul 22 2022, 12:03 AM

One slight nit, but otherwise LGTM!

llvm/docs/CommandGuide/llvm-ar.rst
22–23

I believe strictly speaking these suggested commas are needed (and should have been there before).

This revision is now accepted and ready to land.Jul 22 2022, 12:03 AM
This revision was landed with ongoing or failed builds.Jul 22 2022, 10:52 AM
Closed by commit rG74cb8dfaac09: [AIX][NFC] modify the llvm-ar help information for big archive. (authored by zhijian <zhijian@ca.ibm.com>). · Explain Why
This revision was automatically updated to reflect the committed changes.
zhijian <zhijian@ca.ibm.com> added a commit: rG74cb8dfaac09: [AIX][NFC] modify the llvm-ar help information for big archive..
DiggerLin mentioned this in D123949: [AIX] support write operation of big archive..Feb 24 2023, 10:41 AM

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
6 lines
tools/
llvm-ar/
2 lines

Diff 446906

llvm/docs/CommandGuide/llvm-ar.rst

Show All 12 Lines
The :program:`llvm-ar` command is similar to the common Unix utility, The :program:`llvm-ar` command is similar to the common Unix utility,
:program:`ar`. It archives several files, such as objects and LLVM bitcode :program:`ar`. It archives several files, such as objects and LLVM bitcode
files into a single archive library that can be linked into a program. However, files into a single archive library that can be linked into a program. However,
the archive can contain any kind of file. By default, :program:`llvm-ar` the archive can contain any kind of file. By default, :program:`llvm-ar`
generates a symbol table that makes linking faster because only the symbol generates a symbol table that makes linking faster because only the symbol
table needs to be consulted, not each individual file member of the archive. table needs to be consulted, not each individual file member of the archive.
The :program:`llvm-ar` command can be used to *read* archive files in SVR4, The :program:`llvm-ar` command can be used to *read* archive files in SVR4, GNU,
GNU, BSD and Darwin format, and *write* in the GNU, BSD, and Darwin style BSD , Big Archive, and Darwin format, and *write* in the GNU, BSD, Big Archive, and
archive files. If an SVR4 format archive is used with the :option:`r` Darwin style archive files. If an SVR4 format archive is used with the :option:`r`
jhendersonUnsubmitted
Not Done
ReplyInline Actions
The :program:`llvm-ar` command can be used to *read* archive files in SVR4, GNU,
- BSD , Big Archive and Darwin format, and *write* in the GNU, BSD, Big Archive and
+ BSD , Big Archive, and Darwin format, and *write* in the GNU, BSD, Big Archive, and
Darwin style archive files. If an SVR4 format archive is used with the :option:`r`
(replace), :option:`d` (delete), :option:`m` (move) or :option:`q`

I believe strictly speaking these suggested commas are needed (and should have been there before).

jhenderson: I believe strictly speaking these suggested commas are needed (and should have been there…
(replace), :option:`d` (delete), :option:`m` (move) or :option:`q` (replace), :option:`d` (delete), :option:`m` (move) or :option:`q`
(quick update) operations, the archive will be reconstructed in the format (quick update) operations, the archive will be reconstructed in the format
defined by :option:`--format`. defined by :option:`--format`.
Here's where :program:`llvm-ar` departs from previous :program:`ar` Here's where :program:`llvm-ar` departs from previous :program:`ar`
implementations: implementations:
*The following option is not supported* *The following option is not supported*
▲ Show 20 Lines • Show All 349 Lines • Show Last 20 Lines

llvm/tools/llvm-ar/llvm-ar.cpp

Show First 20 Lines • Show All 81 Lines • ▼ Show 20 Lines
static void printArHelp(StringRef ToolName) { static void printArHelp(StringRef ToolName) {
const char ArOptions[] = const char ArOptions[] =
R"(OPTIONS: R"(OPTIONS:
--format - archive format to create --format - archive format to create
=default - default =default - default
=gnu - gnu =gnu - gnu
=darwin - darwin =darwin - darwin
=bsd - bsd =bsd - bsd
=aix - aix (big archive) =bigarchive - big archive (AIX OS)
--plugin=<string> - ignored for compatibility --plugin=<string> - ignored for compatibility
-h --help - display this help and exit -h --help - display this help and exit
--output - the directory to extract archive members to --output - the directory to extract archive members to
--rsp-quoting - quoting style for response files --rsp-quoting - quoting style for response files
=posix - posix =posix - posix
=windows - windows =windows - windows
--thin - create a thin archive --thin - create a thin archive
--version - print the version and exit --version - print the version and exit
▲ Show 20 Lines • Show All 1,380 Lines • Show Last 20 Lines