This is an archive of the discontinued LLVM Phabricator instance.

[docs] [tools] Fix see also links
ClosedPublic

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

Details

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
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.

This revision was automatically updated to reflect the committed changes.