doc PG relnotes: add paragraph explaining the section symbol
authorBruce Momjian <[email protected]>
Wed, 18 Sep 2024 21:13:19 +0000 (17:13 -0400)
committerBruce Momjian <[email protected]>
Wed, 18 Sep 2024 21:13:19 +0000 (17:13 -0400)
And suppress the symbol in print mode, where the section symbol does not
appear.

Discussion: https://postgr.es/m/[email protected]

Backpatch-through: 12

doc/src/sgml/release.sgml
doc/src/sgml/stylesheet-fo.xsl

index f2aadd48d43f1c46697b744b5da6c1d76ab8f5c4..b9103ab7f08bb8be59a0fd6dd25e0e5f980eb1cb 100644 (file)
@@ -69,6 +69,15 @@ For new features, add links to the documentation sections.
    review, so each item is truly a community effort.
   </para>
 
+  <para id="release-no-print-output">
+   Section markers (&sect;) in the release notes link to <ulink
+   url="https://git.postgresql.org/gitweb/?p=postgresql.git"><application>gitweb</application></ulink>
+   pages which show the primary <application>git</application> commit
+   messages and source tree changes responsible for the release note item.
+   There might be additional <application>git</application> commits which
+   are not shown.
+  </para>
+
 <!--
   When beginning a new major-release series, create a new release-NN.sgml
   file, removing the previous one, and change the &-reference here.
index 647666727cff6a1ebcf8bd2abace5746f9393eb2..9378ba350c29aa23be7ff35e5560e5226a41a693 100644 (file)
   <!-- Do nothing for ulink to avoid footnotes -->
 </xsl:template>
 
+<!-- Also suppress the description of the section markers in print mode -->
+<xsl:template match="appendix[@id='release']//para[@id='release-no-print-output']">
+  <!-- Output nothing for this para -->
+</xsl:template>
+
 <xsl:param name="use.extensions" select="1"></xsl:param>
 <xsl:param name="variablelist.as.blocks" select="1"></xsl:param>