[llvm] 4084737 - [Docs][typo] Done the required fix for the #61690
via llvm-commits
llvm-commits at lists.llvm.org
Thu Apr 6 09:52:47 PDT 2023
Author: aabhinavg
Date: 2023-04-06T22:22:33+05:30
New Revision: 40847375d8de63d30b791a1a29d25e29d83a5497
URL: https://github.com/llvm/llvm-project/commit/40847375d8de63d30b791a1a29d25e29d83a5497
DIFF: https://github.com/llvm/llvm-project/commit/40847375d8de63d30b791a1a29d25e29d83a5497.diff
LOG: [Docs][typo] Done the required fix for the #61690
Differential Revision: https://reviews.llvm.org/D146898
Added:
Modified:
llvm/docs/CommandGuide/llvm-opt-report.rst
llvm/docs/GettingStarted.rst
Removed:
################################################################################
diff --git a/llvm/docs/CommandGuide/llvm-opt-report.rst b/llvm/docs/CommandGuide/llvm-opt-report.rst
index 675108a11f429..4a666a4aa7afd 100644
--- a/llvm/docs/CommandGuide/llvm-opt-report.rst
+++ b/llvm/docs/CommandGuide/llvm-opt-report.rst
@@ -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
@@ -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
-------
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 9247b3908aeb8..fffbbe66c56af 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -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
More information about the llvm-commits
mailing list