Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 919c486

Browse files
committed
doc: New glossary entries
Add: - "Restartpoint" - "Log sequence number" "LSN" was already listed in the Acronyms appendix, but it is more suitable as a glossary entry, so move it there and have the acronyms entry link into the glossary. Also turn on DocBook parameter glossentry.show.acronym to show acronyms for glossary entries, which is being used here. Reviewed-by: Daniel Gustafsson <daniel@yesql.se> Reviewed-by: Alvaro Herrera <alvherre@alvh.no-ip.org> Discussion: https://www.postgresql.org/message-id/flat/60915312-62cd-9c94-0d94-556023ece45f%40enterprisedb.com
1 parent a6e04b1 commit 919c486

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

doc/src/sgml/acronyms.sgml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,8 +402,7 @@
402402
<term><acronym>LSN</acronym></term>
403403
<listitem>
404404
<para>
405-
Log Sequence Number, see <link linkend="datatype-pg-lsn"><type>pg_lsn</type></link>
406-
and <link linkend="wal-internals">WAL Internals</link>.
405+
<glossterm linkend="glossary-log-sequence-number">Log Sequence Number</glossterm>
407406
</para>
408407
</listitem>
409408
</varlistentry>

doc/src/sgml/glossary.sgml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1039,6 +1039,28 @@
10391039
</glossdef>
10401040
</glossentry>
10411041

1042+
<glossentry id="glossary-log-sequence-number">
1043+
<glossterm>Log sequence number</glossterm>
1044+
<acronym>LSN</acronym>
1045+
<glossdef>
1046+
<para>
1047+
Byte offset into the <glossterm linkend="glossary-wal">WAL</glossterm>,
1048+
increasing monotonically with each new <glossterm
1049+
linkend="glossary-wal-record">WAL record</glossterm>.
1050+
</para>
1051+
<para>
1052+
For more information, see <link
1053+
linkend="datatype-pg-lsn"><type>pg_lsn</type></link> and <xref
1054+
linkend="wal-internals"/>.
1055+
</para>
1056+
</glossdef>
1057+
</glossentry>
1058+
1059+
<glossentry>
1060+
<glossterm>LSN</glossterm>
1061+
<glosssee otherterm="glossary-log-sequence-number"/>
1062+
</glossentry>
1063+
10421064
<glossentry>
10431065
<glossterm>Master (server)</glossterm>
10441066
<glosssee otherterm="glossary-primary-server" />
@@ -1342,6 +1364,20 @@
13421364
</glossdef>
13431365
</glossentry>
13441366

1367+
<glossentry id="glossary-restartpoint">
1368+
<glossterm>Restartpoint</glossterm>
1369+
<glossdef>
1370+
<para>
1371+
A variant of a <glossterm
1372+
linkend="glossary-checkpoint">checkpoint</glossterm> performed on a
1373+
<glossterm linkend="glossary-replica">replica</glossterm>.
1374+
</para>
1375+
<para>
1376+
For more information, see <xref linkend="wal-configuration"/>.
1377+
</para>
1378+
</glossdef>
1379+
</glossentry>
1380+
13451381
<glossentry id="glossary-result-set">
13461382
<glossterm>Result set</glossterm>
13471383
<glossdef>

doc/src/sgml/stylesheet-common.xsl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
</xsl:param>
2929

3030
<xsl:param name="callout.graphics" select="'0'"></xsl:param>
31+
<xsl:param name="glossentry.show.acronym">yes</xsl:param>
3132
<xsl:param name="toc.section.depth">2</xsl:param>
3233
<xsl:param name="linenumbering.extension" select="'0'"></xsl:param>
3334
<xsl:param name="section.autolabel" select="1"></xsl:param>

0 commit comments

Comments
 (0)