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

[via libc-commits]

Author: Michael Jones
Date: 2025-01-07T16:29:01-08:00
New Revision: ca3fd633691b20d780fa3a54b22abc09860e59d9

URL: https://github.com/llvm/llvm-project/commit/ca3fd633691b20d780fa3a54b22abc09860e59d9
DIFF: https://github.com/llvm/llvm-project/commit/ca3fd633691b20d780fa3a54b22abc09860e59d9.diff

LOG: [libc] clean up the hdrgen docs a bit (#121974)

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

Added: 
    

Modified: 
    libc/utils/hdrgen/README.rst

Removed: 
    


################################################################################
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.