Skip to content

Conversation

@StarOne01
Copy link
Contributor

These changes ensure that the termios header is documented properly with respect to the issue ( #122006 ) .

cc @nickdesaulniers

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

llvmbot commented Jan 15, 2025

@llvm/pr-subscribers-libc

Author: Prashanth (StarOne01)

Changes

These changes ensure that the termios header is documented properly with respect to the issue ( #122006 ) .

cc @nickdesaulniers


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

3 Files Affected:

  • (modified) libc/docs/CMakeLists.txt (+1)
  • (modified) libc/docs/headers/index.rst (+1)
  • (added) libc/utils/docgen/termios.yaml (+243)
diff --git a/libc/docs/CMakeLists.txt b/libc/docs/CMakeLists.txt
index fca8caec004f7d..f7015d73dd23fe 100644
--- a/libc/docs/CMakeLists.txt
+++ b/libc/docs/CMakeLists.txt
@@ -55,6 +55,7 @@ if (SPHINX_FOUND)
       strings
       sys/mman
       sys/resource
+      termios
       threads
       uchar
       wchar
diff --git a/libc/docs/headers/index.rst b/libc/docs/headers/index.rst
index 67325e40dcbbdd..19a48ca1b98a90 100644
--- a/libc/docs/headers/index.rst
+++ b/libc/docs/headers/index.rst
@@ -28,6 +28,7 @@ Implementation Status
    strings
    sys/mman
    sys/resource
+   termios
    threads
    time
    uchar
diff --git a/libc/utils/docgen/termios.yaml b/libc/utils/docgen/termios.yaml
new file mode 100644
index 00000000000000..81dd8da9f240cc
--- /dev/null
+++ b/libc/utils/docgen/termios.yaml
@@ -0,0 +1,243 @@
+macros:
+  NCCS:
+    in-latest-posix: ''
+
+  VEOF:
+    in-latest-posix: ''
+  VEOL:
+    in-latest-posix: ''
+  VERASE:
+    in-latest-posix: ''
+  VINTR:
+    in-latest-posix: ''
+  VKILL:
+    in-latest-posix: ''
+  VMIN:
+    in-latest-posix: ''
+  VQUIT:
+    in-latest-posix: ''
+  VSTART:
+    in-latest-posix: ''
+  VSTOP:
+    in-latest-posix: ''
+  VSUSP:
+    in-latest-posix: ''
+  VTIME:
+    in-latest-posix: ''
+
+  BRKINT:
+    in-latest-posix: ''
+  ICRNL:
+    in-latest-posix: ''
+  IGNBRK:
+    in-latest-posix: ''
+  IGNCR: 
+    in-latest-posix: ''
+  IGNPAR:
+    in-latest-posix: ''
+  INLCR:
+    in-latest-posix: ''
+  INPCK:
+    in-latest-posix: ''
+  ISTRIP:
+    in-latest-posix: ''
+  IXANY:
+    in-latest-posix: ''
+  IXOFF:
+    in-latest-posix: ''
+  IXON:
+    in-latest-posix: ''
+  PARMRK:
+    in-latest-posix: ''
+
+  OPOST:
+    in-latest-posix: ''
+  ONLCR:
+    in-latest-posix: ''
+  OCRNL:
+    in-latest-posix: ''
+  ONOCR:
+    in-latest-posix: ''
+  ONLRET:
+    in-latest-posix: ''
+  OFDEL:
+    in-latest-posix: ''
+  OFILL:
+    in-latest-posix: ''
+    
+  NLDLY:
+    in-latest-posix: ''
+  NL0:
+    in-latest-posix: ''
+  NL1:
+    in-latest-posix: ''
+
+  CRDLY:
+    in-latest-posix: ''
+  CR0:
+    in-latest-posix: ''
+  CR1:
+    in-latest-posix: ''
+  CR2:
+    in-latest-posix: ''
+  CR3:
+    in-latest-posix: ''
+
+  TABDLY:
+    in-latest-posix: ''
+  TAB0:
+    in-latest-posix: ''
+  TAB1:
+    in-latest-posix: ''
+  TAB2:
+    in-latest-posix: ''
+  TAB3:
+    in-latest-posix: ''
+
+  BSDLY:
+    in-latest-posix: ''
+  BS0:
+    in-latest-posix: ''
+  BS1:
+    in-latest-posix: ''
+
+  VTDLY:
+    in-latest-posix: ''
+  VT0:
+    in-latest-posix: ''
+  VT1:
+    in-latest-posix: ''
+
+  FFDLY:
+    in-latest-posix: ''
+  FF0:
+    in-latest-posix: ''
+  FF1:
+    in-latest-posix: ''
+
+  B0:
+    in-latest-posix: ''
+  B50:
+    in-latest-posix: ''
+  B75:
+    in-latest-posix: ''
+  B110:
+    in-latest-posix: ''
+  B134:
+    in-latest-posix: ''
+  B150:
+    in-latest-posix: ''
+  B200:
+    in-latest-posix: ''
+  B300:
+    in-latest-posix: ''
+  B600:
+    in-latest-posix: ''
+  B1200:
+    in-latest-posix: ''
+  B1800:
+    in-latest-posix: ''
+  B2400:
+    in-latest-posix: ''
+  B4800:  
+    in-latest-posix: ''
+  B9600:
+    in-latest-posix: ''
+  B19200:
+    in-latest-posix: ''
+  B38400:
+    in-latest-posix: ''
+
+  CSIZE:
+    in-latest-posix: ''
+  CS5:
+    in-latest-posix: ''
+  CS6:
+    in-latest-posix: ''
+  CS7:
+    in-latest-posix: ''
+  CS8:
+    in-latest-posix: ''
+
+  CSTOPB:
+    in-latest-posix: ''
+  CREAD:
+    in-latest-posix: ''
+  PARENB:
+    in-latest-posix: ''
+  PARODD:
+    in-latest-posix: ''
+  HUPCL:
+    in-latest-posix: ''
+  CLOCAL:
+    in-latest-posix: ''
+
+  ECHO:
+    in-latest-posix: ''
+  ECHOE:
+    in-latest-posix: ''
+  ECHOK:
+    in-latest-posix: ''
+  ECHONL:
+    in-latest-posix: ''
+  ICANON:
+    in-latest-posix: ''
+  IEXTEN:
+    in-latest-posix: ''
+  ISIG:
+    in-latest-posix: ''
+  NOFLSH:
+    in-latest-posix: ''
+  TOSTOP:
+    in-latest-posix: ''
+
+  TCSANOW:
+    in-latest-posix: ''
+  TCSADRAIN:
+    in-latest-posix: ''
+  TCSAFLUSH:
+    in-latest-posix: ''
+
+  TCIFLUSH:
+    in-latest-posix: ''
+  TCIOFLUSH:
+    in-latest-posix: ''
+  TCOFLUSH:
+    in-latest-posix: ''
+
+  TCIOFF:
+    in-latest-posix: ''
+  TCION:
+    in-latest-posix: ''
+  TCOOFF:
+    in-latest-posix: ''
+  TCOON:
+    in-latest-posix: ''
+
+functions:
+  cfgetispeed:
+    in-latest-posix: ''
+  cfgetospeed:
+    in-latest-posix: ''
+  cfsetispeed:
+    in-latest-posix: ''
+  cfsetospeed:
+    in-latest-posix: ''
+  tcdrain:
+    in-latest-posix: ''
+  tcflow:
+    in-latest-posix: ''
+  tcflush:
+    in-latest-posix: ''
+  tcgetattr:
+    in-latest-posix: ''
+  tcgetsid: 
+    in-latest-posix: ''
+  tcgetwinsize:
+    in-latest-posix: ''
+  tcsendbreak:
+    in-latest-posix: ''
+  tcsetattr: 
+    in-latest-posix: ''
+  tcsetwinsize:
+    in-latest-posix: ''
\ No newline at end of file

Copy link
Member

@nickdesaulniers nickdesaulniers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a lot of macros! I like how you break them up with vertical spacing; it makes it much easier to review. Thank you for the patch!

@nickdesaulniers nickdesaulniers merged commit d54d8d7 into llvm:main Jan 17, 2025
10 of 11 checks passed
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.

3 participants