Skip to content

Commit f08dbe3

Browse files
committed
docs: Add acronym and glossary entries for I/O and AIO
These are fairly basic, but better than nothing. While there are several opportunities to link to these entries, this patch does not add any. They will however be referenced by future patches. Reviewed-by: Noah Misch <noah@leadboat.com> Discussion: https://postgr.es/m/20250326183102.92.nmisch@google.com
1 parent 2fd3e2f commit f08dbe3

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

doc/src/sgml/acronyms.sgml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@
99

1010
<variablelist>
1111

12+
<varlistentry>
13+
<term><acronym>AIO</acronym></term>
14+
<listitem>
15+
<para>
16+
<link linkend="glossary-aio">Asynchronous <acronym>I/O</acronym></link>
17+
</para>
18+
</listitem>
19+
</varlistentry>
20+
1221
<varlistentry>
1322
<term><acronym>ACL</acronym></term>
1423
<listitem>
@@ -354,6 +363,15 @@
354363
</listitem>
355364
</varlistentry>
356365

366+
<varlistentry>
367+
<term><acronym>I/O</acronym></term>
368+
<listitem>
369+
<para>
370+
<link linkend="glossary-io">Input/Output</link>
371+
</para>
372+
</listitem>
373+
</varlistentry>
374+
357375
<varlistentry>
358376
<term><acronym>ISO</acronym></term>
359377
<listitem>

doc/src/sgml/glossary.sgml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,31 @@
8181
</glossdef>
8282
</glossentry>
8383

84+
<glossentry id="glossary-aio">
85+
<glossterm>Asynchronous <acronym>I/O</acronym></glossterm>
86+
<acronym>AIO</acronym>
87+
<indexterm>
88+
<primary>Asynchronous <acronym>I/O</acronym></primary>
89+
</indexterm>
90+
<glossdef>
91+
<para>
92+
Asynchronous <acronym>I/O</acronym> (<acronym>AIO</acronym>) describes
93+
performing <acronym>I/O</acronym> in a non-blocking way (asynchronously),
94+
in contrast to synchronous <acronym>I/O</acronym>, which blocks for the
95+
entire duration of the <acronym>I/O</acronym>.
96+
</para>
97+
<para>
98+
With <acronym>AIO</acronym>, starting an <acronym>I/O</acronym> operation
99+
is separated from waiting for the result of the operation, allowing
100+
multiple <acronym>I/O</acronym> operations to be initiated concurrently,
101+
as well as performing <acronym>CPU</acronym> heavy operations
102+
concurrently with <acronym>I/O</acronym>. The price for that increased
103+
concurrency is increased complexity.
104+
</para>
105+
<glossseealso otherterm="glossary-io" />
106+
</glossdef>
107+
</glossentry>
108+
84109
<glossentry id="glossary-atomic">
85110
<glossterm>Atomic</glossterm>
86111
<glossdef>
@@ -938,6 +963,20 @@
938963
</glossdef>
939964
</glossentry>
940965

966+
<glossentry id="glossary-io">
967+
<glossterm>Input/Output</glossterm>
968+
<acronym>I/O</acronym>
969+
<glossdef>
970+
<para>
971+
Input/Output (<acronym>I/O</acronym>) describes the communication between
972+
a program and peripheral devices. In the context of database systems,
973+
<acronym>I/O</acronym> commonly, but not exclusively, refers to
974+
interaction with storage devices or the network.
975+
</para>
976+
<glossseealso otherterm="glossary-aio" />
977+
</glossdef>
978+
</glossentry>
979+
941980
<glossentry id="glossary-insert">
942981
<glossterm>Insert</glossterm>
943982
<glossdef>

0 commit comments

Comments
 (0)