Skip to content

Commit

Permalink
[libc][docs] stub out assert, errno, and locale (llvm#118852)
Browse files Browse the repository at this point in the history
[libc][docs] stub out assert, errno, and locale

These were the remaining c89 library headers (besides string.h and
stdlib.h; I
will split strings.rst in a follow up commit).

The macro support detection in docgen doesn't quite work for some of
these
headers. Add the stubs for these headers for now, and fix up docgen
later.

See the "NIST publication":
Link: https://www.open-std.org/jtc1/sc22/wg14/www/projects.html
  • Loading branch information
nickdesaulniers authored Dec 5, 2024
1 parent a9aff44 commit 7329086
Show file tree
Hide file tree
Showing 7 changed files with 184 additions and 0 deletions.
27 changes: 27 additions & 0 deletions libc/docs/headers/assert.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. include:: ../check.rst

========
assert.h
========

Macros
======

.. list-table::
:widths: auto
:align: center
:header-rows: 1

* - Macro
- Implemented
- C23 Standard Section
- POSIX.1-2024 Standard Section
* - __STDC_VERSION_ASSERT_H__
- |check|
- 7.2.1
-
* - assert
-
- 7.2.1
-

35 changes: 35 additions & 0 deletions libc/docs/headers/errno.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. include:: ../check.rst

=======
errno.h
=======

Macros
======

.. list-table::
:widths: auto
:align: center
:header-rows: 1

* - Macro
- Implemented
- C23 Standard Section
- POSIX.1-2024 Standard Section
* - EDOM
-
- 7.5
-
* - EILSEQ
-
- 7.5
-
* - ERANGE
-
- 7.5
-
* - errno
-
- 7.5
-

3 changes: 3 additions & 0 deletions libc/docs/headers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ Implementation Status
.. toctree::
:maxdepth: 1

assert
complex
ctype
errno
fenv
locale
math/index.rst
search
setjmp
Expand Down
63 changes: 63 additions & 0 deletions libc/docs/headers/locale.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
.. include:: ../check.rst

========
locale.h
========

Macros
======

.. list-table::
:widths: auto
:align: center
:header-rows: 1

* - Macro
- Implemented
- C23 Standard Section
- POSIX.1-2024 Standard Section
* - LC_ALL
- |check|
- 7.11
-
* - LC_COLLATE
- |check|
- 7.11
-
* - LC_CTYPE
- |check|
- 7.11
-
* - LC_MONETARY
- |check|
- 7.11
-
* - LC_NUMERIC
- |check|
- 7.11
-
* - LC_TIME
- |check|
- 7.11
-

Functions
=========

.. list-table::
:widths: auto
:align: center
:header-rows: 1

* - Function
- Implemented
- C23 Standard Section
- POSIX.1-2024 Standard Section
* - localeconv
- |check|
- 7.11.2.1
-
* - setlocale
- |check|
- 7.11.1.1
-
10 changes: 10 additions & 0 deletions libc/utils/docgen/assert.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"macros": {
"__STDC_VERSION_ASSERT_H__": {
"c-definition": "7.2.1"
},
"assert": {
"c-definition": "7.2.1"
}
}
}
16 changes: 16 additions & 0 deletions libc/utils/docgen/errno.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"macros": {
"EDOM": {
"c-definition": "7.5"
},
"EILSEQ": {
"c-definition": "7.5"
},
"ERANGE": {
"c-definition": "7.5"
},
"errno": {
"c-definition": "7.5"
}
}
}
30 changes: 30 additions & 0 deletions libc/utils/docgen/locale.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"macros": {
"LC_ALL": {
"c-definition": "7.11"
},
"LC_COLLATE": {
"c-definition": "7.11"
},
"LC_CTYPE": {
"c-definition": "7.11"
},
"LC_MONETARY": {
"c-definition": "7.11"
},
"LC_NUMERIC": {
"c-definition": "7.11"
},
"LC_TIME": {
"c-definition": "7.11"
}
},
"functions": {
"setlocale": {
"c-definition": "7.11.1.1"
},
"localeconv": {
"c-definition": "7.11.2.1"
}
}
}

0 comments on commit 7329086

Please sign in to comment.