Re: Add id's to various elements in protocol.sgml

Brar Piening Wed, 15 Dec 2021 07:59:40 -0800

On Dec 15, 2021 at 15:49, Alvaro Herrera wrote:

On 2021-Dec-15, Brar Piening wrote:

Since I can't argue towards some general utility for the xreflabels
and don't have any other solid argument in favor of adding more, I
will remove them from my current patch but leave the existing ones
intact.

Yeah, I think not adding them until we have a use for them might be
wisest.

A new version of the patch that doesn't add xreflabels is attached.
Thanks for your support.

diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 34a7034282..0bca5831b1 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1810,7 +1810,7 @@ Replication commands are logged in the server log when
 <para>
 The commands accepted in replication mode are:
 <variablelist>
-  <varlistentry>
+  <varlistentry id="protocol-replication-identify-system">
     <term><literal>IDENTIFY_SYSTEM</literal>
      <indexterm><primary>IDENTIFY_SYSTEM</primary></indexterm>
     </term>
@@ -1875,7 +1875,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-show">
     <term><literal>SHOW</literal> <replaceable 
class="parameter">name</replaceable>
      <indexterm><primary>SHOW</primary></indexterm>
     </term>
@@ -1899,7 +1899,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-timeline-history">
     <term><literal>TIMELINE_HISTORY</literal> <replaceable 
class="parameter">tli</replaceable>
      <indexterm><primary>TIMELINE_HISTORY</primary></indexterm>
     </term>
@@ -2084,7 +2084,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-create-slot-legacy">
     <term><literal>CREATE_REPLICATION_SLOT</literal> <replaceable 
class="parameter">slot_name</replaceable> [ <literal>TEMPORARY</literal> ] { 
<literal>PHYSICAL</literal> [ <literal>RESERVE_WAL</literal> ] | 
<literal>LOGICAL</literal> <replaceable 
class="parameter">output_plugin</replaceable> [ 
<literal>EXPORT_SNAPSHOT</literal> | <literal>NOEXPORT_SNAPSHOT</literal> | 
<literal>USE_SNAPSHOT</literal> | <literal>TWO_PHASE</literal> ] }
     </term>
     <listitem>
@@ -2095,7 +2095,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-read-replication-slot">
     <term><literal>READ_REPLICATION_SLOT</literal> <replaceable 
class="parameter">slot_name</replaceable>
       <indexterm><primary>READ_REPLICATION_SLOT</primary></indexterm>
     </term>
@@ -2143,7 +2143,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-start-replication">
     <term><literal>START_REPLICATION</literal> [ <literal>SLOT</literal> 
<replaceable class="parameter">slot_name</replaceable> ] [ 
<literal>PHYSICAL</literal> ] <replaceable 
class="parameter">XXX/XXX</replaceable> [ <literal>TIMELINE</literal> 
<replaceable class="parameter">tli</replaceable> ]
      <indexterm><primary>START_REPLICATION</primary></indexterm>
     </term>
@@ -2201,7 +2201,7 @@ The commands accepted in replication mode are:
 
      <para>
       <variablelist>
-      <varlistentry>
+      <varlistentry id="protocol-replication-xlogdata">
       <term>
           XLogData (B)
       </term>
@@ -2270,7 +2270,7 @@ The commands accepted in replication mode are:
       </para>
       </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry id="protocol-replication-primary-keepalive-message">
       <term>
           Primary keepalive message (B)
       </term>
@@ -2334,7 +2334,7 @@ The commands accepted in replication mode are:
 
      <para>
       <variablelist>
-      <varlistentry>
+      <varlistentry id="protocol-replication-standby-status-update">
       <term>
           Standby status update (F)
       </term>
@@ -2415,7 +2415,7 @@ The commands accepted in replication mode are:
 
      <para>
       <variablelist>
-      <varlistentry>
+      <varlistentry id="protocol-replication-hot-standby-feedback-message">
       <term>
           Hot Standby feedback message (F)
       </term>
@@ -2497,7 +2497,7 @@ The commands accepted in replication mode are:
      </para>
     </listitem>
   </varlistentry>
