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

[Michael Jones via libc-commits]

https://github.com/michaelrj-google created https://github.com/llvm/llvm-project/pull/121974

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


>From 00cdc7b58529f4b228064d85f9f901709d1208aa Mon Sep 17 00:00:00 2001
From: Michael Jones <michaelrj at google.com>
Date: Tue, 7 Jan 2025 10:18:31 -0800
Subject: [PATCH] [libc] clean up the hdrgen docs a bit

Since the files have been reorganized, the readme is out of date. This
patch updates it to be more accurate.
---
 libc/utils/hdrgen/README.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

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.