[libc-commits] [PATCH] D140826: [libc] Add documentation on hacking with vscode

[Jeff Bailey via Phabricator via libc-commits]

jeffbailey created this revision.
Herald added subscribers: libc-commits, ecnelises, tschuett.
Herald added projects: libc-project, All.
jeffbailey requested review of this revision.

Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D140826

Files:
  libc/docs/build_and_test.rst


Index: libc/docs/build_and_test.rst
===================================================================
--- libc/docs/build_and_test.rst
+++ 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 different modes:
 
 #. **The overlay mode** - In this mode, one uses the static archive from LLVM's
@@ -41,3 +44,21 @@
       .. 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
+     }
+   }


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D140826.485816.patch
Type: text/x-patch
Size: 980 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libc-commits/attachments/20230101/c27750fc/attachment.bin>