Skip to content

[libc][docs] Update full host build docs #97643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 3, 2024
Merged

[libc][docs] Update full host build docs #97643

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7b2bec
[libc][docs] Update full host build docs
michaelrj-google Jul 3, 2024
4be5184
add todo
michaelrj-google Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions libc/docs/full_host_build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ we've set the Ninja generator, enabled a full compiler suite, set the build
type to "Debug", and enabled the Scudo allocator. The build also tells clang
to use the freshly built lld and compiler-rt.

.. note::
if your build fails with an error saying the compiler can't find
``<asm/unistd.h>`` or similar then you're probably missing the symlink from
``/usr/include/asm`` to ``/usr/include/<TARGET TRIPLE>/asm``. Installing the
``gcc-multilib`` package creates this symlink, or you can do it manually with
this command:
``sudo ln -s /usr/include/<TARGET TRIPLE>/asm /usr/include/asm``

.. code-block:: sh

$> cd llvm-project # The llvm-project checkout
Expand Down Expand Up @@ -76,6 +84,14 @@ above.
Build and install
=================

.. TODO: add this warning to the cmake
.. warning::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like we should add this warning message to our cmake.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a TODO

Running these install commands without setting a ``$SYSROOT`` will install
them into your system include path, which may break your system. If you're
just trying to develop libc, then just run ``ninja check-libc`` to build the
libc and run the tests. If you've already accidentally installed the headers,
you may need to delete them from ``/usr/local/include``.

After configuring the build with the above ``cmake`` command, one can build and
install the libc, clang (and its support libraries and builtins), lld and
compiler-rt, with the following command:
Expand Down
Loading