public inbox for [email protected]help / color / mirror / Atom feed
Add id's to various elements in protocol.sgml 11+ messages / 6 participants [nested] [flat]
* Add id's to various elements in protocol.sgml @ 2021-12-05 15:50 Brar Piening <[email protected]> 0 siblings, 2 replies; 11+ messages in thread From: Brar Piening @ 2021-12-05 15:50 UTC (permalink / raw) To: PostgreSQL Hackers <[email protected]> When working with the Frontend/Backend Protocol implementation in Npgsql and discussing things with the team, I often struggle with the fact that you can't set deep links to individual message formats in the somewhat lengthy html docs pages. The attached patch adds id's to various elements in protocol.sgml to make them more accesssible via the public html documentation interface. I've tried to follow the style that was already there in a few of the elements. Do you consider this useful and worth merging? Is there anything I can improve? Best Regards, Brar diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 34a7034282..e22dc5f3b0 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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="START_REPLICATION SLOT"> <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" xreflabel="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" xreflabel="AuthenticationOk"> <term> AuthenticationOk (B) </term> @@ -3183,7 +3183,7 @@ AuthenticationOk (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationkerberosv5" xreflabel="AuthenticationKerberosV5"> <term> AuthenticationKerberosV5 (B) </term> @@ -3227,7 +3227,7 @@ AuthenticationKerberosV5 (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationcleartextpassword" xreflabel="AuthenticationCleartextPassword"> <term> AuthenticationCleartextPassword (B) </term> @@ -3271,7 +3271,7 @@ AuthenticationCleartextPassword (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationmd5password" xreflabel="AuthenticationMD5Password"> <term> AuthenticationMD5Password (B) </term> @@ -3326,7 +3326,7 @@ AuthenticationMD5Password (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationscmcredential" xreflabel="AuthenticationSCMCredential"> <term> AuthenticationSCMCredential (B) </term> @@ -3371,7 +3371,7 @@ AuthenticationSCMCredential (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationgss" xreflabel="AuthenticationGSS"> <term> AuthenticationGSS (B) </term> @@ -3416,7 +3416,7 @@ AuthenticationGSS (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationgsscontinue" xreflabel="AuthenticationGSSContinue"> <term> AuthenticationGSSContinue (B) </term> @@ -3471,7 +3471,7 @@ AuthenticationGSSContinue (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsspi" xreflabel="AuthenticationSSPI"> <term> AuthenticationSSPI (B) </term> @@ -3516,7 +3516,7 @@ AuthenticationSSPI (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsasl" xreflabel="AuthenticationSASL"> <term> AuthenticationSASL (B) </term> @@ -3577,7 +3577,7 @@ following: </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsaslcontinue" xreflabel="AuthenticationSASLContinue"> <term> AuthenticationSASLContinue (B) </term> @@ -3632,7 +3632,7 @@ AuthenticationSASLContinue (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsaslfinal" xreflabel="AuthenticationSASLFinal"> <term> AuthenticationSASLFinal (B) </term> @@ -3688,7 +3688,7 @@ AuthenticationSASLFinal (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-backendkeydata" xreflabel="BackendKeyData"> <term> BackendKeyData (B) </term> @@ -3745,7 +3745,7 @@ BackendKeyData (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-bind" xreflabel="Bind"> <term> Bind (F) </term> @@ -3898,7 +3898,7 @@ Bind (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-bindcomplete" xreflabel="BindComplete"> <term> BindComplete (B) </term> @@ -3933,7 +3933,7 @@ BindComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-cancelrequest" xreflabel="CancelRequest"> <term> CancelRequest (F) </term> @@ -3991,7 +3991,7 @@ CancelRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-close" xreflabel="Close"> <term> Close (F) </term> @@ -4048,7 +4048,7 @@ Close (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-closecomplete" xreflabel="CloseComplete"> <term> CloseComplete (B) </term> @@ -4083,7 +4083,7 @@ CloseComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-commandcomplete" xreflabel="CommandComplete"> <term> CommandComplete (B) </term> @@ -4182,7 +4182,7 @@ CommandComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydata" xreflabel="CopyData"> <term> CopyData (F & B) </term> @@ -4228,7 +4228,7 @@ CopyData (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydone" xreflabel="CopyDone"> <term> CopyDone (F & B) </term> @@ -4263,7 +4263,7 @@ CopyDone (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyfail" xreflabel="CopyFail"> <term> CopyFail (F) </term> @@ -4308,7 +4308,7 @@ CopyFail (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyinresponse" xreflabel="CopyInResponse"> <term> CopyInResponse (B) </term> @@ -4384,7 +4384,7 @@ CopyInResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyoutresponse" xreflabel="CopyOutResponse"> <term> CopyOutResponse (B) </term> @@ -4457,7 +4457,7 @@ CopyOutResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copybothresponse" xreflabel="CopyBothResponse"> <term> CopyBothResponse (B) </term> @@ -4530,7 +4530,7 @@ CopyBothResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-datarow" xreflabel="DataRow"> <term> DataRow (B) </term> @@ -4602,7 +4602,7 @@ DataRow (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-describe" xreflabel="Describe"> <term> Describe (F) </term> @@ -4659,7 +4659,7 @@ Describe (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-emptyqueryresponse" xreflabel="EmptyQueryResponse"> <term> EmptyQueryResponse (B) </term> @@ -4695,7 +4695,7 @@ EmptyQueryResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-errorresponse" xreflabel="ErrorResponse"> <term> ErrorResponse (B) </term> @@ -4761,7 +4761,7 @@ ErrorResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-execute" xreflabel="Execute"> <term> Execute (F) </term> @@ -4818,7 +4818,7 @@ Execute (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-flush" xreflabel="Flush"> <term> Flush (F) </term> @@ -4853,7 +4853,7 @@ Flush (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-functioncall" xreflabel="FunctionCall"> <term> FunctionCall (F) </term> @@ -4978,7 +4978,7 @@ FunctionCall (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-functioncallresponse" xreflabel="FunctionCallResponse"> <term> FunctionCallResponse (B) </term> @@ -5038,7 +5038,7 @@ FunctionCallResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-gssencrequest" xreflabel="GSSENCRequest"> <term> GSSENCRequest (F) </term> @@ -5076,7 +5076,7 @@ GSSENCRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-gssresponse" xreflabel="GSSResponse"> <term> GSSResponse (F) </term> @@ -5121,7 +5121,7 @@ GSSResponse (F) </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-negotiateprotocolversion" xreflabel="NegotiateProtocolVersion"> <term> NegotiateProtocolVersion (B) </term> @@ -5190,7 +5190,7 @@ NegotiateProtocolVersion (B) </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-nodata" xreflabel="NoData"> <term> NoData (B) </term> @@ -5225,7 +5225,7 @@ NoData (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-noticeresponse" xreflabel="NoticeResponse"> <term> NoticeResponse (B) </term> @@ -5291,7 +5291,7 @@ NoticeResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-notificationresponse" xreflabel="NotificationResponse"> <term> NotificationResponse (B) </term> @@ -5356,7 +5356,7 @@ NotificationResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parameterdescription" xreflabel="ParameterDescription"> <term> ParameterDescription (B) </term> @@ -5414,7 +5414,7 @@ ParameterDescription (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parameterstatus" xreflabel="ParameterStatus"> <term> ParameterStatus (B) </term> @@ -5468,7 +5468,7 @@ ParameterStatus (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parse" xreflabel="Parse"> <term> Parse (F) </term> @@ -5552,7 +5552,7 @@ Parse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parsecomplete" xreflabel="ParseComplete"> <term> ParseComplete (B) </term> @@ -5587,7 +5587,7 @@ ParseComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-passwordmessage" xreflabel="PasswordMessage"> <term> PasswordMessage (F) </term> @@ -5633,7 +5633,7 @@ PasswordMessage (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-portalsuspended" xreflabel="PortalSuspended"> <term> PortalSuspended (B) </term> @@ -5670,7 +5670,7 @@ PortalSuspended (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-query" xreflabel="Query"> <term> Query (F) </term> @@ -5715,7 +5715,7 @@ Query (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-readyforquery" xreflabel="ReadyForQuery"> <term> ReadyForQuery (B) </term> @@ -5765,7 +5765,7 @@ ReadyForQuery (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-rowdescription" xreflabel="RowDescription"> <term> RowDescription (B) </term> @@ -5890,7 +5890,7 @@ RowDescription (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-saslinitialresponse" xreflabel="SASLInitialResponse"> <term> SASLInitialResponse (F) </term> @@ -5958,7 +5958,7 @@ SASLInitialResponse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-saslresponse" xreflabel="SASLResponse"> <term> SASLResponse (F) </term> @@ -6004,7 +6004,7 @@ SASLResponse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-sslrequest" xreflabel="SSLRequest"> <term> SSLRequest (F) </term> @@ -6042,7 +6042,7 @@ SSLRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-startupmessage" xreflabel="StartupMessage"> <term> StartupMessage (F) </term> @@ -6171,7 +6171,7 @@ StartupMessage (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-sync" xreflabel="Sync"> <term> Sync (F) </term> @@ -6206,7 +6206,7 @@ Sync (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-terminate" xreflabel="Terminate"> <term> Terminate (F) </term> @@ -6537,7 +6537,7 @@ flow as physical replication. <variablelist> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-begin" xreflabel="Begin"> <term> Begin </term> @@ -6592,7 +6592,7 @@ Begin </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-message" xreflabel="Message"> <term> Message </term> @@ -6680,7 +6680,7 @@ Message </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-commit" xreflabel="Commit"> <term> Commit </term> @@ -6745,7 +6745,7 @@ Commit </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-origin" xreflabel="Origin"> <term> Origin </term> @@ -6794,7 +6794,7 @@ Origin </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-relation" xreflabel="Relation"> <term> Relation </term> @@ -6926,7 +6926,7 @@ Relation </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-type" xreflabel="Type"> <term> Type </term> @@ -6991,7 +6991,7 @@ Type </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-insert" xreflabel="Insert"> <term> Insert </term> @@ -7058,7 +7058,7 @@ Insert </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-update" xreflabel="Update"> <term> Update </term> @@ -7172,7 +7172,7 @@ Update </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-delete" xreflabel="Delete"> <term> Delete </term> @@ -7261,7 +7261,7 @@ Delete </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-truncate" xreflabel="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" xreflabel="Stream Start"> <term> Stream Start </term> @@ -7384,7 +7384,7 @@ Stream Start </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-stop" xreflabel="Stream Stop"> <term> Stream Stop </term> @@ -7408,7 +7408,7 @@ Stream Stop </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-commit" xreflabel="Stream Commit"> <term> Stream Commit </term> @@ -7483,7 +7483,7 @@ Stream Commit </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-abort" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="TupleData"> <term> TupleData </term> Attachments: [text/plain] protocol.sgml-anchors.patch (20.6K, ../../[email protected]/2-protocol.sgml-anchors.patch) download | inline diff: diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 34a7034282..e22dc5f3b0 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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="START_REPLICATION SLOT"> <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" xreflabel="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" xreflabel="AuthenticationOk"> <term> AuthenticationOk (B) </term> @@ -3183,7 +3183,7 @@ AuthenticationOk (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationkerberosv5" xreflabel="AuthenticationKerberosV5"> <term> AuthenticationKerberosV5 (B) </term> @@ -3227,7 +3227,7 @@ AuthenticationKerberosV5 (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationcleartextpassword" xreflabel="AuthenticationCleartextPassword"> <term> AuthenticationCleartextPassword (B) </term> @@ -3271,7 +3271,7 @@ AuthenticationCleartextPassword (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationmd5password" xreflabel="AuthenticationMD5Password"> <term> AuthenticationMD5Password (B) </term> @@ -3326,7 +3326,7 @@ AuthenticationMD5Password (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationscmcredential" xreflabel="AuthenticationSCMCredential"> <term> AuthenticationSCMCredential (B) </term> @@ -3371,7 +3371,7 @@ AuthenticationSCMCredential (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationgss" xreflabel="AuthenticationGSS"> <term> AuthenticationGSS (B) </term> @@ -3416,7 +3416,7 @@ AuthenticationGSS (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationgsscontinue" xreflabel="AuthenticationGSSContinue"> <term> AuthenticationGSSContinue (B) </term> @@ -3471,7 +3471,7 @@ AuthenticationGSSContinue (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsspi" xreflabel="AuthenticationSSPI"> <term> AuthenticationSSPI (B) </term> @@ -3516,7 +3516,7 @@ AuthenticationSSPI (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsasl" xreflabel="AuthenticationSASL"> <term> AuthenticationSASL (B) </term> @@ -3577,7 +3577,7 @@ following: </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsaslcontinue" xreflabel="AuthenticationSASLContinue"> <term> AuthenticationSASLContinue (B) </term> @@ -3632,7 +3632,7 @@ AuthenticationSASLContinue (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-authenticationsaslfinal" xreflabel="AuthenticationSASLFinal"> <term> AuthenticationSASLFinal (B) </term> @@ -3688,7 +3688,7 @@ AuthenticationSASLFinal (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-backendkeydata" xreflabel="BackendKeyData"> <term> BackendKeyData (B) </term> @@ -3745,7 +3745,7 @@ BackendKeyData (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-bind" xreflabel="Bind"> <term> Bind (F) </term> @@ -3898,7 +3898,7 @@ Bind (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-bindcomplete" xreflabel="BindComplete"> <term> BindComplete (B) </term> @@ -3933,7 +3933,7 @@ BindComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-cancelrequest" xreflabel="CancelRequest"> <term> CancelRequest (F) </term> @@ -3991,7 +3991,7 @@ CancelRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-close" xreflabel="Close"> <term> Close (F) </term> @@ -4048,7 +4048,7 @@ Close (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-closecomplete" xreflabel="CloseComplete"> <term> CloseComplete (B) </term> @@ -4083,7 +4083,7 @@ CloseComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-commandcomplete" xreflabel="CommandComplete"> <term> CommandComplete (B) </term> @@ -4182,7 +4182,7 @@ CommandComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydata" xreflabel="CopyData"> <term> CopyData (F & B) </term> @@ -4228,7 +4228,7 @@ CopyData (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydone" xreflabel="CopyDone"> <term> CopyDone (F & B) </term> @@ -4263,7 +4263,7 @@ CopyDone (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyfail" xreflabel="CopyFail"> <term> CopyFail (F) </term> @@ -4308,7 +4308,7 @@ CopyFail (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyinresponse" xreflabel="CopyInResponse"> <term> CopyInResponse (B) </term> @@ -4384,7 +4384,7 @@ CopyInResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copyoutresponse" xreflabel="CopyOutResponse"> <term> CopyOutResponse (B) </term> @@ -4457,7 +4457,7 @@ CopyOutResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copybothresponse" xreflabel="CopyBothResponse"> <term> CopyBothResponse (B) </term> @@ -4530,7 +4530,7 @@ CopyBothResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-datarow" xreflabel="DataRow"> <term> DataRow (B) </term> @@ -4602,7 +4602,7 @@ DataRow (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-describe" xreflabel="Describe"> <term> Describe (F) </term> @@ -4659,7 +4659,7 @@ Describe (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-emptyqueryresponse" xreflabel="EmptyQueryResponse"> <term> EmptyQueryResponse (B) </term> @@ -4695,7 +4695,7 @@ EmptyQueryResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-errorresponse" xreflabel="ErrorResponse"> <term> ErrorResponse (B) </term> @@ -4761,7 +4761,7 @@ ErrorResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-execute" xreflabel="Execute"> <term> Execute (F) </term> @@ -4818,7 +4818,7 @@ Execute (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-flush" xreflabel="Flush"> <term> Flush (F) </term> @@ -4853,7 +4853,7 @@ Flush (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-functioncall" xreflabel="FunctionCall"> <term> FunctionCall (F) </term> @@ -4978,7 +4978,7 @@ FunctionCall (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-functioncallresponse" xreflabel="FunctionCallResponse"> <term> FunctionCallResponse (B) </term> @@ -5038,7 +5038,7 @@ FunctionCallResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-gssencrequest" xreflabel="GSSENCRequest"> <term> GSSENCRequest (F) </term> @@ -5076,7 +5076,7 @@ GSSENCRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-gssresponse" xreflabel="GSSResponse"> <term> GSSResponse (F) </term> @@ -5121,7 +5121,7 @@ GSSResponse (F) </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-negotiateprotocolversion" xreflabel="NegotiateProtocolVersion"> <term> NegotiateProtocolVersion (B) </term> @@ -5190,7 +5190,7 @@ NegotiateProtocolVersion (B) </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-nodata" xreflabel="NoData"> <term> NoData (B) </term> @@ -5225,7 +5225,7 @@ NoData (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-noticeresponse" xreflabel="NoticeResponse"> <term> NoticeResponse (B) </term> @@ -5291,7 +5291,7 @@ NoticeResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-notificationresponse" xreflabel="NotificationResponse"> <term> NotificationResponse (B) </term> @@ -5356,7 +5356,7 @@ NotificationResponse (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parameterdescription" xreflabel="ParameterDescription"> <term> ParameterDescription (B) </term> @@ -5414,7 +5414,7 @@ ParameterDescription (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parameterstatus" xreflabel="ParameterStatus"> <term> ParameterStatus (B) </term> @@ -5468,7 +5468,7 @@ ParameterStatus (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parse" xreflabel="Parse"> <term> Parse (F) </term> @@ -5552,7 +5552,7 @@ Parse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-parsecomplete" xreflabel="ParseComplete"> <term> ParseComplete (B) </term> @@ -5587,7 +5587,7 @@ ParseComplete (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-passwordmessage" xreflabel="PasswordMessage"> <term> PasswordMessage (F) </term> @@ -5633,7 +5633,7 @@ PasswordMessage (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-portalsuspended" xreflabel="PortalSuspended"> <term> PortalSuspended (B) </term> @@ -5670,7 +5670,7 @@ PortalSuspended (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-query" xreflabel="Query"> <term> Query (F) </term> @@ -5715,7 +5715,7 @@ Query (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-readyforquery" xreflabel="ReadyForQuery"> <term> ReadyForQuery (B) </term> @@ -5765,7 +5765,7 @@ ReadyForQuery (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-rowdescription" xreflabel="RowDescription"> <term> RowDescription (B) </term> @@ -5890,7 +5890,7 @@ RowDescription (B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-saslinitialresponse" xreflabel="SASLInitialResponse"> <term> SASLInitialResponse (F) </term> @@ -5958,7 +5958,7 @@ SASLInitialResponse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-saslresponse" xreflabel="SASLResponse"> <term> SASLResponse (F) </term> @@ -6004,7 +6004,7 @@ SASLResponse (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-sslrequest" xreflabel="SSLRequest"> <term> SSLRequest (F) </term> @@ -6042,7 +6042,7 @@ SSLRequest (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-startupmessage" xreflabel="StartupMessage"> <term> StartupMessage (F) </term> @@ -6171,7 +6171,7 @@ StartupMessage (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-sync" xreflabel="Sync"> <term> Sync (F) </term> @@ -6206,7 +6206,7 @@ Sync (F) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-terminate" xreflabel="Terminate"> <term> Terminate (F) </term> @@ -6537,7 +6537,7 @@ flow as physical replication. <variablelist> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-begin" xreflabel="Begin"> <term> Begin </term> @@ -6592,7 +6592,7 @@ Begin </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-message" xreflabel="Message"> <term> Message </term> @@ -6680,7 +6680,7 @@ Message </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-commit" xreflabel="Commit"> <term> Commit </term> @@ -6745,7 +6745,7 @@ Commit </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-origin" xreflabel="Origin"> <term> Origin </term> @@ -6794,7 +6794,7 @@ Origin </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-relation" xreflabel="Relation"> <term> Relation </term> @@ -6926,7 +6926,7 @@ Relation </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-type" xreflabel="Type"> <term> Type </term> @@ -6991,7 +6991,7 @@ Type </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-insert" xreflabel="Insert"> <term> Insert </term> @@ -7058,7 +7058,7 @@ Insert </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-update" xreflabel="Update"> <term> Update </term> @@ -7172,7 +7172,7 @@ Update </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-delete" xreflabel="Delete"> <term> Delete </term> @@ -7261,7 +7261,7 @@ Delete </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-truncate" xreflabel="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" xreflabel="Stream Start"> <term> Stream Start </term> @@ -7384,7 +7384,7 @@ Stream Start </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-stop" xreflabel="Stream Stop"> <term> Stream Stop </term> @@ -7408,7 +7408,7 @@ Stream Stop </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-commit" xreflabel="Stream Commit"> <term> Stream Commit </term> @@ -7483,7 +7483,7 @@ Stream Commit </listitem> </varlistentry> -<varlistentry> +<varlistentry id="protocol-logicalrep-message-formats-stream-abort" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="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" xreflabel="TupleData"> <term> TupleData </term> ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-05 16:15 Daniel Gustafsson <[email protected]> parent: Brar Piening <[email protected]> 1 sibling, 1 reply; 11+ messages in thread From: Daniel Gustafsson @ 2021-12-05 16:15 UTC (permalink / raw) To: Brar Piening <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> > On 5 Dec 2021, at 16:51, Brar Piening <[email protected]> wrote: > The attached patch adds id's to various elements in protocol.sgml to > make them more accesssible via the public html documentation interface. Off the cuff without having checked the compiled results yet, it seems like a good idea. — Daniel Gustafsson ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-14 18:58 Corey Huinker <[email protected]> parent: Daniel Gustafsson <[email protected]> 0 siblings, 0 replies; 11+ messages in thread From: Corey Huinker @ 2021-12-14 18:58 UTC (permalink / raw) To: Daniel Gustafsson <[email protected]>; +Cc: Brar Piening <[email protected]>; PostgreSQL Hackers <[email protected]> On Sun, Dec 5, 2021 at 11:15 AM Daniel Gustafsson <[email protected]> wrote: > > On 5 Dec 2021, at 16:51, Brar Piening <[email protected]> wrote: > > > The attached patch adds id's to various elements in protocol.sgml to > > make them more accesssible via the public html documentation interface. > > Off the cuff without having checked the compiled results yet, it seems > like a good idea. > > — > Daniel Gustafsson > I wanted to do something similar for every function specification in the docs. This may inspire me to take another shot at that. ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-14 19:47 Alvaro Herrera <[email protected]> parent: Brar Piening <[email protected]> 1 sibling, 1 reply; 11+ messages in thread From: Alvaro Herrera @ 2021-12-14 19:47 UTC (permalink / raw) To: Brar Piening <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On 2021-Dec-05, Brar Piening wrote: > When working with the Frontend/Backend Protocol implementation in Npgsql > and discussing things with the team, I often struggle with the fact that > you can't set deep links to individual message formats in the somewhat > lengthy html docs pages. > > The attached patch adds id's to various elements in protocol.sgml to > make them more accesssible via the public html documentation interface. > > I've tried to follow the style that was already there in a few of the > elements. Hmm, I think we tend to avoid xreflabels; see https://www.postgresql.org/message-id/[email protected] -- Álvaro Herrera Valdivia, Chile — https://www.EnterpriseDB.com/ ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-15 11:07 Brar Piening <[email protected]> parent: Alvaro Herrera <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Brar Piening @ 2021-12-15 11:07 UTC (permalink / raw) To: Alvaro Herrera <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On Dec 14, 2021 at 20:47, Alvaro Herrera wrote: > > Hmm, I think we tend to avoid xreflabels; see > https://www.postgresql.org/message-id/[email protected] Ok, thank you for the hint. I added them because <varlistentry> doesn't automatically generate labels and they were present in the current docs for CREATE_REPLICATION_SLOT (https://github.com/postgres/postgres/blob/22bd3cbe0c284758d7174321f5596763095cdd55/doc/src/sgml/prot...). After reading the aforementioned thread to https://www.postgresql.org/message-id/20200611223836.GA2507%40momjian.us I infer the following conclusions: a) Do *not* include xreflabel for elements that get numbered. b) There should be some general utility for the xreflabel, not just the linking needs of one particular source location. c) Generally, xreflabels are a bit of antipattern, so there need to be solid arguments in favor of adding more. 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. Objections? ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-15 14:49 Alvaro Herrera <[email protected]> parent: Brar Piening <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Alvaro Herrera @ 2021-12-15 14:49 UTC (permalink / raw) To: Brar Piening <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On 2021-Dec-15, Brar Piening wrote: > On Dec 14, 2021 at 20:47, Alvaro Herrera wrote: > > > > Hmm, I think we tend to avoid xreflabels; see > > https://www.postgresql.org/message-id/[email protected] > > Ok, thank you for the hint. > I added them because <varlistentry> doesn't automatically generate > labels and they were present in the current docs for > CREATE_REPLICATION_SLOT > (https://github.com/postgres/postgres/blob/22bd3cbe0c284758d7174321f5596763095cdd55/doc/src/sgml/prot...). Hmm, now that you mention it, we do have xreflabels for varlistentrys in quite a few places. Maybe we need to update README.links to mention this. > 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. -- Álvaro Herrera 39°49'30"S 73°17'W — https://www.EnterpriseDB.com/ "La vida es para el que se aventura" ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-15 15:59 Brar Piening <[email protected]> parent: Alvaro Herrera <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Brar Piening @ 2021-12-15 15:59 UTC (permalink / raw) To: Alvaro Herrera <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> 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 & B) </term> @@ -4228,7 +4228,7 @@ CopyData (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydone"> <term> CopyDone (F & B) </term> @@ -4263,7 +4263,7 @@ CopyDone (F & 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> Attachments: [text/plain] protocol.sgml-anchors_v2.patch (18.4K, ../../[email protected]/2-protocol.sgml-anchors_v2.patch) download | inline diff: 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 & B) </term> @@ -4228,7 +4228,7 @@ CopyData (F & B) </varlistentry> -<varlistentry> +<varlistentry id="protocol-message-formats-copydone"> <term> CopyDone (F & B) </term> @@ -4263,7 +4263,7 @@ CopyDone (F & 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> ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-17 07:13 Peter Eisentraut <[email protected]> parent: Brar Piening <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Peter Eisentraut @ 2021-12-17 07:13 UTC (permalink / raw) To: Brar Piening <[email protected]>; Alvaro Herrera <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On 15.12.21 16:59, Brar Piening wrote: > 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. Now this patch adds a bunch of ids, but you can't use them to link to, because as soon as you do, you will get complaints about a missing xreflabel. So what is the remaining purpose? ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-17 23:53 Brar Piening <[email protected]> parent: Peter Eisentraut <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Brar Piening @ 2021-12-17 23:53 UTC (permalink / raw) To: Peter Eisentraut <[email protected]>; Alvaro Herrera <[email protected]>; +Cc: PostgreSQL Hackers <[email protected]> On Dec 17, 2021 at 08:13, Peter Eisentraut wrote: > On 15.12.21 16:59, Brar Piening wrote: >> 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. > > Now this patch adds a bunch of ids, but you can't use them to link to, > because as soon as you do, you will get complaints about a missing > xreflabel. So what is the remaining purpose? The purpose is that you can directly link to the id in the public html docs which still gets generated (e. g. https://www.postgresql.org/docs/14/protocol-replication.html#PROTOCOL-REPLICATION-BASE-BACKUP). Essentially it gives people discussing the protocol and pointing to a certain command or message format the chance to link to the very thing they are discussing instead of the top of the lengthy html page. ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-20 15:09 Robert Haas <[email protected]> parent: Brar Piening <[email protected]> 0 siblings, 1 reply; 11+ messages in thread From: Robert Haas @ 2021-12-20 15:09 UTC (permalink / raw) To: Brar Piening <[email protected]>; +Cc: Peter Eisentraut <[email protected]>; Alvaro Herrera <[email protected]>; PostgreSQL Hackers <[email protected]> On Fri, Dec 17, 2021 at 6:54 PM Brar Piening <[email protected]> wrote: > The purpose is that you can directly link to the id in the public html > docs which still gets generated (e. g. > https://www.postgresql.org/docs/14/protocol-replication.html#PROTOCOL-REPLICATION-BASE-BACKUP). > > Essentially it gives people discussing the protocol and pointing to a > certain command or message format the chance to link to the very thing > they are discussing instead of the top of the lengthy html page. As a data point, this is something I have also wanted to do, from time to time. I am generally of the opinion that any place the documentation has a long list of things, which should add ids, so that people can link to the particular thing in the list to which they want to draw someone's attention. -- Robert Haas EDB: http://www.enterprisedb.com ^ permalink raw reply [nested|flat] 11+ messages in thread
* Re: Add id's to various elements in protocol.sgml @ 2021-12-21 07:47 Brar Piening <[email protected]> parent: Robert Haas <[email protected]> 0 siblings, 0 replies; 11+ messages in thread From: Brar Piening @ 2021-12-21 07:47 UTC (permalink / raw) To: Robert Haas <[email protected]>; +Cc: Peter Eisentraut <[email protected]>; Alvaro Herrera <[email protected]>; PostgreSQL Hackers <[email protected]> On 20.12.2021 at 16:09, Robert Haas wrote: > As a data point, this is something I have also wanted to do, from time > to time. I am generally of the opinion that any place the > documentation has a long list of things, which should add ids, so that > people can link to the particular thing in the list to which they want > to draw someone's attention. > Thank you. If there is consensus on generally adding links to long lists I'd take suggestions for other places where people think that this would make sense and amend my patch. ^ permalink raw reply [nested|flat] 11+ messages in thread
end of thread, other threads:[~2021-12-21 07:47 UTC | newest] Thread overview: 11+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2021-12-05 15:50 Add id's to various elements in protocol.sgml Brar Piening <[email protected]> 2021-12-05 16:15 ` Daniel Gustafsson <[email protected]> 2021-12-14 18:58 ` Corey Huinker <[email protected]> 2021-12-14 19:47 ` Alvaro Herrera <[email protected]> 2021-12-15 11:07 ` Brar Piening <[email protected]> 2021-12-15 14:49 ` Alvaro Herrera <[email protected]> 2021-12-15 15:59 ` Brar Piening <[email protected]> 2021-12-17 07:13 ` Peter Eisentraut <[email protected]> 2021-12-17 23:53 ` Brar Piening <[email protected]> 2021-12-20 15:09 ` Robert Haas <[email protected]> 2021-12-21 07:47 ` Brar Piening <[email protected]>
This inbox is served by agora; see mirroring instructions for how to clone and mirror all data and code used for this inbox