diff options
| author | Aaron Ballman <aaron@aaronballman.com> | 2023-08-02 07:52:25 -0400 |
|---|---|---|
| committer | Aaron Ballman <aaron@aaronballman.com> | 2023-08-02 07:53:21 -0400 |
| commit | abb09a6788c142e4da728c23c29e2f36c06aea59 (patch) | |
| tree | 7d3e2e020edc84720e0fdf393fa9f40c859fed99 /llvm/docs/CommandGuide | |
| parent | 5bfefff1c44fd992b673e1ff9c9f1865f9d81af1 (diff) | |
| download | llvm-abb09a6788c142e4da728c23c29e2f36c06aea59.zip llvm-abb09a6788c142e4da728c23c29e2f36c06aea59.tar.gz llvm-abb09a6788c142e4da728c23c29e2f36c06aea59.tar.bz2 | |
Fix LLVM Sphinx build
This addresses issues found by:
https://lab.llvm.org/buildbot/#/builders/30/builds/38316
as well as issues found when building locally.
Diffstat (limited to 'llvm/docs/CommandGuide')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-remarkutil.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/llvm/docs/CommandGuide/llvm-remarkutil.rst b/llvm/docs/CommandGuide/llvm-remarkutil.rst index 5859d6d..d13a517 100644 --- a/llvm/docs/CommandGuide/llvm-remarkutil.rst +++ b/llvm/docs/CommandGuide/llvm-remarkutil.rst @@ -21,7 +21,7 @@ Subcommands * :ref:`yaml2bitstream_subcommand` - Reserialize YAML remarks to bitstream. * :ref:`instruction-count_subcommand` - Output function instruction counts. * :ref:`annotation-count_subcommand` - Output remark type count from annotation remarks. - * :ref: `size-diff_subcommand` - Compute diff in size remarks. + * :ref:`size-diff_subcommand` - Compute diff in size remarks. .. _bitstream2yaml_subcommand: @@ -171,7 +171,7 @@ two sections: * A high-level summary of all changes. Changed Function Section -######################## +~~~~~~~~~~~~~~~~~~~~~~~~ Suppose you are comparing two remark files OLD and NEW. @@ -208,7 +208,7 @@ A breakdown of the format is below: Second file stack byte count - first file stack byte count. Summary Section -############### +~~~~~~~~~~~~~~~ :program:`llvm-remarkutil size-diff` will output a high-level summary after printing all changed functions. @@ -236,7 +236,7 @@ JSON OUTPUT ----------- High-Level view -############### +~~~~~~~~~~~~~~~ Suppose we are comparing two files, OLD and NEW. @@ -278,7 +278,7 @@ Suppose we are comparing two files, OLD and NEW. Functions only present in the second file. Function JSON -############# +~~~~~~~~~~~~~ The ``InBoth``, ``OnlyInA``, and ``OnlyInB`` sections contain size information for each function in the input remark files. @@ -313,7 +313,7 @@ for each function in the input remark files. * ``STACK_BYTES_B``: Stack bytes in NEW. Computing Diffs From Function JSON -********************************** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Function JSON does not contain the diffs. Tools consuming JSON output from :program:`llvm-remarkutil size-diff` are responsible for computing the diffs |