RPCS3/llvm
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm.git synced 2025-02-22 19:50:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
This commit is contained in:
James Henderson 2019-06-27 13:24:46 +00:00
parent 856ec6e1b0
commit c10a5d752e
33 changed files with 71 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CommandGuide/FileCheck.rst
View File

@ -1,6 +1,8 @@
FileCheck - Flexible pattern matching file verifier
===================================================
.. program:: FileCheck
SYNOPSIS
--------

2
docs/CommandGuide/bugpoint.rst
View File

@ -1,6 +1,8 @@
bugpoint - automatic test case reduction tool
=============================================
.. program:: bugpoint
SYNOPSIS
--------

2
docs/CommandGuide/dsymutil.rst
View File

@ -1,6 +1,8 @@
dsymutil - manipulate archived DWARF debug symbol files
=======================================================
.. program:: dsymutil
SYNOPSIS
--------

2
docs/CommandGuide/lit.rst
View File

@ -1,6 +1,8 @@
lit - LLVM Integrated Tester
============================
.. program:: lit
SYNOPSIS
--------

7
docs/CommandGuide/llc.rst
View File

@ -1,6 +1,8 @@
llc - LLVM static compiler
==========================
.. program:: llc
SYNOPSIS
--------
@ -41,6 +43,11 @@ End-user Options
Print a summary of command line options.
.. option:: -o <filename>
Use ``<filename>`` as the output filename. See the summary above for more
details.
.. option:: -O=uint
Generate code at different optimization levels. These correspond to the

2
docs/CommandGuide/lli.rst
View File

@ -1,6 +1,8 @@
lli - directly execute programs from LLVM bitcode
=================================================
.. program:: lli
SYNOPSIS
--------

1
docs/CommandGuide/llvm-ar.rst
View File

@ -1,6 +1,7 @@
llvm-ar - LLVM archiver
=======================
.. program:: llvm-ar
SYNOPSIS
--------

2
docs/CommandGuide/llvm-as.rst
View File

@ -1,6 +1,8 @@
llvm-as - LLVM assembler
========================
.. program:: llvm-as
SYNOPSIS
--------

2
docs/CommandGuide/llvm-bcanalyzer.rst
View File

@ -1,6 +1,8 @@
llvm-bcanalyzer - LLVM bitcode analyzer
=======================================
.. program:: llvm-bcanalyzer
SYNOPSIS
--------

1
docs/CommandGuide/llvm-build.rst
View File

@ -1,6 +1,7 @@
llvm-build - LLVM Project Build Utility
=======================================
.. program:: llvm-build
SYNOPSIS
--------

1
docs/CommandGuide/llvm-config.rst
View File

@ -1,6 +1,7 @@
llvm-config - Print LLVM compilation options
============================================
.. program:: llvm-config
SYNOPSIS
--------

2
docs/CommandGuide/llvm-cov.rst
View File

@ -1,6 +1,8 @@
llvm-cov - emit coverage information
====================================
.. program:: llvm-cov
SYNOPSIS
--------

2
docs/CommandGuide/llvm-cxxfilt.rst
View File

@ -1,6 +1,8 @@
llvm-cxxfilt - LLVM symbol name demangler
=========================================
.. program:: llvm-cxxfilt
SYNOPSIS
--------

2
docs/CommandGuide/llvm-cxxmap.rst
View File

@ -1,6 +1,8 @@
llvm-cxxmap - Mangled name remapping tool
=========================================
.. program:: llvm-cxxmap
SYNOPSIS
--------

1
docs/CommandGuide/llvm-diff.rst
View File

@ -1,6 +1,7 @@
llvm-diff - LLVM structural 'diff'
==================================
.. program:: llvm-diff
SYNOPSIS
--------

1
docs/CommandGuide/llvm-dis.rst
View File

@ -1,6 +1,7 @@
llvm-dis - LLVM disassembler
============================
.. program:: llvm-dis
SYNOPSIS
--------

2
docs/CommandGuide/llvm-dwarfdump.rst
View File

@ -1,6 +1,8 @@
llvm-dwarfdump - dump and verify DWARF debug information
========================================================
.. program:: llvm-dwarfdump
SYNOPSIS
--------

2
docs/CommandGuide/llvm-exegesis.rst
View File