-  <varlistentry>
+  <varlistentry id="protocol-replication-start-replication-slot-logical">
     <term><literal>START_REPLICATION</literal> <literal>SLOT</literal> 
<replaceable class="parameter">slot_name</replaceable> 
<literal>LOGICAL</literal> <replaceable class="parameter">XXX/XXX</replaceable> 
[ ( <replaceable>option_name</replaceable> [ 
<replaceable>option_value</replaceable> ] [, ...] ) ]</term>
     <listitem>
      <para>
@@ -2572,7 +2572,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-drop-replication-slot">
     <term>
      <literal>DROP_REPLICATION_SLOT</literal> <replaceable 
class="parameter">slot_name</replaceable> <optional> <literal>WAIT</literal> 
</optional>
      <indexterm><primary>DROP_REPLICATION_SLOT</primary></indexterm>
@@ -2886,7 +2886,7 @@ The commands accepted in replication mode are:
     </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry id="protocol-replication-base-backup-legacy">
     <term><literal>BASE_BACKUP</literal> [ <literal>LABEL</literal> 
<replaceable>'label'</replaceable> ] [ <literal>PROGRESS</literal> ] [ 
<literal>FAST</literal> ] [ <literal>WAL</literal> ] [ 
<literal>NOWAIT</literal> ] [ <literal>MAX_RATE</literal> 
<replaceable>rate</replaceable> ] [ <literal>TABLESPACE_MAP</literal> ] [ 
<literal>NOVERIFY_CHECKSUMS</literal> ] [ <literal>MANIFEST</literal> 
<replaceable>manifest_option</replaceable> ] [ 
<literal>MANIFEST_CHECKSUMS</literal> 
<replaceable>checksum_algorithm</replaceable> ]
     </term>
     <listitem>
@@ -3138,7 +3138,7 @@ of any individual CopyData message cannot be 
interpretable on their own.)
 <variablelist>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationok">
 <term>
 AuthenticationOk (B)
 </term>
