Skip to content

Commit

Permalink
[libc] Add documentation on hacking with vscode
Browse files Browse the repository at this point in the history
Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D140826
  • Loading branch information
kaladron committed Jan 5, 2023
1 parent b5b79e5 commit 6e5c358
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions libc/docs/build_and_test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
}
}

0 comments on commit 6e5c358

Please sign in to comment.