@ -1,6 +1,8 @@
llvm-exegesis - LLVM Machine Instruction Benchmark
==================================================
.. program:: llvm-exegesis
SYNOPSIS
--------

2
docs/CommandGuide/llvm-extract.rst
View File

@ -1,6 +1,8 @@
llvm-extract - extract a function from an LLVM module
=====================================================
.. program:: llvm-extract
SYNOPSIS
--------

1
docs/CommandGuide/llvm-lib.rst
View File

@ -1,6 +1,7 @@
llvm-lib - LLVM lib.exe compatible library tool
===============================================
.. program:: llvm-lib
SYNOPSIS
--------

2
docs/CommandGuide/llvm-link.rst
View File

@ -1,6 +1,8 @@
llvm-link - LLVM bitcode linker
===============================
.. program:: llvm-link
SYNOPSIS
--------

2
docs/CommandGuide/llvm-lipo.rst
View File

@ -1,6 +1,8 @@
llvm-lipo - LLVM tool for manipulating universal binaries
=========================================================
.. program:: llvm-lipo
SYNOPSIS
--------

7
docs/CommandGuide/llvm-mca.rst
View File

@ -1,6 +1,8 @@
llvm-mca - LLVM Machine Code Analyzer
=====================================
.. program:: llvm-mca
SYNOPSIS
--------
@ -64,6 +66,11 @@ option specifies "``-``", then the output will also be sent to standard output.
Print a summary of command line options.
.. option:: -o <filename>
Use ``<filename>`` as the output filename. See the summary above for more
details.
.. option:: -mtriple=<target triple>
Specify a target triple string.

2
docs/CommandGuide/llvm-nm.rst
View File

@ -1,6 +1,8 @@
llvm-nm - list LLVM bitcode and object file's symbol table
==========================================================
.. program:: llvm-nm
SYNOPSIS
--------

2
docs/CommandGuide/llvm-objdump.rst
View File

@ -1,6 +1,8 @@
llvm-objdump - LLVM's object file dumper
========================================
.. program:: llvm-objdump
SYNOPSIS
--------

2
docs/CommandGuide/llvm-pdbutil.rst
View File

@ -1,6 +1,8 @@
llvm-pdbutil - PDB File forensics and diagnostics
=================================================
.. program:: llvm-pdbutil
.. contents::
:local:

2
docs/CommandGuide/llvm-profdata.rst
View File

@ -1,6 +1,8 @@
llvm-profdata - Profile data tool
=================================
.. program:: llvm-profdata
SYNOPSIS
--------

2
docs/CommandGuide/llvm-readobj.rst
View File

@ -1,6 +1,8 @@
llvm-readobj - LLVM Object Reader
=================================
.. program:: llvm-readobj
SYNOPSIS
--------

2
docs/CommandGuide/llvm-stress.rst
View File

@ -1,6 +1,8 @@
llvm-stress - generate random .ll files
=======================================
.. program:: llvm-stress
SYNOPSIS
--------

2
docs/CommandGuide/llvm-symbolizer.rst
View File

@ -1,6 +1,8 @@
llvm-symbolizer - convert addresses into source code locations
==============================================================
.. program:: llvm-symbolizer
SYNOPSIS
--------

2
docs/CommandGuide/opt.rst
View File

@ -1,6 +1,8 @@
opt - LLVM optimizer
====================
.. program:: opt
SYNOPSIS
--------

2
docs/CommandGuide/tblgen.rst
View File

@ -1,6 +1,8 @@
tblgen - Target Description To C++ Code Generator
=================================================
.. program:: tblgen
SYNOPSIS
--------

4
docs/WritingAnLLVMPass.rst
View File

@ -2,6 +2,8 @@
Writing an LLVM Pass
====================
.. program:: opt
.. contents::
:local:
@ -264,7 +266,7 @@ documentation to users of :program:`opt`. Now that you have a working pass,
you would go ahead and make it do the cool transformations you want. Once you
get it all working and tested, it may become useful to find out how fast your
pass is. The :ref:`PassManager <writing-an-llvm-pass-passmanager>` provides a
nice command line option (:option:`--time-passes`) that allows you to get
nice command line option (:option:`-time-passes`) that allows you to get
information about the execution time of your pass along with the other passes
you queue up. For example: