Diff 511461

llvm/docs/CommandGuide/llvm-opt-report.rst

	Show All 9 Lines

	DESCRIPTION			DESCRIPTION
	-----------			-----------

	:program:`llvm-opt-report` is a tool to generate an optimization report from YAML optimization record files.			:program:`llvm-opt-report` is a tool to generate an optimization report from YAML optimization record files.

	You need to create an input YAML optimization record file before running :program:`llvm-opt-report`.			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.
				serge-sans-pailleUnsubmitted Done Reply Inline Actions This line is mostly redundant with line 14. And line 19 would be great right after line 14. serge-sans-paille: This line is mostly redundant with line 14. And line 19 would be great right after line 14.


				serge-sans-pailleUnsubmitted Done Reply Inline Actions maybe move that after the two examples, as it's just an extra explanation on the behavior. serge-sans-paille: maybe move that after the two examples, as it's just an extra explanation on the behavior.
	.. code-block:: console			.. code-block:: console

	$ clang -c foo.c -o foo.o -O3 -fsave-optimization-record			$ clang -c foo.c -o foo.o -O3 -fsave-optimization-record

	Then, you create a report using the :program:`llvm-opt-report` command with the YAML optimization record file :file:`foo.opt.yaml` as input.			Then, you create a report using the :program:`llvm-opt-report` command with the YAML optimization record file :file:`foo.opt.yaml` as input.

	.. code-block:: console			.. code-block:: console

	Show All 29 Lines

	Symbols printed on the left side of the program indicate what kind of optimization was performed.			Symbols printed on the left side of the program indicate what kind of optimization was performed.
	The meanings of the symbols are as follows:			The meanings of the symbols are as follows:

	- I: The function is inlined.			- I: The function is inlined.
	- U: The loop is unrolled. The following number indicates the unroll factor.			- 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.			- V: The loop is vectorized. The following numbers indicate the vector length and the interleave factor.

				.. note::
				serge-sans-pailleUnsubmitted Not Done Reply Inline Actions https://sublime-and-sphinx-guide.readthedocs.io/en/latest/notes_warnings.html serge-sans-paille: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/notes_warnings.html

				serge-sans-pailleUnsubmitted Done Reply Inline Actions I think `.. note::` requires an indented block. serge-sans-paille: I think `.. note::` requires an indented block.
				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			OPTIONS
	-------			-------

	If ``input`` is "``-``" or omitted, :program:`llvm-opt-report` reads from standard			If ``input`` is "``-``" or omitted, :program:`llvm-opt-report` reads from standard
	input. Otherwise, it will read from the specified filename.			input. Otherwise, it will read from the specified filename.

	If the :option:`-o` option is omitted, then :program:`llvm-opt-report` will send its output			If the :option:`-o` option is omitted, then :program:`llvm-opt-report` will send its output
	to standard output. If the :option:`-o` option specifies "``-``", then the output will also			to standard output. If the :option:`-o` option specifies "``-``", then the output will also
	▲ Show 20 Lines • Show All 42 Lines • Show Last 20 Lines

llvm/docs/GettingStarted.rst

	Show First 20 Lines • Show All 577 Lines • ▼ Show 20 Lines
	links to bots that demonstrate the problem are sufficient.			links to bots that demonstrate the problem are sufficient.

	Local LLVM Configuration			Local LLVM Configuration
	------------------------			------------------------

	Once checked out repository, the LLVM suite source code must be configured			Once checked out repository, the LLVM suite source code must be configured
	before being built. This process uses CMake. Unlinke the normal ``configure``			before being built. This process uses CMake. Unlinke the normal ``configure``
	script, CMake generates the build files in whatever format you request as well			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			Variables are passed to ``cmake`` on the command line using the format
	``-D<variable name>=<value>``. The following variables are some common options			``-D<variable name>=<value>``. The following variables are some common options
	used by people developing LLVM.			used by people developing LLVM.

	+-------------------------+----------------------------------------------------+			+-------------------------+----------------------------------------------------+
	\| Variable \| Purpose \|			\| Variable \| Purpose \|
	+=========================+====================================================+			+=========================+====================================================+
	▲ Show 20 Lines • Show All 653 Lines • ▼ Show 20 Lines

	This document is just an introduction on how to use LLVM to do some simple			This document is just an introduction on how to use LLVM to do some simple
	things... there are many more interesting and complicated things that you can do			things... there are many more interesting and complicated things that you can do
	that aren't documented here (but we'll gladly accept a patch if you want to			that aren't documented here (but we'll gladly accept a patch if you want to
	write something up!). For more information about LLVM, check out:			write something up!). For more information about LLVM, check out:

	* `LLVM Homepage <https://llvm.org/>`_			* `LLVM Homepage <https://llvm.org/>`_
	* `LLVM Doxygen Tree <https://llvm.org/doxygen/>`_			* `LLVM Doxygen Tree <https://llvm.org/doxygen/>`_
	* `Starting a Project that Uses LLVM <https://llvm.org/docs/Projects.html>`_			* `Starting a Project that Uses LLVM <https://llvm.org/docs/Projects.html>`_
				jdoerfertUnsubmitted Not Done Reply Inline Actions We might want to keep some of the newlines. jdoerfert: We might want to keep some of the newlines.

This is an archive of the discontinued LLVM Phabricator instance.

[Docs][typo] Done the required fix for the #61690
ClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 511461

llvm/docs/CommandGuide/llvm-opt-report.rst

llvm/docs/GettingStarted.rst

This is an archive of the discontinued LLVM Phabricator instance.

[Docs][typo] Done the required fix for the #61690ClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 511461

llvm/docs/CommandGuide/llvm-opt-report.rst

llvm/docs/GettingStarted.rst

[Docs][typo] Done the required fix for the #61690
ClosedPublic