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

James Henderson via llvm-commits llvm-commits at lists.llvm.org
Thu Jun 27 06:24:46 PDT 2019


Author: jhenderson
Date: Thu Jun 27 06:24:46 2019
New Revision: 364538

URL: http://llvm.org/viewvc/llvm-project?rev=364538&view=rev
Log:
[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

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

Modified: llvm/trunk/docs/CommandGuide/FileCheck.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/FileCheck.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/FileCheck.rst (original)
+++ llvm/trunk/docs/CommandGuide/FileCheck.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 FileCheck - Flexible pattern matching file verifier
 ===================================================
 
+.. program:: FileCheck
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/bugpoint.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/bugpoint.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/bugpoint.rst (original)
+++ llvm/trunk/docs/CommandGuide/bugpoint.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 bugpoint - automatic test case reduction tool
 =============================================
 
+.. program:: bugpoint
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/dsymutil.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/dsymutil.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/dsymutil.rst (original)
+++ llvm/trunk/docs/CommandGuide/dsymutil.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 dsymutil - manipulate archived DWARF debug symbol files
 =======================================================
 
+.. program:: dsymutil
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/lit.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/lit.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/lit.rst (original)
+++ llvm/trunk/docs/CommandGuide/lit.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 lit - LLVM Integrated Tester
 ============================
 
+.. program:: lit
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llc.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llc.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llc.rst (original)
+++ llvm/trunk/docs/CommandGuide/llc.rst Thu Jun 27 06:24:46 2019
@@ -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

Modified: llvm/trunk/docs/CommandGuide/lli.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/lli.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/lli.rst (original)
+++ llvm/trunk/docs/CommandGuide/lli.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 lli - directly execute programs from LLVM bitcode
 =================================================
 
+.. program:: lli
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-ar.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-ar.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-ar.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-ar.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-ar - LLVM archiver
 =======================
 
+.. program:: llvm-ar
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-as.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-as.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-as.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-as.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-as - LLVM assembler
 ========================
 
+.. program:: llvm-as
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-bcanalyzer.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-bcanalyzer.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-bcanalyzer.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-bcanalyzer.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-bcanalyzer - LLVM bitcode analyzer
 =======================================
 
+.. program:: llvm-bcanalyzer
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-build.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-build.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-build.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-build.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-build - LLVM Project Build Utility
 =======================================
 
+.. program:: llvm-build
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-config.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-config.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-config.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-config.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-config - Print LLVM compilation options
 ============================================
 
+.. program:: llvm-config
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-cov.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cov.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cov.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-cov.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-cov - emit coverage information
 ====================================
 
+.. program:: llvm-cov
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-cxxfilt.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-cxxfilt - LLVM symbol name demangler
 =========================================
 
+.. program:: llvm-cxxfilt
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-cxxmap.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cxxmap.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cxxmap.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-cxxmap.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-cxxmap - Mangled name remapping tool
 =========================================
 
+.. program:: llvm-cxxmap
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-diff.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-diff.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-diff.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-diff.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-diff - LLVM structural 'diff'
 ==================================
 
+.. program:: llvm-diff
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-dis.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dis.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dis.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dis.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-dis - LLVM disassembler
 ============================
 
+.. program:: llvm-dis
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-dwarfdump - dump and verify DWARF debug information
 ========================================================
 
+.. program:: llvm-dwarfdump
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-exegesis.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-exegesis.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-exegesis.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-exegesis.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-exegesis - LLVM Machine Instruction Benchmark
 ==================================================
 
+.. program:: llvm-exegesis
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-extract.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-extract.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-extract.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-extract.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-extract - extract a function from an LLVM module
 =====================================================
 
+.. program:: llvm-extract
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-lib.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-lib.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-lib.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-lib.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,7 @@
 llvm-lib - LLVM lib.exe compatible library tool
 ===============================================
 
+.. program:: llvm-lib
 
 SYNOPSIS
 --------

Modified: llvm/trunk/docs/CommandGuide/llvm-link.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-link.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-link.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-link.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-link - LLVM bitcode linker
 ===============================
 
+.. program:: llvm-link
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-lipo.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-lipo.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-lipo.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-lipo.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-lipo - LLVM tool for manipulating universal binaries
 =========================================================
 
+.. program:: llvm-lipo
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-mca.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-mca.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-mca.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-mca.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-mca - LLVM Machine Code Analyzer
 =====================================
 
+.. program:: llvm-mca
+
 SYNOPSIS
 --------
 
@@ -64,6 +66,11 @@ option specifies "``-``", then the outpu
 
  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.

Modified: llvm/trunk/docs/CommandGuide/llvm-nm.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-nm.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-nm.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-nm.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-nm - list LLVM bitcode and object file's symbol table
 ==========================================================
 
+.. program:: llvm-nm
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-objdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-objdump.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-objdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-objdump.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-objdump - LLVM's object file dumper
 ========================================
 
+.. program:: llvm-objdump
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-pdbutil.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-pdbutil.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-pdbutil.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-pdbutil.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-pdbutil - PDB File forensics and diagnostics
 =================================================
 
+.. program:: llvm-pdbutil
+
 .. contents::
    :local:
 

Modified: llvm/trunk/docs/CommandGuide/llvm-profdata.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-profdata.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-profdata.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-profdata.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-profdata - Profile data tool
 =================================
 
+.. program:: llvm-profdata
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-readobj.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readobj.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readobj.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-readobj.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-readobj - LLVM Object Reader
 =================================
 
+.. program:: llvm-readobj
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-stress.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-stress.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-stress.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-stress.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-stress - generate random .ll files
 =======================================
 
+.. program:: llvm-stress
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/llvm-symbolizer.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-symbolizer.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-symbolizer.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-symbolizer.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 llvm-symbolizer - convert addresses into source code locations
 ==============================================================
 
+.. program:: llvm-symbolizer
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/opt.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/opt.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/opt.rst (original)
+++ llvm/trunk/docs/CommandGuide/opt.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 opt - LLVM optimizer
 ====================
 
+.. program:: opt
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/CommandGuide/tblgen.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/tblgen.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/tblgen.rst (original)
+++ llvm/trunk/docs/CommandGuide/tblgen.rst Thu Jun 27 06:24:46 2019
@@ -1,6 +1,8 @@
 tblgen - Target Description To C++ Code Generator
 =================================================
 
+.. program:: tblgen
+
 SYNOPSIS
 --------
 

Modified: llvm/trunk/docs/WritingAnLLVMPass.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/WritingAnLLVMPass.rst?rev=364538&r1=364537&r2=364538&view=diff
==============================================================================
--- llvm/trunk/docs/WritingAnLLVMPass.rst (original)
+++ llvm/trunk/docs/WritingAnLLVMPass.rst Thu Jun 27 06:24:46 2019
@@ -2,6 +2,8 @@
 Writing an LLVM Pass
 ====================
 
+.. program:: opt
+
 .. contents::
     :local:
 
@@ -264,7 +266,7 @@ documentation to users of :program:`opt`
 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:
 




More information about the llvm-commits mailing list