Skip to content

Commit 8c47e59

Browse files
author
Alexey Samsonov
committed
Update hdrgen documentation to reflect moved files.
1 parent 905b110 commit 8c47e59

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

libc/docs/dev/header_generation.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To add through the command line:
6363
examine.
6464

6565
If you want to sort the functions alphabetically you can check out
66-
libc/utils/hdrgen/yaml_functions_sorted.py.
66+
``libc/utils/hdrgen/hdrgen/yaml_functions_sorted.py``.
6767

6868

6969
Testing
@@ -90,7 +90,7 @@ Common Errors
9090

9191
.. code-block:: none
9292
93-
"/llvm-project/libc/utils/hdrgen/yaml_to_classes.py", line 67, in yaml_to_classes function_data["return_type"]
93+
"/llvm-project/libc/utils/hdrgen/hdrgen/yaml_to_classes.py", line 67, in yaml_to_classes function_data["return_type"]
9494
9595
If you receive this error or any error pertaining to
9696
``function_data[function_specific_component]`` while building the headers
@@ -107,9 +107,9 @@ Common Errors
107107
108108
CMake Error at:
109109
/llvm-project/libc/cmake/modules/LLVMLibCHeaderRules.cmake:86 (message):
110-
'add_gen_hdr2' rule requires GEN_HDR to be specified.
110+
'add_gen_hdr' rule requires GEN_HDR to be specified.
111111
Call Stack (most recent call first):
112-
/llvm-project/libc/include/CMakeLists.txt:22 (add_gen_header2)
112+
/llvm-project/libc/include/CMakeLists.txt:22 (add_gen_header)
113113
/llvm-project/libc/include/CMakeLists.txt:62 (add_header_macro)
114114
115115
If you receive this error, there is a missing YAML file, h_def file, or
@@ -119,7 +119,6 @@ Common Errors
119119

120120
| ``[header_name]``
121121
| ``[../libc/include/[yaml_file.yaml]``
122-
| ``[header_name.h.def]``
123122
| ``[header_name.h]``
124123
| ``DEPENDS``
125124
| ``{Necessary Depend Files}``
@@ -148,13 +147,13 @@ Common Errors
148147

149148
.. code-block:: none
150149
151-
File "/llvm-project/libc/utils/hdrgen/header.py", line 60, in __str__ for
150+
File "/llvm-project/libc/utils/hdrgen/hdrgen/header.py", line 60, in __str__ for
152151
function in self.functions: AttributeError: 'HeaderFile' object has no
153152
attribute 'functions'
154153
155154
When running ``ninja libc`` in the build directory to generate headers you
156155
may receive the error above. Essentially this means that in
157-
``libc/utils/hdrgen/header.py`` there is a missing attribute named functions.
156+
``libc/utils/hdrgen/hgrgen/header.py`` there is a missing attribute named functions.
158157
Make sure all function components are defined within this file and there are
159158
no missing functions to add these components.
160159

0 commit comments

Comments
 (0)