diff options
| author | James Henderson <jh7370@my.bristol.ac.uk> | 2019-06-27 13:24:46 +0000 |
|---|---|---|
| committer | James Henderson <jh7370@my.bristol.ac.uk> | 2019-06-27 13:24:46 +0000 |
| commit | a056684c335995214f6d3467c699d32f8e73b763 (patch) | |
| tree | f7bf3664fb87e6bc144ea1254d4e90e91de84961 /llvm/docs/CommandGuide/llvm-diff.rst | |
| parent | 93a825c8fb91b26a1a6e92bbbb01ea78c34d09d8 (diff) | |
| download | bcm5719-llvm-a056684c335995214f6d3467c699d32f8e73b763.tar.gz bcm5719-llvm-a056684c335995214f6d3467c699d32f8e73b763.zip | |
[docs][tools] Add missing "program" tags to rst files
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,
prior to this patch, pointed 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.
Reviwed by: andreadb
Differential Revision: https://reviews.llvm.org/D63873
llvm-svn: 364538
Diffstat (limited to 'llvm/docs/CommandGuide/llvm-diff.rst')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-diff.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/llvm-diff.rst b/llvm/docs/CommandGuide/llvm-diff.rst index 991d4fece04..b858b981ed2 100644 --- a/llvm/docs/CommandGuide/llvm-diff.rst +++ b/llvm/docs/CommandGuide/llvm-diff.rst @@ -1,6 +1,7 @@ llvm-diff - LLVM structural 'diff' ================================== +.. program:: llvm-diff SYNOPSIS -------- |
