Page MenuHomePhabricator

[docs][tools] Add missing "program" tags to rst files
ClosedPublic

Authored by jhenderson on Jun 27 2019, 4:59 AM.

Details

Summary

Sphinx allows for definitions of command-line options using .. option <name> and references to those options via :option:<name>. However, it looks like there is no scoping of these options by default, meaning that links can end up pointing to incorrect documents. See for example the llvm-mca document, which contains references to -o that point to a different document. What's worse is that these links appear to be non-deterministic in which one is picked (on my machine, some references end up pointing to opt, whereas on the live docs, they point to llvm-dwarfdump, for example).

The fix is to add the .. program <name> tag. This essentially namespaces the options (definitions and references) to the named program, ensuring that the links are kept correct.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jun 27 2019, 4:59 AM
Herald added a reviewer: andreadb. · View Herald Transcript
Herald added a project: Restricted Project. · View Herald Transcript
This revision is now accepted and ready to land.Jun 27 2019, 5:53 AM
This revision was automatically updated to reflect the committed changes.