[llvm] [llvm][docs] Improve the formatting of the Common Problems section (PR #108522)
Tobias Hieta via llvm-commits
llvm-commits at lists.llvm.org
Mon Oct 7 02:40:57 PDT 2024
================
@@ -1085,67 +1085,88 @@ general questions about LLVM, please consult the `Frequently Asked
Questions <FAQ.html>`_ page.
If you are having problems with limited memory and build time, please try
-building with ninja instead of make. Please consider configuring the
+building with ``ninja`` instead of ``make``. Please consider configuring the
following options with cmake:
- * -G Ninja
+ * ``-G Ninja``
+
Setting this option will allow you to build with ninja instead of make.
Building with ninja significantly improves your build time, especially with
incremental builds, and improves your memory usage.
- * -DLLVM_USE_LINKER
- Setting this option to lld will significantly reduce linking time for LLVM
+ * ``-DLLVM_USE_LINKER``
+
+ Setting this option to ``lld`` will significantly reduce linking time for LLVM
executables on ELF-based platforms, such as Linux. If you are building LLVM
for the first time and lld is not available to you as a binary package, then
you may want to use the gold linker as a faster alternative to GNU ld.
- * -DCMAKE_BUILD_TYPE
+ * ``-DCMAKE_BUILD_TYPE``
+
Controls optimization level and debug information of the build. This setting
can affect RAM and disk usage, see :ref:`CMAKE_BUILD_TYPE <cmake_build_type>`
for more information.
- * -DLLVM_ENABLE_ASSERTIONS
- This option defaults to ON for Debug builds and defaults to OFF for Release
+ * ``-DLLVM_ENABLE_ASSERTIONS``
+
+ This option defaults to ``ON`` for Debug builds and defaults to ``OFF`` for Release
builds. As mentioned in the previous option, using the Release build type and
enabling assertions may be a good alternative to using the Debug build type.
- * -DLLVM_PARALLEL_LINK_JOBS
+ * ``-DLLVM_PARALLEL_LINK_JOBS``
+
Set this equal to number of jobs you wish to run simultaneously. This is
- similar to the -j option used with make, but only for link jobs. This option
+ similar to the ``-j`` option used with ``make``, but only for link jobs. This option
can only be used with ninja. You may wish to use a very low number of jobs,
as this will greatly reduce the amount of memory used during the build
- process. If you have limited memory, you may wish to set this to 1.
+ process. If you have limited memory, you may wish to set this to ``1``.
+
+ * ``-DLLVM_TARGETS_TO_BUILD``
- * -DLLVM_TARGETS_TO_BUILD
Set this equal to the target you wish to build. You may wish to set this to
- X86; however, you will find a full list of targets within the
- llvm-project/llvm/lib/Target directory.
+ only your host architecture. For example `X86` if you are using an AMD64 machine.
+ You will find a full list of targets within the
+ `llvm-project/llvm/lib/Target <https://github.com/llvm/llvm-project/tree/main/llvm/lib/Target>`_
+ directory.
+
+ * ``-DLLVM_OPTIMIZED_TABLEGEN``
- * -DLLVM_OPTIMIZED_TABLEGEN
- Set this to ON to generate a fully optimized tablegen during your build. This
+ Set this to ``ON`` to generate a fully optimized tablegen during your build. This
----------------
tru wrote:
Maybe we should reword this a bit to make it clear that it will build a release tablegen even in a debug build, which is not helpful when developing or debugging tablegen itself.
https://github.com/llvm/llvm-project/pull/108522
More information about the llvm-commits
mailing list