[PATCH] D124367: [docs] Improve documentation around CMAKE_BUILD_TYPE

[James Henderson via Phabricator via llvm-commits]

jhenderson added inline comments.


================
Comment at: llvm/docs/CMake.rst:208
+    optimizations. Builds using ``Debug`` will be siginficantly slower and
+    use a lot more diskspace then a ``Release`` build. When targetting
+    Linux/ELF It's not uncommon that your linker might run into issues
----------------
tschuett wrote:
> 
I suspect RAM is the limiting factor for most users rather than disk space. I'd suggest mentioning that here too.


================
Comment at: llvm/docs/CMake.rst:209-210
+    use a lot more diskspace then a ``Release`` build. When targetting
+    Linux/ELF It's not uncommon that your linker might run into issues
+    when linking ``Debug`` builds. It's recommended that ``Debug`` build
+    are linked with ``lld``, see the ``LLVM_ENABLE_LLD`` option.
----------------
tschuett wrote:
> 
Let's be a bit more explicit by stating the sort of issues (i.e. OOM issues) when doing this build.


================
Comment at: llvm/docs/CMake.rst:222
+    in order to find a bug or problem. Size of binaries will be big and
+    linkers might have similar problems with this build as with ``Debug``.
+    These builds will default to disable assertions.
----------------



================
Comment at: llvm/docs/CMake.rst:223
+    linkers might have similar problems with this build as with ``Debug``.
+    These builds will default to disable assertions.
+
----------------
Here and possibly in a few other places, you've referred to builds in the plural, whereas usually you refer to it in the singular. I don't mind which, but you should be consistent at least.


================
Comment at: llvm/docs/GettingStarted.rst:77-78
+       of the build. Possible values are ``Release``, ``Debug``, ``MinSizeRel`` and
+       ``RelWithDebInfo``. The default value is ``Debug`` that fits people that want
+       to work on LLVM or with it's libraries. ``Release`` is a better fit for most
+       users of LLVM and Clang. For more detailed information see :ref:`CMAKE_BUILD_TYPE <cmake_build_type>`.
----------------
Do you mean "with it's libraries" i.e. someone who is developing a project using LLVM libraries? If not, it should be "or it's libraries".


================
Comment at: llvm/docs/GettingStarted.rst:1195
+      linking with debug info may consume a large amount of memory. This configuration
+      also consumes a lot more disk space, so if you have problems with how big
+      a build is, you should consider the ``Release`` type instead.
----------------



Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D124367/new/

https://reviews.llvm.org/D124367