[libc-commits] [libc] [libc] clean up the hdrgen docs a bit (PR #121974)

via libc-commits libc-commits at lists.llvm.org
Tue Jan 7 10:20:10 PST 2025


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-libc

Author: Michael Jones (michaelrj-google)

<details>
<summary>Changes</summary>

Since the files have been reorganized, the readme is out of date. This
patch updates it to be more accurate.


---
Full diff: https://github.com/llvm/llvm-project/pull/121974.diff


1 Files Affected:

- (modified) libc/utils/hdrgen/README.rst (+4-5) 


``````````diff
diff --git a/libc/utils/hdrgen/README.rst b/libc/utils/hdrgen/README.rst
index d16e6c5ccaec1d..6db2968d1e61ba 100644
--- a/libc/utils/hdrgen/README.rst
+++ b/libc/utils/hdrgen/README.rst
@@ -1,5 +1,4 @@
-This directory contains the sources and specifications for the types,
-macros and entrypoint functions.  These definitions are organized in the
-``yaml`` subdirectory and match the organization of the ``*.h.def``
-files. This directory also contains the Python sources for hdrgen, which is
-what generates the headers.
+This directory also contains the Python sources for hdrgen, which is
+what generates the headers public libc headers. The definitions for these
+headers are in the ``include`` directory. The ``.h.def`` files are the bases
+and the ``.yaml`` files are the contents.

``````````

</details>


https://github.com/llvm/llvm-project/pull/121974


More information about the libc-commits mailing list