[libc-commits] [libc] 6e5c358 - [libc] Add documentation on hacking with vscode

[Jeff Bailey via libc-commits]

Author: Jeff Bailey
Date: 2023-01-05T17:27:32Z
New Revision: 6e5c35819e318370d7c3d06d1b4392c0f0d79f92

URL: https://github.com/llvm/llvm-project/commit/6e5c35819e318370d7c3d06d1b4392c0f0d79f92
DIFF: https://github.com/llvm/llvm-project/commit/6e5c35819e318370d7c3d06d1b4392c0f0d79f92.diff

LOG: [libc] Add documentation on hacking with vscode

Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D140826

Added: 
    

Modified: 
    libc/docs/build_and_test.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/build_and_test.rst b/libc/docs/build_and_test.rst
index 423481ecc3a59..22557001568b1 100644
--- a/libc/docs/build_and_test.rst
+++ b/libc/docs/build_and_test.rst
@@ -4,6 +4,9 @@
 Building and Testing the libc
 =============================
 
+Build modes
+===========
+
 The libc can be built and tested in two 
diff erent modes:
 
 #. **The overlay mode** - In this mode, one uses the static archive from LLVM's
@@ -41,3 +44,21 @@ The libc can be built and tested in two 
diff erent modes:
       .. code-block:: sh
 
         $> ninja libc-api-test
+
+Building with VSCode
+====================
+
+As a quickstart to using VSCode for development, install the cmake extension
+and put the following in your settings.json file:
+
+.. code-block:: javascript
+
+   {
+     "cmake.sourceDirectory": "${workspaceFolder}/llvm",
+     "cmake.configureSettings": {
+         "LLVM_ENABLE_PROJECTS" : "libc",
+         "LLVM_LIBC_FULL_BUILD" : true,
+         "LLVM_ENABLE_SPHINX" : true,
+         "LIBC_INCLUDE_DOCS" : true
+     }
+   }