llvm.org GIT mirror llvm / c10a5d7
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@364538 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
33 changed file(s) with 71 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
0 FileCheck - Flexible pattern matching file verifier
11 ===================================================
2
3 .. program:: FileCheck
24
35 SYNOPSIS
46 --------
0 bugpoint - automatic test case reduction tool
11 =============================================
2
3 .. program:: bugpoint
24
35 SYNOPSIS
46 --------
0 dsymutil - manipulate archived DWARF debug symbol files
11 =======================================================
2
3 .. program:: dsymutil
24
35 SYNOPSIS
46 --------
0 lit - LLVM Integrated Tester
11 ============================
2
3 .. program:: lit
24
35 SYNOPSIS
46 --------
0 llc - LLVM static compiler
11 ==========================
2
3 .. program:: llc
24
35 SYNOPSIS
46 --------
3941 .. option:: -help
4042
4143 Print a summary of command line options.
44
45 .. option:: -o
46
47 Use ```` as the output filename. See the summary above for more
48 details.
4249
4350 .. option:: -O=uint
4451
0 lli - directly execute programs from LLVM bitcode
11 =================================================
2
3 .. program:: lli
24
35 SYNOPSIS
46 --------
0 llvm-ar - LLVM archiver
11 =======================
22
3 .. program:: llvm-ar
34
45 SYNOPSIS
56 --------
0 llvm-as - LLVM assembler
11 ========================
2
3 .. program:: llvm-as
24
35 SYNOPSIS
46 --------
0 llvm-bcanalyzer - LLVM bitcode analyzer
11 =======================================
2
3 .. program:: llvm-bcanalyzer
24
35 SYNOPSIS
46 --------
0 llvm-build - LLVM Project Build Utility
11 =======================================
22
3 .. program:: llvm-build
34
45 SYNOPSIS
56 --------
0 llvm-config - Print LLVM compilation options
11 ============================================
22
3 .. program:: llvm-config
34
45 SYNOPSIS
56 --------
0 llvm-cov - emit coverage information
11 ====================================
2
3 .. program:: llvm-cov
24
35 SYNOPSIS
46 --------
0 llvm-cxxfilt - LLVM symbol name demangler
11 =========================================
2
3 .. program:: llvm-cxxfilt
24
35 SYNOPSIS
46 --------
0 llvm-cxxmap - Mangled name remapping tool
11 =========================================
2
3 .. program:: llvm-cxxmap
24
35 SYNOPSIS
46 --------
0 llvm-diff - LLVM structural 'diff'
11 ==================================
22
3 .. program:: llvm-diff
34
45 SYNOPSIS
56 --------
0 llvm-dis - LLVM disassembler
11 ============================
22
3 .. program:: llvm-dis
34
45 SYNOPSIS
56 --------
0 llvm-dwarfdump - dump and verify DWARF debug information
11 ========================================================
2
3 .. program:: llvm-dwarfdump
24
35 SYNOPSIS
46 --------
0 llvm-exegesis - LLVM Machine Instruction Benchmark
11 ==================================================
2
3 .. program:: llvm-exegesis
24
35 SYNOPSIS
46 --------
0 llvm-extract - extract a function from an LLVM module
11 =====================================================
2
3 .. program:: llvm-extract
24
35 SYNOPSIS
46 --------
0 llvm-lib - LLVM lib.exe compatible library tool
11 ===============================================
22
3 .. program:: llvm-lib
34
45 SYNOPSIS
56 --------
0 llvm-link - LLVM bitcode linker
11 ===============================
2
3 .. program:: llvm-link
24
35 SYNOPSIS
46 --------
0 llvm-lipo - LLVM tool for manipulating universal binaries
11 =========================================================
2
3 .. program:: llvm-lipo
24
35 SYNOPSIS
46 --------
0 llvm-mca - LLVM Machine Code Analyzer
11 =====================================
2
3 .. program:: llvm-mca
24
35 SYNOPSIS
46 --------
6264 .. option:: -help
6365
6466 Print a summary of command line options.
67
68 .. option:: -o
69
70 Use ```` as the output filename. See the summary above for more
71 details.
6572
6673 .. option:: -mtriple=
6774
0 llvm-nm - list LLVM bitcode and object file's symbol table
11 ==========================================================
2
3 .. program:: llvm-nm
24
35 SYNOPSIS
46 --------
0 llvm-objdump - LLVM's object file dumper
11 ========================================
2
3 .. program:: llvm-objdump
24
35 SYNOPSIS
46 --------
0 llvm-pdbutil - PDB File forensics and diagnostics
11 =================================================
2
3 .. program:: llvm-pdbutil
24
35 .. contents::
46 :local:
0 llvm-profdata - Profile data tool
11 =================================
2
3 .. program:: llvm-profdata
24
35 SYNOPSIS
46 --------
0 llvm-readobj - LLVM Object Reader
11 =================================
2
3 .. program:: llvm-readobj
24
35 SYNOPSIS
46 --------
0 llvm-stress - generate random .ll files
11 =======================================
2
3 .. program:: llvm-stress
24
35 SYNOPSIS
46 --------
0 llvm-symbolizer - convert addresses into source code locations
11 ==============================================================
2
3 .. program:: llvm-symbolizer
24
35 SYNOPSIS
46 --------
0 opt - LLVM optimizer
11 ====================
2
3 .. program:: opt
24
35 SYNOPSIS
46 --------
0 tblgen - Target Description To C++ Code Generator
11 =================================================
2
3 .. program:: tblgen
24
35 SYNOPSIS
46 --------
0 ====================
11 Writing an LLVM Pass
22 ====================
3
4 .. program:: opt
35
46 .. contents::
57 :local:
263265 you would go ahead and make it do the cool transformations you want. Once you
264266 get it all working and tested, it may become useful to find out how fast your
265267 pass is. The :ref:`PassManager ` provides a
266 nice command line option (:option:`--time-passes`) that allows you to get
268 nice command line option (:option:`-time-passes`) that allows you to get
267269 information about the execution time of your pass along with the other passes
268270 you queue up. For example:
269271