[libc-commits] [PATCH] D74502: [libc] Add a README to the sub-directories under the utils directory.

[Siva Chandra via Phabricator via libc-commits]

sivachandra created this revision.
sivachandra added a reviewer: PaulkaToast.
Herald added subscribers: libc-commits, tschuett, MaskRay.
Herald added a project: libc-project.

Also, the source layout document has been updated to reflect the current
layout of the `utils` directory.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D74502

Files:
  libc/docs/source_layout.rst
  libc/utils/CPP/README.md
  libc/utils/HdrGen/README.md
  libc/utils/UnitTest/README.md


Index: libc/utils/UnitTest/README.md
===================================================================
--- /dev/null
+++ libc/utils/UnitTest/README.md
@@ -0,0 +1,23 @@
+# The LLVM libc unit test framework
+
+This directory contains a lightweight implementation of a
+[gtest](https://github.com/google/googletest) like unit test framework for LLVM
+libc.
+
+## Why not gtest?
+
+While gtest is great, featureful and time tested, it uses the C and C++
+standard libraries. Hence, using it to test LLVM libc (which is also an
+implementation of the C standard libraries) causes various kinds of
+mixup/conflict problems.
+
+## How is it different from gtest?
+
+LLVM libc's unit test framework is much less featureful as compared to gtest.
+But, what is available strives to be exactly like gtest.
+
+## Will it be made as featurful as gtest in future?
+
+It is not clear if LLVM libc needs/will need every feature of gtest. We only
+intend to extended it on an _as needed_ basis. Hence, it might never be as
+featureful as gtest.
Index: libc/utils/HdrGen/README.md
===================================================================
--- /dev/null
+++ libc/utils/HdrGen/README.md
@@ -0,0 +1,6 @@
+# The LLVM libc header generation system
+
+LLVM libc uses a header generation scheme to generate public as well as internal
+header files. This directory contains the implementation of the header generator
+which drives this header generation scheme.
+
Index: libc/utils/CPP/README.md
===================================================================
--- libc/utils/CPP/README.md
+++ libc/utils/CPP/README.md
@@ -1,7 +1,9 @@
-This directory contains re-implementations of some C++ standard library as well
-as some LLVM utilities. These are to be used with internal LLVM libc code and
-tests. More utilities will be added on an as needed basis. There are certain
-rules to be followed for future changes and additions:
+This directory contains a re-implementations of some C++ standard library, as
+well as some LLVM utilities. These utilities are for use with internal LLVM libc
+code and tests.
+
+More utilities will be added on an as needed basis. There are certain rules to
+be followed for future changes and additions:
 
 1. Only two kind of headers can be included: Other headers from this directory,
 and free standing C headers.
Index: libc/docs/source_layout.rst
===================================================================
--- libc/docs/source_layout.rst
+++ libc/docs/source_layout.rst
@@ -12,9 +12,7 @@
         - loader
         - src
         - test
-        + utils
-            - build_scripts
-            - testing
+        - utils
         - www
 
 Each of these directories is explained in detail below.
@@ -79,17 +77,15 @@
 in the directory ``test/src/sys/mman/`` as implementation of ``mmap`` lives in
 ``src/sys/mman``.
 
-The ``www`` directory
+The `utils` directory
 ---------------------
 
-The ``www`` directory contains the HTML content of libc.llvm.org
-
-The ``utils/build_scripts`` directory
--------------------------------------
+This directory contains utilities used by other parts of the llvm-libc system.
+See the `README` files, in the sub-directories within this directory, to learn
+about the various utilities.
 
-This directory contains scripts which support the build system, tooling etc.
+The ``www`` directory
+---------------------
 
-The ``utils/testing`` directory
--------------------------------
+The ``www`` directory contains the HTML content of libc.llvm.org
 
-This directory contains testing infrastructure.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D74502.244257.patch
Type: text/x-patch
Size: 3571 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libc-commits/attachments/20200212/91990b45/attachment.bin>