[libc-commits] [libc] 0ce61e4 - [libc] add doc for search.h (#80492)

[via libc-commits]

Author: Schrodinger ZHU Yifan
Date: 2024-02-02T18:55:00-05:00
New Revision: 0ce61e48ce0a2ca401599318401079e42ed5b0f9

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

LOG: [libc] add doc for search.h (#80492)

Added: 
    libc/docs/search.rst

Modified: 
    libc/docs/index.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/index.rst b/libc/docs/index.rst
index 2740e9152703b..0d72c1651457d 100644
--- a/libc/docs/index.rst
+++ b/libc/docs/index.rst
@@ -66,6 +66,7 @@ stages there is no ABI stability in any form.
    strings
    stdio
    stdbit
+   search
 
 .. toctree::
    :hidden:

diff  --git a/libc/docs/search.rst b/libc/docs/search.rst
new file mode 100644
index 0000000000000..4233bfa8a7197
--- /dev/null
+++ b/libc/docs/search.rst
@@ -0,0 +1,71 @@
+=============
+Search Tables
+=============
+
+.. include:: check.rst
+
+---------------
+Source Location
+---------------
+
+-   The main source for bitwise utility functions is located at:
+    ``libc/src/search``.
+
+-   Hashtable implementation is located at:
+    ``libc/src/__support/HashTable``.
+
+-   The tests are located at:
+    ``libc/test/src/search/``.
+
+---------------------
+Implementation Status
+---------------------
+
+POSIX Standard Types
+====================
+
+============================ =========
+Type Name                    Available
+============================ =========
+ACTION                       |check|
+ENTRY                        |check|
+VISIT                        
+============================ =========
+
+POSIX Standard Functions
+========================
+
+============================ =========
+Function Name                Available
+============================ =========
+hcreate                      |check|
+hdestroy                     |check|
+hsearch                      |check|
+insque                       
+lfind                        
+lsearch                      
+remque
+tdelete
+tfind
+tsearch
+twalk
+============================ =========
+
+
+GNU Extension Functions
+=======================
+
+=========================  =========
+Function Name              Available
+=========================  =========
+hsearch_r                  |check|
+hcreate_r                  |check|
+hdestroy_r                 |check|
+tdestroy
+twalk_r
+=========================  =========
+
+
+Standards
+=========
+search.h is specified in POSIX.1-200x (Portable Operating System Interface, Volume1: Base Specifications).