Skip to content

Commit 0ce61e4

Browse files
[libc] add doc for search.h (llvm#80492)
1 parent 5eae095 commit 0ce61e4

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

libc/docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ stages there is no ABI stability in any form.
6666
strings
6767
stdio
6868
stdbit
69+
search
6970

7071
.. toctree::
7172
:hidden:

libc/docs/search.rst

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
=============
2+
Search Tables
3+
=============
4+
5+
.. include:: check.rst
6+
7+
---------------
8+
Source Location
9+
---------------
10+
11+
- The main source for bitwise utility functions is located at:
12+
``libc/src/search``.
13+
14+
- Hashtable implementation is located at:
15+
``libc/src/__support/HashTable``.
16+
17+
- The tests are located at:
18+
``libc/test/src/search/``.
19+
20+
---------------------
21+
Implementation Status
22+
---------------------
23+
24+
POSIX Standard Types
25+
====================
26+
27+
============================ =========
28+
Type Name Available
29+
============================ =========
30+
ACTION |check|
31+
ENTRY |check|
32+
VISIT
33+
============================ =========
34+
35+
POSIX Standard Functions
36+
========================
37+
38+
============================ =========
39+
Function Name Available
40+
============================ =========
41+
hcreate |check|
42+
hdestroy |check|
43+
hsearch |check|
44+
insque
45+
lfind
46+
lsearch
47+
remque
48+
tdelete
49+
tfind
50+
tsearch
51+
twalk
52+
============================ =========
53+
54+
55+
GNU Extension Functions
56+
=======================
57+
58+
========================= =========
59+
Function Name Available
60+
========================= =========
61+
hsearch_r |check|
62+
hcreate_r |check|
63+
hdestroy_r |check|
64+
tdestroy
65+
twalk_r
66+
========================= =========
67+
68+
69+
Standards
70+
=========
71+
search.h is specified in POSIX.1-200x (Portable Operating System Interface, Volume1: Base Specifications).

0 commit comments

Comments
 (0)