gre-ilya/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Add textual images into libuv man page (#4709)

Browse Source 
Replaces `[image]` tags in libuv manual page with a textual
representation of the graphical image.

In addition added alternative-text for graphical deliverables.

Fixes: https://github.com/libuv/libuv/issues/4708
This commit is contained in:
Stacey Marshall 2026-03-17 01:53:03 +00:00 committed by GitHub
parent f4363aeb44
commit f600f7180a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 79 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Makefile
View File

@ -17,7 +17,9 @@ endif
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) FORM = -t Graphical
man: FORM = -t Textual
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(FORM) $(SPHINXOPTS) $(SRCDIR)
# the i18n builder cannot share the environment and doctrees with the others # the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR) I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)

24
docs/src/design.rst
View File

@ -16,10 +16,16 @@ cross-platform file I/O and threading functionality is also provided, amongst ot
Here is a diagram illustrating the different parts that compose libuv and what subsystem they Here is a diagram illustrating the different parts that compose libuv and what subsystem they
relate to: relate to:
.. image:: static/architecture.png .. only:: Graphical
:scale: 75%
:align: center
.. image:: static/architecture.png
:scale: 75%
:align: center
:alt: Picture of libuv architecture
.. only:: Textual
.. literalinclude:: static/architecture.txt
Handles and requests Handles and requests
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -80,10 +86,16 @@ which have been added to the poller and callbacks will be fired indicating socke
In order to better understand how the event loop operates, the following diagram illustrates all In order to better understand how the event loop operates, the following diagram illustrates all
stages of a loop iteration: stages of a loop iteration:
.. image:: static/loop_iteration.png .. only:: Graphical
:scale: 75%
:align: center
.. image:: static/loop_iteration.png
:scale: 75%
:align: center
:alt: Picture of libuv loop iteration
.. only:: Textual
.. literalinclude:: static/loop_iteration.txt
#. The loop concept of 'now' is initially set. #. The loop concept of 'now' is initially set.

23
docs/src/static/architecture.txt Normal file
View File

@ -0,0 +1,23 @@
LIBUV
+----------------------------------------------+ +---+ +---+ +---+
| | | | | | | |
| Network I/O | | F | | D | | U |
| | | i | | N | | s |
| | | l | | S | | e |
| | | e | | | | r |
| | | | | O | | |
| | | I | | p | | C |
| +------+ +------+ +------+ +------+ +------+ | | / | | s | | o |
| | TCP | | UDP | | TTY | | Pipe | | ... | | | O | | | | d |
| +------+ +------+ +------+ +------+ +------+ | | | | | | e |
| | | | | | | |
+----------------------------------------------+ +---+ +---+ +---+
+----------------------------------+ +--------+ +---------------+
| uv__io_t | | | | |
+----------------------------------+ | | | |
| IOCP | | Thread Pool |
+-------+ +--------+ +-------------+ | | | |
| epoll | | kqueue | | event ports | | | | |
+-------+ +--------+ +-------------+ +--------+ +---------------+

35
docs/src/static/loop_iteration.txt Normal file
View File

@ -0,0 +1,35 @@
+------------------------+
| Initialze loop time |
+------------------------+
| Run due timers |
+------------------------+
|
v
__
_____ / \
/ \ / \
/ \ No / Loop \
| end |<-------| alive? |<----------+
\ / \ / |
\ / \ / |
----- \__/ |
| |
| Yes |
v |
+------------------------+ |
| Call pending callbacks | |
+------------------------+ |
| Run idle handles | |
+------------------------+ |
| Run prepare handles | |
+------------------------+ |
| Poll for I/O | |
+------------------------+ |
| Run check handles | |
+------------------------+ |
| Call close callbacks | |
+------------------------+ |
| Update loop time | |
+------------------------+ |
| Run due timers |---+
+------------------------+