[PATCH] D75425: [docs] Added solutions to slow build under common problems

[Evan LeClercq via Phabricator via llvm-commits]

e-leclercq created this revision.
e-leclercq added a reviewer: Meinersbur.
Herald added a project: LLVM.

I added a list of options to configure should someone have issues with long build time or running out of memory. This was added under common problems in the getting started section of the documentation.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D75425

Files:
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -1098,6 +1098,35 @@
 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 configuring the following options:
+
+ * -DCMAKE_BUILD_TYPE  
+   Set this equal to the build you wish to use, either Debug or Release. The 
+   Debug build may consume more memory during the linking phase.
+
+ * -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.
+ 
+ * -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. 
+
+ * -DLLVM_OPTIMIZED_TABLEGEN  
+   Set this to ON to generate a fully optimized tablegen during build. This will 
+   significantly improve your build time.
+
+ * -DLLVM_ENABLE_PROJECTS  
+   Set this equal to the projects you wish to compile. If compiling more than one 
+   project, deliniate the list with a semicolon. Should you run into issues with 
+   the semicolon, surround it with single quotes.  
+ 
+ * -DCLANG_ENABLE_STATIC_ANALYZER  
+   Set this option to OFF if you do not require the STATIC_ANALYZER. This should 
+   improve your build time significantly.
+
+
 .. _links:
 
 Links


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D75425.247510.patch
Type: text/x-patch
Size: 1560 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200301/dda27cc4/attachment.bin>