v2-0004-docs-Consolidate-into-new-WAL-for-Extensions-chap.patch
application/octet-stream
Filename: v2-0004-docs-Consolidate-into-new-WAL-for-Extensions-chap.patch
Type: application/octet-stream
Part: 0
Message:
Re: documentation structure
Patch
Same data as JSON:
GET /api/v1/attachments/:id/patch
the parsed metadata as JSON — format, series position, per-file stats; never the diff bytes.
API reference →
Format: format-patch
Series: patch v2-0004
Subject: docs: Consolidate into new "WAL for Extensions" chapter.
| File | + | − |
|---|---|---|
| doc/src/sgml/custom-rmgr.sgml | 2 | 2 |
| doc/src/sgml/filelist.sgml | 1 | 0 |
| doc/src/sgml/generic-wal.sgml | 2 | 2 |
| doc/src/sgml/postgres.sgml | 1 | 2 |
| doc/src/sgml/wal-for-extensions.sgml | 9 | 0 |
From bee277b6fda299e510beacf47db10493ef689f76 Mon Sep 17 00:00:00 2001
From: Robert Haas <rhaas@postgresql.org>
Date: Wed, 20 Mar 2024 12:12:48 -0400
Subject: [PATCH v2 4/5] docs: Consolidate into new "WAL for Extensions"
chapter.
Previously, we had consecutive, very short chapters called "Generic
WAL" and "Custom WAL Resource Managers," explaining different approaches
to the same problem. Merge them into a single chapter.
Rather than actually combining all of the SGML into a single file,
keep one file per <sect1>, and add a glue file that includes all
of them.
---
doc/src/sgml/custom-rmgr.sgml | 4 ++--
doc/src/sgml/filelist.sgml | 1 +
doc/src/sgml/generic-wal.sgml | 4 ++--
doc/src/sgml/postgres.sgml | 3 +--
doc/src/sgml/wal-for-extensions.sgml | 9 +++++++++
5 files changed, 15 insertions(+), 6 deletions(-)
create mode 100644 doc/src/sgml/wal-for-extensions.sgml
diff --git a/doc/src/sgml/custom-rmgr.sgml b/doc/src/sgml/custom-rmgr.sgml
index 0d98229295..13a5a6a5b1 100644
--- a/doc/src/sgml/custom-rmgr.sgml
+++ b/doc/src/sgml/custom-rmgr.sgml
@@ -1,6 +1,6 @@
<!-- doc/src/sgml/custom-rmgr.sgml -->
-<chapter id="custom-rmgr">
+<sect1 id="custom-rmgr">
<title>Custom WAL Resource Managers</title>
<para>
@@ -102,4 +102,4 @@ extern void RegisterCustomRmgr(RmgrId rmid, const RmgrData *rmgr);
the custom WAL records, which may prevent the server from starting.
</para>
</note>
-</chapter>
+</sect1>
diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml
index b5615e1fce..1bb662c16f 100644
--- a/doc/src/sgml/filelist.sgml
+++ b/doc/src/sgml/filelist.sgml
@@ -106,6 +106,7 @@
<!ENTITY storage SYSTEM "storage.sgml">
<!ENTITY transaction SYSTEM "xact.sgml">
<!ENTITY tablesample-method SYSTEM "tablesample-method.sgml">
+<!ENTITY wal-for-extensions SYSTEM "wal-for-extensions.sgml">
<!ENTITY generic-wal SYSTEM "generic-wal.sgml">
<!ENTITY custom-rmgr SYSTEM "custom-rmgr.sgml">
<!ENTITY backup-manifest SYSTEM "backup-manifest.sgml">
diff --git a/doc/src/sgml/generic-wal.sgml b/doc/src/sgml/generic-wal.sgml
index a028856d2e..ba00ddf100 100644
--- a/doc/src/sgml/generic-wal.sgml
+++ b/doc/src/sgml/generic-wal.sgml
@@ -1,6 +1,6 @@
<!-- doc/src/sgml/generic-wal.sgml -->
-<chapter id="generic-wal">
+<sect1 id="generic-wal">
<title>Generic WAL Records</title>
<para>
@@ -171,4 +171,4 @@
</listitem>
</itemizedlist>
</para>
-</chapter>
+</sect1>
diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml
index 0235c0e352..5bc47a9e71 100644
--- a/doc/src/sgml/postgres.sgml
+++ b/doc/src/sgml/postgres.sgml
@@ -255,8 +255,7 @@ break is not needed in a wider output rendering.
&geqo;
&tableam;
&indexam;
- &generic-wal;
- &custom-rmgr;
+ &wal-for-extensions;
&indextypes;
&storage;
&transaction;
diff --git a/doc/src/sgml/wal-for-extensions.sgml b/doc/src/sgml/wal-for-extensions.sgml
new file mode 100644
index 0000000000..fbebafb5a9
--- /dev/null
+++ b/doc/src/sgml/wal-for-extensions.sgml
@@ -0,0 +1,9 @@
+<!-- doc/src/sgml/wal-for-extensions.sgml -->
+
+<chapter id="wal-for-extensions">
+ <title>Write Ahead Logging for Extensions</title>
+
+&generic-wal;
+&custom-rmgr;
+
+</chapter>
--
2.39.3 (Apple Git-145)