Skip to content

Commit 234b9f1

Browse files
add note about headergen needing pyyaml to fullbuild docs
1 parent 6089713 commit 234b9f1

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

libc/docs/dev/header_generation.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _header_generation:
2+
13
Generating Public and Internal headers
24
======================================
35

libc/docs/full_cross_build.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Full Cross Build
88
:depth: 1
99
:local:
1010

11+
.. note::
12+
Fullbuild requires running headergen, which is a python program that depends on
13+
pyyaml. The minimum versions are listed on the :ref:`header_generation`
14+
page, as well as additional information.
15+
1116
In this document, we will present recipes to cross build the full libc. When we
1217
say *cross build* a full libc, we mean that we will build the full libc for a
1318
target system which is not the same as the system on which the libc is being

libc/docs/full_host_build.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Full Host Build
88
:depth: 1
99
:local:
1010

11+
.. note::
12+
Fullbuild requires running headergen, which is a python program that depends on
13+
pyyaml. The minimum versions are listed on the :ref:`header_generation`
14+
page, as well as additional information.
15+
1116
In this document, we will present a recipe to build the full libc for the host.
1217
When we say *build the libc for the host*, the goal is to build the libc for
1318
the same system on which the libc is being built. First, we will explain how to

libc/docs/fullbuild_mode.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
Fullbuild Mode
55
==============
66

7+
.. note::
8+
Fullbuild requires running headergen, which is a python program that depends on
9+
pyyaml. The minimum versions are listed on the :ref:`header_generation`
10+
page, as well as additional information.
11+
712
The *fullbuild* mode of LLVM's libc is the mode in which it is to be used as
813
the only libc (as opposed to the :ref:`overlay_mode` in which it is used along
914
with the system libc.) In order to use it as the only libc, one will have to

0 commit comments

Comments
 (0)