[libc-commits] [PATCH] D123761: [libc] Add a doc describing the current status of libc runtimes build.

[Siva Chandra via Phabricator via libc-commits]

sivachandra created this revision.
sivachandra added reviewers: jeffbailey, lntue, michaelrj.
Herald added a reviewer: alexander-shaposhnikov.
Herald added subscribers: libc-commits, ecnelises, tschuett, arphaman.
Herald added projects: libc-project, All.
sivachandra requested review of this revision.

A section briefly mentioning the planned future enhancements has also
been included.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D123761

Files:
  libc/docs/index.rst
  libc/docs/runtimes_build.rst


Index: libc/docs/runtimes_build.rst
===================================================================
--- /dev/null
+++ libc/docs/runtimes_build.rst
@@ -0,0 +1,36 @@
+Building libc using the runtimes build setup
+============================================
+
+The runtimes build of the LLVM toolchain first builds clang and then builds the
+various runtimes (like ``libc++`` and ``compiler-rt``) and LLVM binutils (like
+``llvm-objcopy`` and ``llvm-readelf``) using the freshly built clang. One can
+build libc also as in the same manner. As of this writing, only the ABI agnostic
+parts of the libc are included when built in that manner. This allows interested
+users to continue using their system libc's headers while linking to LLVM libc's
+implementations when they are available. To build libc using the runtimes build
+setup, one needs to include the ``libc`` project in the list of the enabled
+runtimes when configuring the build:
+
+.. code-block:: shell
+
+   $> cmake ../llvm -GNinja -DLLVM_ENABLE_PROJECTS="llvm;clang" \
+      -DLLVM_ENABLE_RUNTIMES=libc
+
+Note that Ninja is used as the generator in the above CMake command. Hence, to
+actually build the libc, one has to build the target named ``llvmlibc``:
+
+.. code-block:: shell
+
+   $> ninja llvmlibc
+
+If a different generator is used, then the build command should be suitably
+adapted to build the target ``llvmlibc``. Building that target will produce a
+static archive which includes all ABI agnostic functions available in LLVM libc.
+
+Future direction
+----------------
+
+We plan to enhance the runtimes build of LLVM libc to include ABI sensitive
+parts and to also generate the public headers. Likewise, we would like to
+provide an option to build other runtimes like ``libc++`` and ``compiler-rt``
+against LLVM libc.
Index: libc/docs/index.rst
===================================================================
--- libc/docs/index.rst
+++ libc/docs/index.rst
@@ -82,3 +82,4 @@
     mechanics_of_public_api
     redirectors
     source_layout
+    runtimes_build


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D123761.422750.patch
Type: text/x-patch
Size: 2055 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libc-commits/attachments/20220414/7f71d77e/attachment-0001.bin>