Skip to content

Commit

Permalink
[Docs][typo] Done the required fix for the #61690
Browse files Browse the repository at this point in the history
Differential Revision: https://reviews.llvm.org/D146898
  • Loading branch information
aabhinavg committed Apr 6, 2023
1 parent c8525e9 commit 4084737
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions llvm/docs/CommandGuide/llvm-opt-report.rst
Expand Up @@ -15,6 +15,9 @@ DESCRIPTION

You need to create an input YAML optimization record file before running :program:`llvm-opt-report`.

It provides information on the execution time, memory usage, and other details of each optimization pass.


.. code-block:: console
$ clang -c foo.c -o foo.o -O3 -fsave-optimization-record
Expand Down Expand Up @@ -60,6 +63,12 @@ The meanings of the symbols are as follows:
- U: The loop is unrolled. The following number indicates the unroll factor.
- V: The loop is vectorized. The following numbers indicate the vector length and the interleave factor.

.. note::

If a specific line of code is output twice, it means that the same optimization pass was applied to that
line of code twice, and the pass was able to further optimize the code on the second iteration.


OPTIONS
-------

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/GettingStarted.rst
Expand Up @@ -583,7 +583,7 @@ Local LLVM Configuration
Once checked out repository, the LLVM suite source code must be configured
before being built. This process uses CMake. Unlinke the normal ``configure``
script, CMake generates the build files in whatever format you request as well
as various ``*.inc`` files, and ``llvm/include/Config/config.h``.
as various ``*.inc`` files, and ``llvm/include/llvm/Config/config.h.cmake``.

Variables are passed to ``cmake`` on the command line using the format
``-D<variable name>=<value>``. The following variables are some common options
Expand Down

0 comments on commit 4084737

Please sign in to comment.