This is an archive of the discontinued LLVM Phabricator instance.

Differential D63970

[docs] [tools] Fix see also links
ClosedPublic

Authored by abrachet on Jun 28 2019, 11:54 PM.

Details

Reviewers
jhenderson
rupprecht
Commits
rG09a066b3aabf: [docs] [tools] Fix see also links
rL365159: [docs] [tools] Fix see also links
Summary

Changes "see also" links to use :manpage: instead of plain text or the form name|name which was being treated literally, not as a link.

Diff Detail

Event Timeline

abrachet created this revision.Jun 28 2019, 11:54 PM
Herald added a project: Restricted Project. · View Herald TranscriptJun 28 2019, 11:54 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
jhenderson added inline comments.Jul 1 2019, 2:57 AM
llvm/docs/CommandGuide/llvm-ar.rst
367

Have you built the docs? I don't think this will work, since there's no GNU ar document in the LLVM docs.

abrachet updated this revision to Diff 207972.Jul 3 2019, 10:18 PM

Removed :manpage:as(1)

abrachet marked 2 inline comments as done.Jul 3 2019, 10:21 PM
abrachet added inline comments.
llvm/docs/CommandGuide/llvm-ar.rst
367

Good catch. Turns out this doesn't produce a warning, the :manpage: directive is not that intuitive.

jhenderson accepted this revision.Jul 4 2019, 1:45 AM

LGTM. This is definitely an improvement. I'm dubious about some "See Also" references (linking GNU as to llvm-as is potentially a bit misleading in my opinion), but you haven't made them worse.

This revision is now accepted and ready to land.Jul 4 2019, 1:45 AM
abrachet marked an inline comment as done.Jul 4 2019, 2:02 AM

linking GNU as to llvm-as is potentially a bit misleading in my opinion

Agreed, I could change this but frankly the name is the bigger problem IMO. But the naming is all over the place for these tools. Some llvm only tools are prefaced with 'll' some don't have that prefix, all of the tools which replace an existing one are in the form llvm-*. Anyway, long way to say I agree llvm-as is not really the same as as.

Closed by commit rG09a066b3aabf: [docs] [tools] Fix see also links (authored by abrachet). · Explain WhyJul 4 2019, 2:22 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

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

Diff 207187

llvm/docs/CommandGuide/bugpoint.rst

Show First 20 Lines • Show All 189 Lines • ▼ Show 20 Lines
----------- -----------
If **bugpoint** succeeds in finding a problem, it will exit with 0. Otherwise, If **bugpoint** succeeds in finding a problem, it will exit with 0. Otherwise,
if an error occurs, it will exit with a non-zero value. if an error occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
opt|opt :manpage:`opt(1)`

llvm/docs/CommandGuide/llc.rst

Show First 20 Lines • Show All 205 Lines • ▼ Show 20 Lines
----------- -----------
If :program:`llc` succeeds, it will exit with 0. Otherwise, if an error If :program:`llc` succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value. occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
lli :manpage:`lli(1)`

llvm/docs/CommandGuide/lli.rst

Show First 20 Lines • Show All 208 Lines • ▼ Show 20 Lines
----------- -----------
If :program:`lli` fails to load the program, it will exit with an exit code of 1. If :program:`lli` fails to load the program, it will exit with an exit code of 1.
Otherwise, it will return the exit code of the program it executes. Otherwise, it will return the exit code of the program it executes.
SEE ALSO SEE ALSO
-------- --------
:program:`llc` :manpage:`llc(1)`

llvm/docs/CommandGuide/llvm-ar.rst

Show First 20 Lines • Show All 358 Lines • ▼ Show 20 Lines
in an exit code of 1. A hard (file system typically) error results in an in an exit code of 1. A hard (file system typically) error results in an
exit code of 2. Miscellaneous or unknown errors result in an exit code of 2. Miscellaneous or unknown errors result in an
exit code of 3. exit code of 3.
SEE ALSO SEE ALSO
-------- --------
:manpage:`ar(1)`
jhendersonUnsubmitted
Done
ReplyInline Actions

Have you built the docs? I don't think this will work, since there's no GNU ar document in the LLVM docs.

jhenderson: Have you built the docs? I don't think this will work, since there's no GNU ar document in the…
abrachetAuthorUnsubmitted
Done
ReplyInline Actions

Good catch. Turns out this doesn't produce a warning, the :manpage: directive is not that intuitive.

abrachet: Good catch. Turns out this doesn't produce a warning, the `:manpage:` directive is not that…
ar(1)

llvm/docs/CommandGuide/llvm-as.rst

Show First 20 Lines • Show All 49 Lines • ▼ Show 20 Lines
----------- -----------
If **llvm-as** succeeds, it will exit with 0. Otherwise, if an error occurs, it If **llvm-as** succeeds, it will exit with 0. Otherwise, if an error occurs, it
will exit with a non-zero value. will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
llvm-dis|llvm-dis, gccas|gccas :manpage:`llvm-dis(1)`, as(1)

llvm/docs/CommandGuide/llvm-bcanalyzer.rst

Show First 20 Lines • Show All 297 Lines • ▼ Show 20 Lines
**Bytes Saved With VBR** **Bytes Saved With VBR**
The total number of bytes saved in this function by using the Variable Bit The total number of bytes saved in this function by using the Variable Bit
Rate encoding scheme. The percentage is relative to # of VBR Expanded Bytes. Rate encoding scheme. The percentage is relative to # of VBR Expanded Bytes.
SEE ALSO SEE ALSO
-------- --------
:doc:`/CommandGuide/llvm-dis`, :doc:`/BitCodeFormat` :manpage:`llvm-dis(1)`, :doc:`/BitCodeFormat`

llvm/docs/CommandGuide/llvm-dis.rst

Show First 20 Lines • Show All 61 Lines • ▼ Show 20 Lines
If **llvm-dis** succeeds, it will exit with 0. Otherwise, if an error If **llvm-dis** succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value. occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
llvm-as|llvm-as :manpage:`llvm-as(1)`

llvm/docs/CommandGuide/llvm-extract.rst

Show First 20 Lines • Show All 71 Lines • ▼ Show 20 Lines
----------- -----------
If :program:`llvm-extract` succeeds, it will exit with 0. Otherwise, if an error If :program:`llvm-extract` succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value. occurs, it will exit with a non-zero value.
SEE ALSO SEE ALSO
-------- --------
bugpoint :manpage:`bugpoint(1)`