@@ -3183,7 +3183,7 @@ AuthenticationOk (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationkerberosv5">
 <term>
 AuthenticationKerberosV5 (B)
 </term>
@@ -3227,7 +3227,7 @@ AuthenticationKerberosV5 (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationcleartextpassword">
 <term>
 AuthenticationCleartextPassword (B)
 </term>
@@ -3271,7 +3271,7 @@ AuthenticationCleartextPassword (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationmd5password">
 <term>
 AuthenticationMD5Password (B)
 </term>
@@ -3326,7 +3326,7 @@ AuthenticationMD5Password (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationscmcredential">
 <term>
 AuthenticationSCMCredential (B)
 </term>
@@ -3371,7 +3371,7 @@ AuthenticationSCMCredential (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationgss">
 <term>
 AuthenticationGSS (B)
 </term>
@@ -3416,7 +3416,7 @@ AuthenticationGSS (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationgsscontinue">
 <term>
 AuthenticationGSSContinue (B)
 </term>
@@ -3471,7 +3471,7 @@ AuthenticationGSSContinue (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationsspi">
 <term>
 AuthenticationSSPI (B)
 </term>
@@ -3516,7 +3516,7 @@ AuthenticationSSPI (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationsasl">
 <term>
 AuthenticationSASL (B)
 </term>
@@ -3577,7 +3577,7 @@ following:
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationsaslcontinue">
 <term>
 AuthenticationSASLContinue (B)
 </term>
@@ -3632,7 +3632,7 @@ AuthenticationSASLContinue (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-authenticationsaslfinal">
 <term>
 AuthenticationSASLFinal (B)
 </term>
@@ -3688,7 +3688,7 @@ AuthenticationSASLFinal (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-backendkeydata">
 <term>
 BackendKeyData (B)
 </term>
@@ -3745,7 +3745,7 @@ BackendKeyData (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-bind">
 <term>
 Bind (F)
 </term>
@@ -3898,7 +3898,7 @@ Bind (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-bindcomplete">
 <term>
 BindComplete (B)
 </term>
@@ -3933,7 +3933,7 @@ BindComplete (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-cancelrequest">
 <term>
 CancelRequest (F)
 </term>
@@ -3991,7 +3991,7 @@ CancelRequest (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-close">
 <term>
 Close (F)
 </term>
@@ -4048,7 +4048,7 @@ Close (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-closecomplete">
 <term>
 CloseComplete (B)
 </term>
@@ -4083,7 +4083,7 @@ CloseComplete (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-commandcomplete">
 <term>
 CommandComplete (B)
 </term>
@@ -4182,7 +4182,7 @@ CommandComplete (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copydata">
 <term>
 CopyData (F &amp; B)
 </term>
@@ -4228,7 +4228,7 @@ CopyData (F &amp; B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copydone">
 <term>
 CopyDone (F &amp; B)
 </term>
@@ -4263,7 +4263,7 @@ CopyDone (F &amp; B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copyfail">
 <term>
 CopyFail (F)
 </term>
@@ -4308,7 +4308,7 @@ CopyFail (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copyinresponse">
 <term>
 CopyInResponse (B)
 </term>
@@ -4384,7 +4384,7 @@ CopyInResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copyoutresponse">
 <term>
 CopyOutResponse (B)
 </term>
@@ -4457,7 +4457,7 @@ CopyOutResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-copybothresponse">
 <term>
 CopyBothResponse (B)
 </term>
@@ -4530,7 +4530,7 @@ CopyBothResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-datarow">
 <term>
 DataRow (B)
 </term>
@@ -4602,7 +4602,7 @@ DataRow (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-describe">
 <term>
 Describe (F)
 </term>
@@ -4659,7 +4659,7 @@ Describe (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-emptyqueryresponse">
 <term>
 EmptyQueryResponse (B)
 </term>
@@ -4695,7 +4695,7 @@ EmptyQueryResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-errorresponse">
 <term>
 ErrorResponse (B)
 </term>
@@ -4761,7 +4761,7 @@ ErrorResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-execute">
 <term>
 Execute (F)
 </term>
@@ -4818,7 +4818,7 @@ Execute (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-flush">
 <term>
 Flush (F)
 </term>
@@ -4853,7 +4853,7 @@ Flush (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-functioncall">
 <term>
 FunctionCall (F)
 </term>
@@ -4978,7 +4978,7 @@ FunctionCall (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-functioncallresponse">
 <term>
 FunctionCallResponse (B)
 </term>
@@ -5038,7 +5038,7 @@ FunctionCallResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-gssencrequest">
 <term>
 GSSENCRequest (F)
 </term>
@@ -5076,7 +5076,7 @@ GSSENCRequest (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-gssresponse">
 <term>
 GSSResponse (F)
 </term>
@@ -5121,7 +5121,7 @@ GSSResponse (F)
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-negotiateprotocolversion">
 <term>
 NegotiateProtocolVersion (B)
 </term>
@@ -5190,7 +5190,7 @@ NegotiateProtocolVersion (B)
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-nodata">
 <term>
 NoData (B)
 </term>
@@ -5225,7 +5225,7 @@ NoData (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-noticeresponse">
 <term>
 NoticeResponse (B)
 </term>
@@ -5291,7 +5291,7 @@ NoticeResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-notificationresponse">
 <term>
 NotificationResponse (B)
 </term>
@@ -5356,7 +5356,7 @@ NotificationResponse (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-parameterdescription">
 <term>
 ParameterDescription (B)
 </term>
@@ -5414,7 +5414,7 @@ ParameterDescription (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-parameterstatus">
 <term>
 ParameterStatus (B)
 </term>
@@ -5468,7 +5468,7 @@ ParameterStatus (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-parse">
 <term>
 Parse (F)
 </term>
@@ -5552,7 +5552,7 @@ Parse (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-parsecomplete">
 <term>
 ParseComplete (B)
 </term>
@@ -5587,7 +5587,7 @@ ParseComplete (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-passwordmessage">
 <term>
 PasswordMessage (F)
 </term>
@@ -5633,7 +5633,7 @@ PasswordMessage (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-portalsuspended">
 <term>
 PortalSuspended (B)
 </term>
@@ -5670,7 +5670,7 @@ PortalSuspended (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-query">
 <term>
 Query (F)
 </term>
@@ -5715,7 +5715,7 @@ Query (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-readyforquery">
 <term>
 ReadyForQuery (B)
 </term>
@@ -5765,7 +5765,7 @@ ReadyForQuery (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-rowdescription">
 <term>
 RowDescription (B)
 </term>
@@ -5890,7 +5890,7 @@ RowDescription (B)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-saslinitialresponse">
 <term>
 SASLInitialResponse (F)
 </term>
@@ -5958,7 +5958,7 @@ SASLInitialResponse (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-saslresponse">
 <term>
 SASLResponse (F)
 </term>
@@ -6004,7 +6004,7 @@ SASLResponse (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-sslrequest">
 <term>
 SSLRequest (F)
 </term>
@@ -6042,7 +6042,7 @@ SSLRequest (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-startupmessage">
 <term>
 StartupMessage (F)
 </term>
@@ -6171,7 +6171,7 @@ StartupMessage (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-sync">
 <term>
 Sync (F)
 </term>
@@ -6206,7 +6206,7 @@ Sync (F)
 </varlistentry>
 
 
-<varlistentry>
+<varlistentry id="protocol-message-formats-terminate">
 <term>
 Terminate (F)
 </term>
@@ -6537,7 +6537,7 @@ flow as physical replication.
 
 <variablelist>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-begin">
 <term>
 Begin
 </term>
@@ -6592,7 +6592,7 @@ Begin
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-message">
 <term>
 Message
 </term>
@@ -6680,7 +6680,7 @@ Message
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-commit">
 <term>
 Commit
 </term>
@@ -6745,7 +6745,7 @@ Commit
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-origin">
 <term>
 Origin
 </term>
@@ -6794,7 +6794,7 @@ Origin
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-relation">
 <term>
 Relation
 </term>
@@ -6926,7 +6926,7 @@ Relation
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-type">
 <term>
 Type
 </term>
@@ -6991,7 +6991,7 @@ Type
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-insert">
 <term>
 Insert
 </term>
@@ -7058,7 +7058,7 @@ Insert
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-update">
 <term>
 Update
 </term>
@@ -7172,7 +7172,7 @@ Update
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-delete">
 <term>
 Delete
 </term>
@@ -7261,7 +7261,7 @@ Delete
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-truncate">
 <term>
 Truncate
 </term>
@@ -7339,7 +7339,7 @@ Stream Abort) are available since protocol version 2.
 
 <variablelist>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-stream-start">
 <term>
 Stream Start
 </term>
@@ -7384,7 +7384,7 @@ Stream Start
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-stream-stop">
 <term>
 Stream Stop
 </term>
@@ -7408,7 +7408,7 @@ Stream Stop
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-stream-commit">
 <term>
 Stream Commit
 </term>
@@ -7483,7 +7483,7 @@ Stream Commit
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-stream-abort">
 <term>
 Stream Abort
 </term>
@@ -7537,7 +7537,7 @@ are available since protocol version 3.
 
 <variablelist>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-begin-prepare">
 
 <term>Begin Prepare</term>
 <listitem>
@@ -7602,7 +7602,7 @@ are available since protocol version 3.
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-prepare">
 
 <term>Prepare</term>
 <listitem>
@@ -7676,7 +7676,7 @@ are available since protocol version 3.
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-commit-prepared">
 
 <term>Commit Prepared</term>
 <listitem>
@@ -7750,7 +7750,7 @@ are available since protocol version 3.
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-rollback-prepared">
 
 <term>Rollback Prepared</term>
 <listitem>
@@ -7834,7 +7834,7 @@ are available since protocol version 3.
 </listitem>
 </varlistentry>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-stream-prepare">
 
 <term>Stream Prepare</term>
 <listitem>
@@ -7918,7 +7918,7 @@ The following message parts are shared by the above 
messages.
 
 <variablelist>
 
-<varlistentry>
+<varlistentry id="protocol-logicalrep-message-formats-tupledata">
 <term>
 TupleData
 </term>

Re: Add id's to various elements in protocol.sgml

Reply via email to