[libc-commits] [libc] 0afee85 - [libc][docs] Add net/if.h documentation by referring to POSIX standards (#122406)

[via libc-commits]

Author: Prashanth
Date: 2025-01-10T09:27:40-08:00
New Revision: 0afee850de1ebe9af71bdf727d906fefa78ad68c

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

LOG: [libc][docs] Add net/if.h documentation by referring to POSIX standards (#122406)

This pull request introduces the following changes to the project with
reference to issue ( #122006 ):

1. **Documentation Update**:
- Added a new YAML file `if.yaml` under `net` to document network
interface functions and macros.
   - The `if.yaml` file includes the following functions and macros:
     - Functions:
       - `if_freenameindex`
       - `if_indextoname`
       - `if_nameindex`
       - `if_nametoindex`
     - Macros:
       - `IF_NAMESIZE`

2. **CMake Configuration Update**:
- Updated the `CMakeLists.txt` file to create the necessary directory
for the `net` headers.
- Included the `net/if` documentation in the Sphinx build configuration.

3. **Index Update**:
- Updated the `index.rst` file to include a reference to the newly added
`net/if` documentation.

**Purpose**:
- This pull request adds documentation for network interface functions
and macros, ensuring they are included in the project's documentation.
- Updates the CMake configuration to support the new documentation.

**Testing**:
- Verified that the new YAML file is correctly referenced in the
`index.rst`.
- Ensured that the documentation builds without errors and includes the
new network interface documentation.

Co-authored-by: Nick Desaulniers <ndesaulniers at google.com>

Added: 
    libc/utils/docgen/net/if.yaml

Modified: 
    libc/docs/CMakeLists.txt
    libc/docs/headers/index.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 9ab1d90a682ec6..4fa621fb2a0510 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -18,6 +18,7 @@ if (SPHINX_FOUND)
     # shell.
     file(MAKE_DIRECTORY
       "${CMAKE_CURRENT_BINARY_DIR}/headers/arpa/"
+      "${CMAKE_CURRENT_BINARY_DIR}/headers/net/"
       "${CMAKE_CURRENT_BINARY_DIR}/headers/netinet/"
       "${CMAKE_CURRENT_BINARY_DIR}/headers/sys/"
     )
@@ -42,6 +43,7 @@ if (SPHINX_FOUND)
       float
       inttypes
       locale
+      net/if
       netinet/in
       setjmp
       signal

diff  --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index f6f62826600c82..2295a8cc8853cd 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -15,6 +15,7 @@ Implementation Status
    inttypes
    locale
    math/index.rst
+   net/if
    netinet/in
    search
    setjmp

diff  --git a/libc/utils/docgen/net/if.yaml b/libc/utils/docgen/net/if.yaml
new file mode 100644
index 00000000000000..085d27b2bb94fa
--- /dev/null
+++ b/libc/utils/docgen/net/if.yaml
@@ -0,0 +1,13 @@
+functions:
+  if_freenameindex:
+    in-latest-posix: ''
+  if_indextoname:
+    in-latest-posix: ''
+  if_nameindex:
+    in-latest-posix: ''
+  if_nametoindex:
+    in-latest-posix: ''
+
+macros:
+  IF_NAMESIZE:
+    in-latest-posix: ''
\ No newline at end of file