[libc] Add documentation on hacking with vscode

Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D140826
This commit is contained in:
Jeff Bailey
2023-01-05 17:27:16 +00:00
parent b5b79e51b4
commit 6e5c35819e

View File

@@ -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 @@ The libc can be built and tested in two different 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
}
}