Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

StarOne01
Copy link

@StarOne01 StarOne01 commented Jan 10, 2025

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.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the libc label Jan 10, 2025
@llvmbot
Copy link
Member

llvmbot commented Jan 10, 2025

@llvm/pr-subscribers-libc

Author: Prashanth (StarOne01)

Changes

This pull request introduces the following changes to the project:

  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.

Full diff: https://github.com/llvm/llvm-project/pull/122406.diff

3 Files Affected:

  • (modified) libc/docs/CMakeLists.txt (+2)
  • (modified) libc/docs/headers/index.rst (+1)
  • (added) libc/utils/docgen/net/if.yaml (+13)
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index 5a3f8275bb932e..a21d8e563626c5 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -19,6 +19,7 @@ if (SPHINX_FOUND)
     file(MAKE_DIRECTORY
       "${CMAKE_CURRENT_BINARY_DIR}/headers/arpa/"
       "${CMAKE_CURRENT_BINARY_DIR}/headers/sys/"
+      "${CMAKE_CURRENT_BINARY_DIR}/headers/net/"
     )
 
     # Change sphinx to build from $build_dir/libc/docs/ rather than
@@ -40,6 +41,7 @@ if (SPHINX_FOUND)
       float
       inttypes
       locale
+      net/if
       setjmp
       signal
       stdbit
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 07ab6dd9b26742..b78ae86e968d9a 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -14,6 +14,7 @@ Implementation Status
    inttypes
    locale
    math/index.rst
+   net/if
    search
    setjmp
    signal
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

@StarOne01 StarOne01 changed the title [libc][docs] Add net/if.h documentation by to referring POSIX standard [libc][docs] Add net/if.h documentation by referring to POSIX standards Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants