[PATCH] D63873: [docs][tools] Add missing "program" tags to rst files

[James Henderson via Phabricator via llvm-commits]

jhenderson created this revision.
jhenderson added reviewers: MaskRay, ikudrin, rupprecht, peter.smith, mtrent.
Herald added subscribers: thopre, gbedwell, aprantl.
Herald added a reviewer: JDevlieghere.
Herald added a reviewer: andreadb.
Herald added a project: LLVM.

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.


Repository:
  rL LLVM

https://reviews.llvm.org/D63873

Files:
  docs/CommandGuide/FileCheck.rst
  docs/CommandGuide/bugpoint.rst
  docs/CommandGuide/dsymutil.rst
  docs/CommandGuide/lit.rst
  docs/CommandGuide/llc.rst
  docs/CommandGuide/lli.rst
  docs/CommandGuide/llvm-ar.rst
  docs/CommandGuide/llvm-as.rst
  docs/CommandGuide/llvm-bcanalyzer.rst
  docs/CommandGuide/llvm-build.rst
  docs/CommandGuide/llvm-config.rst
  docs/CommandGuide/llvm-cov.rst
  docs/CommandGuide/llvm-cxxfilt.rst
  docs/CommandGuide/llvm-cxxmap.rst
  docs/CommandGuide/llvm-diff.rst
  docs/CommandGuide/llvm-dis.rst
  docs/CommandGuide/llvm-dwarfdump.rst
  docs/CommandGuide/llvm-exegesis.rst
  docs/CommandGuide/llvm-extract.rst
  docs/CommandGuide/llvm-lib.rst
  docs/CommandGuide/llvm-link.rst
  docs/CommandGuide/llvm-lipo.rst
  docs/CommandGuide/llvm-mca.rst
  docs/CommandGuide/llvm-nm.rst
  docs/CommandGuide/llvm-objdump.rst
  docs/CommandGuide/llvm-pdbutil.rst
  docs/CommandGuide/llvm-profdata.rst
  docs/CommandGuide/llvm-readobj.rst
  docs/CommandGuide/llvm-stress.rst
  docs/CommandGuide/llvm-symbolizer.rst
  docs/CommandGuide/opt.rst
  docs/CommandGuide/tblgen.rst
  docs/WritingAnLLVMPass.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D63873.206831.patch
Type: text/x-patch
Size: 11963 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190627/b2907331/attachment.bin>