Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pIpvL-0007ax-S2 for pgsql-hackers@arkaria.postgresql.org; Fri, 20 Jan 2023 11:51:12 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.92) (envelope-from ) id 1pIpvJ-0005eq-Lk for pgsql-hackers@arkaria.postgresql.org; Fri, 20 Jan 2023 11:51:09 +0000 Received: from makus.postgresql.org ([2001:4800:3e1:1::229]) by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pIpvI-0005e6-2h for pgsql-hackers@lists.postgresql.org; Fri, 20 Jan 2023 11:51:09 +0000 Received: from wout3-smtp.messagingengine.com ([64.147.123.19]) by makus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pIpvC-0006w1-It for pgsql-hackers@lists.postgresql.org; Fri, 20 Jan 2023 11:51:07 +0000 Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.west.internal (Postfix) with ESMTP id E3AB53200681; Fri, 20 Jan 2023 06:50:59 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Fri, 20 Jan 2023 06:51:00 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:in-reply-to:message-id:mime-version:reply-to:sender :subject:subject:to:to:x-me-proxy:x-me-proxy:x-me-sender :x-me-sender:x-sasl-enc; s=fm3; t=1674215459; x=1674301859; bh=m wW1K1UPjax/057ZQ9qYEXaawRK2VJ/UDsQYlRSuC2o=; b=OfvQggV3TExYu7eLo 73FbdhnpTxIGYCV0V7BI0y6rvP9zRp3C4XQYHpW7UJBbpsxYTtJ63sCYPjWTAfJT N7R9vMM7MAH5qqlHLZgJS8/haBXJfC5T+2/6tBK1/fZRI2XA3agFkUio/Jqzabd2 x6Tbtl3o94kobtSnmOLEVcGz15M1ziGsjxNFMG9y9KBBytF4L70HKQbTmWOsyYTg fcEPAGsHRIMUP/YtIik9GRVd83mxAHBs0MVKXEqRQDWWzG/s3W6nCA0vUKxaKC+F jsQk/vz1VRzUo+TjG3qovs3JMmUdrtNjjPGlpqoiKcQlAMFiejLciTUN6EI37Kbl LW2qg== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrudduvddgfeegucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfffhvfevuffkgggtugfgjgesmhekreertddtjeenucfhrhhomheptehlvhgr rhhoucfjvghrrhgvrhgruceorghlvhhhvghrrhgvsegrlhhvhhdrnhhoqdhiphdrohhrgh eqnecuggftrfgrthhtvghrnhepveehveeuvdekkedvtddvhfdtjeejgeeujeeifeehhfej jefhteetfedvgfdtjefhnecuffhomhgrihhnpegvnhhtvghrphhrihhsvggusgdrtghomh dpthifihhtthgvrhdrtghomhenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhep mhgrihhlfhhrohhmpegrlhhvhhgvrhhrvgesrghlvhhhrdhnohdqihhprdhorhhg X-ME-Proxy: Feedback-ID: ia2694551:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 20 Jan 2023 06:50:58 -0500 (EST) Received: by perhan.alvh.no-ip.org (Postfix, from userid 1000) id 2613598; Fri, 20 Jan 2023 12:42:31 +0100 (CET) Date: Fri, 20 Jan 2023 12:42:31 +0100 From: Alvaro Herrera To: "Karl O. Pinc" Cc: PostgreSQL Hackers Subject: Re: Doc: Rework contrib appendix -- informative titles, tweaked sentences Message-ID: <20230120114231.ykq5s7w4konrx3i6@alvherre.pgsql> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="25vdpgp7jprtb5l7" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20230119120205.55766dd3@slate.karlpinc.com> List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk --25vdpgp7jprtb5l7 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit On 2023-Jan-19, Karl O. Pinc wrote: > On Thu, 19 Jan 2023 11:03:53 -0600 > "Karl O. Pinc" wrote: > > > Attached are 2 patches, a regular and a delta from your v4 review: > > > > contrib_v5-delta.patch.txt > > contrib_v5.patch.txt > > I left your appendix title unchanged: "Additional Supplied > Extensions and Modules". > > I had put "Extensions" after > "Modules", because, apparently, things that come last in the > sentence are most remembered by the reader. My impression is that > more people are looking for extensions than modules. Hmm, I didn't know that. I guess I can put it back. My own instinct is to put the most important stuff first, not last, but if research says to do otherwise, fine, let's do that. I went over all the titles again. There were a couple of mistakes and inconsistencies, which I've fixed to the best of my knowledge. I'm happy with 0001 now and will push shortly unless there are complaints. I'm still unsure of the [trusted]/[obsolete] marker, so I split that out to commit 0002. I would like to see more support for that before pushing that one. I also put the page-split bits to another page, because it seems a bit too clumsy. I hope somebody with more docbook-fu can comment: maybe there's a way to fix it more generally somehow? -- Álvaro Herrera 48°01'N 7°57'E — https://www.EnterpriseDB.com/ "Update: super-fast reaction on the Postgres bugs mailing list. The report was acknowledged [...], and a fix is under discussion. The wonders of open-source !" https://twitter.com/gunnarmorling/status/1596080409259003906 --25vdpgp7jprtb5l7 Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v6-0001-Describe-each-contrib-module-in-its-SGML-section-.patch" From 15cf3a5607ec73900c5e3bb343ab687f1e6990c1 Mon Sep 17 00:00:00 2001 From: Alvaro Herrera Date: Thu, 19 Jan 2023 13:32:35 +0100 Subject: [PATCH v6 1/3] Describe each contrib module in its SGML section title The original titles only had the module name, which is not very useful when scanning the list. By adding a very brief description to each title, the table of contents becomes friendlier. Author: Karl O. Pinc Reviewed-by: Brar Piening Discussion: https://postgr.es/m/20230102180015.372995a9@slate.karlpinc.com --- doc/src/sgml/adminpack.sgml | 2 +- doc/src/sgml/amcheck.sgml | 2 +- doc/src/sgml/auth-delay.sgml | 2 +- doc/src/sgml/auto-explain.sgml | 2 +- doc/src/sgml/basebackup-to-shell.sgml | 2 +- doc/src/sgml/basic-archive.sgml | 2 +- doc/src/sgml/bloom.sgml | 2 +- doc/src/sgml/btree-gin.sgml | 4 +-- doc/src/sgml/btree-gist.sgml | 2 +- doc/src/sgml/citext.sgml | 2 +- doc/src/sgml/contrib-spi.sgml | 2 +- doc/src/sgml/contrib.sgml | 49 +++++++++++++++------------ doc/src/sgml/cube.sgml | 2 +- doc/src/sgml/dblink.sgml | 2 +- doc/src/sgml/dict-int.sgml | 3 +- doc/src/sgml/dict-xsyn.sgml | 2 +- doc/src/sgml/earthdistance.sgml | 2 +- doc/src/sgml/file-fdw.sgml | 2 +- doc/src/sgml/fuzzystrmatch.sgml | 3 +- doc/src/sgml/hstore.sgml | 2 +- doc/src/sgml/intagg.sgml | 2 +- doc/src/sgml/intarray.sgml | 2 +- doc/src/sgml/isn.sgml | 2 +- doc/src/sgml/lo.sgml | 2 +- doc/src/sgml/ltree.sgml | 2 +- doc/src/sgml/oldsnapshot.sgml | 2 +- doc/src/sgml/pageinspect.sgml | 2 +- doc/src/sgml/passwordcheck.sgml | 2 +- doc/src/sgml/pgbuffercache.sgml | 2 +- doc/src/sgml/pgcrypto.sgml | 2 +- doc/src/sgml/pgfreespacemap.sgml | 2 +- doc/src/sgml/pgprewarm.sgml | 2 +- doc/src/sgml/pgrowlocks.sgml | 2 +- doc/src/sgml/pgstatstatements.sgml | 3 +- doc/src/sgml/pgstattuple.sgml | 2 +- doc/src/sgml/pgsurgery.sgml | 2 +- doc/src/sgml/pgtrgm.sgml | 3 +- doc/src/sgml/pgvisibility.sgml | 2 +- doc/src/sgml/pgwalinspect.sgml | 2 +- doc/src/sgml/postgres-fdw.sgml | 3 +- doc/src/sgml/seg.sgml | 2 +- doc/src/sgml/sepgsql.sgml | 3 +- doc/src/sgml/sslinfo.sgml | 2 +- doc/src/sgml/tablefunc.sgml | 2 +- doc/src/sgml/tcn.sgml | 2 +- doc/src/sgml/test-decoding.sgml | 2 +- doc/src/sgml/tsm-system-rows.sgml | 3 +- doc/src/sgml/tsm-system-time.sgml | 3 +- doc/src/sgml/unaccent.sgml | 2 +- doc/src/sgml/uuid-ossp.sgml | 2 +- doc/src/sgml/xml2.sgml | 2 +- 51 files changed, 86 insertions(+), 73 deletions(-) diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml index 184e96d7a0..04f3b52379 100644 --- a/doc/src/sgml/adminpack.sgml +++ b/doc/src/sgml/adminpack.sgml @@ -1,7 +1,7 @@ - adminpack + adminpack — pgAdmin support toolpack adminpack diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml index 923cbde9dd..2b9c1a9205 100644 --- a/doc/src/sgml/amcheck.sgml +++ b/doc/src/sgml/amcheck.sgml @@ -1,7 +1,7 @@ - amcheck + amcheck — tools to verify table and index consistency amcheck diff --git a/doc/src/sgml/auth-delay.sgml b/doc/src/sgml/auth-delay.sgml index 40629311b1..0571f2a99d 100644 --- a/doc/src/sgml/auth-delay.sgml +++ b/doc/src/sgml/auth-delay.sgml @@ -1,7 +1,7 @@ - auth_delay + auth_delay — pause on authentication failure auth_delay diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml index bb7342b120..0c4656ee30 100644 --- a/doc/src/sgml/auto-explain.sgml +++ b/doc/src/sgml/auto-explain.sgml @@ -1,7 +1,7 @@ - auto_explain + auto_explain — log execution plans of slow queries auto_explain diff --git a/doc/src/sgml/basebackup-to-shell.sgml b/doc/src/sgml/basebackup-to-shell.sgml index 491368eb8f..b6a3b39541 100644 --- a/doc/src/sgml/basebackup-to-shell.sgml +++ b/doc/src/sgml/basebackup-to-shell.sgml @@ -1,7 +1,7 @@ - basebackup_to_shell + basebackup_to_shell — example "shell" pg_basebackup module basebackup_to_shell diff --git a/doc/src/sgml/basic-archive.sgml b/doc/src/sgml/basic-archive.sgml index 60f23d2855..b4d43ced20 100644 --- a/doc/src/sgml/basic-archive.sgml +++ b/doc/src/sgml/basic-archive.sgml @@ -1,7 +1,7 @@ - basic_archive + basic_archive — an example WAL archive module basic_archive diff --git a/doc/src/sgml/bloom.sgml b/doc/src/sgml/bloom.sgml index 98d0316175..19f2b172cc 100644 --- a/doc/src/sgml/bloom.sgml +++ b/doc/src/sgml/bloom.sgml @@ -1,7 +1,7 @@ - bloom + bloom — bloom filter index access method bloom diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml index 870c25559e..46117209ce 100644 --- a/doc/src/sgml/btree-gin.sgml +++ b/doc/src/sgml/btree-gin.sgml @@ -1,14 +1,14 @@ - btree_gin + btree_gin — GIN operator classes with B-tree behavior btree_gin - btree_gin provides sample GIN operator classes that + btree_gin provides GIN operator classes that implement B-tree equivalent behavior for the data types int2, int4, int8, float4, float8, timestamp with time zone, diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml index 92aa8e277e..31e7c78aae 100644 --- a/doc/src/sgml/btree-gist.sgml +++ b/doc/src/sgml/btree-gist.sgml @@ -1,7 +1,7 @@ - btree_gist + btree_gist — GiST operator classes with B-tree behavior btree_gist diff --git a/doc/src/sgml/citext.sgml b/doc/src/sgml/citext.sgml index 3df2825592..8322885661 100644 --- a/doc/src/sgml/citext.sgml +++ b/doc/src/sgml/citext.sgml @@ -1,7 +1,7 @@ - citext + citext — a case-insensitive character string type citext diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml index 77328ae6e8..e7cae4e38d 100644 --- a/doc/src/sgml/contrib-spi.sgml +++ b/doc/src/sgml/contrib-spi.sgml @@ -1,7 +1,7 @@ - spi + spi — Server Programming Interface features/examples SPI diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 4e7b87a42f..8816e06337 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -1,27 +1,31 @@ - Additional Supplied Modules + Additional Supplied Extensions and Modules - This appendix and the next one contain information regarding the modules that - can be found in the contrib directory of the + This appendix and the next one contain information on the + optional components + found in the contrib directory of the PostgreSQL distribution. These include porting tools, analysis utilities, - and plug-in features that are not part of the core PostgreSQL system, - mainly because they address a limited audience or are too experimental + and plug-in features that are not part of the core PostgreSQL system. + They are separate mainly + because they address a limited audience or are too experimental to be part of the main source tree. This does not preclude their usefulness. - This appendix covers extensions and other server plug-in modules found in + This appendix covers extensions and other server plug-in module + libraries found in contrib. covers utility programs. - When building from the source distribution, these components are not built + When building from the source distribution, these optional + components are not built automatically, unless you build the "world" target (see ). You can build and install all of them by running: @@ -46,41 +50,42 @@ If you are using a pre-packaged version of PostgreSQL, - these modules are typically made available as a separate subpackage, + these components are typically made available as a separate subpackage, such as postgresql-contrib. - Many modules supply new user-defined functions, operators, or types. - To make use of one of these modules, after you have installed the code + Many components supply new user-defined functions, operators, or types, + packaged as extensions. + To make use of one of these extensions, after you have installed the code you need to register the new SQL objects in the database system. This is done by executing a command. In a fresh database, you can simply do -CREATE EXTENSION module_name; +CREATE EXTENSION extension_name; - This command registers the new SQL objects in the current database only, - so you need to run it in each database that you want - the module's facilities to be available in. Alternatively, run it in + This command only registers the new SQL objects in the current database, + so you need to run it in every database in which you want + the extension's facilities to be available. Alternatively, run it in database template1 so that the extension will be copied into subsequently-created databases by default. - For all these modules, CREATE EXTENSION must be run - by a database superuser, unless the module is - considered trusted, in which case it can be run by any + For all extensions the CREATE EXTENSION must be run + by a database superuser, unless the extension is + considered trusted. Trusted extensions can be run by any user who has CREATE privilege on the current - database. Modules that are trusted are identified as such in the - sections that follow. Generally, trusted modules are ones that cannot + database. Extensions that are trusted are identified as such in the + sections that follow. Generally, trusted extensions are ones that cannot provide access to outside-the-database functionality. - Many modules allow you to install their objects in a schema of your + Many extensions allow you to install their objects in a schema of your choice. To do that, add SCHEMA schema_name to the CREATE EXTENSION command. By default, the objects will be placed in your current creation @@ -88,11 +93,11 @@ CREATE EXTENSION module_name; - Note, however, that some of these modules are not extensions + Note, however, that some of these components are not extensions in this sense, but are loaded into the server in some other way, for instance by way of . See the documentation of each - module for details. + component for details. &adminpack; diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 0744816e7c..0fb7080748 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -1,7 +1,7 @@ - cube + cube — a multi-dimensional cube data type cube (extension) diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml index 50c49f533b..17f9d99b1c 100644 --- a/doc/src/sgml/dblink.sgml +++ b/doc/src/sgml/dblink.sgml @@ -1,7 +1,7 @@ - dblink + dblink — connect to other PostgreSQL databases dblink diff --git a/doc/src/sgml/dict-int.sgml b/doc/src/sgml/dict-int.sgml index 53ae8b6637..8dd07b9bc1 100644 --- a/doc/src/sgml/dict-int.sgml +++ b/doc/src/sgml/dict-int.sgml @@ -1,7 +1,8 @@ - dict_int + dict_int — + example full-text search dictionary for integers dict_int diff --git a/doc/src/sgml/dict-xsyn.sgml b/doc/src/sgml/dict-xsyn.sgml index 27b24628d4..a94c6430ed 100644 --- a/doc/src/sgml/dict-xsyn.sgml +++ b/doc/src/sgml/dict-xsyn.sgml @@ -1,7 +1,7 @@ - dict_xsyn + dict_xsyn — example synonym full-text search dictionary dict_xsyn diff --git a/doc/src/sgml/earthdistance.sgml b/doc/src/sgml/earthdistance.sgml index f15dde3a66..5a709e3d47 100644 --- a/doc/src/sgml/earthdistance.sgml +++ b/doc/src/sgml/earthdistance.sgml @@ -1,7 +1,7 @@ - earthdistance + earthdistance — calculate great-circle distances earthdistance diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml index 5b98782064..56d696c323 100644 --- a/doc/src/sgml/file-fdw.sgml +++ b/doc/src/sgml/file-fdw.sgml @@ -1,7 +1,7 @@ - file_fdw + file_fdw — access data files in the server's file system file_fdw diff --git a/doc/src/sgml/fuzzystrmatch.sgml b/doc/src/sgml/fuzzystrmatch.sgml index 5dedbd8f7a..860f021815 100644 --- a/doc/src/sgml/fuzzystrmatch.sgml +++ b/doc/src/sgml/fuzzystrmatch.sgml @@ -1,7 +1,8 @@ - fuzzystrmatch + fuzzystrmatch — + determine string similarities and distance fuzzystrmatch diff --git a/doc/src/sgml/hstore.sgml b/doc/src/sgml/hstore.sgml index 815ef641a0..7d93e49e91 100644 --- a/doc/src/sgml/hstore.sgml +++ b/doc/src/sgml/hstore.sgml @@ -1,7 +1,7 @@ - hstore + hstore — hstore key/value datatype hstore diff --git a/doc/src/sgml/intagg.sgml b/doc/src/sgml/intagg.sgml index 34562a66c8..44a766eb4b 100644 --- a/doc/src/sgml/intagg.sgml +++ b/doc/src/sgml/intagg.sgml @@ -1,7 +1,7 @@ - intagg + intagg — integer aggregator and enumerator intagg diff --git a/doc/src/sgml/intarray.sgml b/doc/src/sgml/intarray.sgml index c861f50497..c72d49b01d 100644 --- a/doc/src/sgml/intarray.sgml +++ b/doc/src/sgml/intarray.sgml @@ -1,7 +1,7 @@ - intarray + intarray — manipulate arrays of integers intarray diff --git a/doc/src/sgml/isn.sgml b/doc/src/sgml/isn.sgml index 14bf2d14aa..ea2aabc87d 100644 --- a/doc/src/sgml/isn.sgml +++ b/doc/src/sgml/isn.sgml @@ -1,7 +1,7 @@ - isn + isn — data types for international standard numbers (ISBN, EAN, UPC, etc.) isn diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index d6076aeb7f..6d9bcebd42 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -1,7 +1,7 @@ - lo + lo — manage large objects lo diff --git a/doc/src/sgml/ltree.sgml b/doc/src/sgml/ltree.sgml index 45a86188cb..bb66e33944 100644 --- a/doc/src/sgml/ltree.sgml +++ b/doc/src/sgml/ltree.sgml @@ -1,7 +1,7 @@ - ltree + ltree — hierarchical tree-like data type ltree diff --git a/doc/src/sgml/oldsnapshot.sgml b/doc/src/sgml/oldsnapshot.sgml index 0e03084562..2e37087738 100644 --- a/doc/src/sgml/oldsnapshot.sgml +++ b/doc/src/sgml/oldsnapshot.sgml @@ -1,7 +1,7 @@ - old_snapshot + old_snapshot — inspect <literal>old_snapshot_threshold</literal> state old_snapshot diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml index 8674872e8b..01f1e96204 100644 --- a/doc/src/sgml/pageinspect.sgml +++ b/doc/src/sgml/pageinspect.sgml @@ -1,7 +1,7 @@ - pageinspect + pageinspect — low-level inspection of database pages pageinspect diff --git a/doc/src/sgml/passwordcheck.sgml b/doc/src/sgml/passwordcheck.sgml index 0d89bb95b9..601f489227 100644 --- a/doc/src/sgml/passwordcheck.sgml +++ b/doc/src/sgml/passwordcheck.sgml @@ -1,7 +1,7 @@ - passwordcheck + passwordcheck — verify password strength passwordcheck diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml index 7b118f2030..f5d1901af2 100644 --- a/doc/src/sgml/pgbuffercache.sgml +++ b/doc/src/sgml/pgbuffercache.sgml @@ -1,7 +1,7 @@ - pg_buffercache + pg_buffercache — inspect Postgres buffer cache state pg_buffercache diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml index bde3071923..2e29f1d6f7 100644 --- a/doc/src/sgml/pgcrypto.sgml +++ b/doc/src/sgml/pgcrypto.sgml @@ -1,7 +1,7 @@ - pgcrypto + pgcrypto — cryptographic functions pgcrypto diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index 9d93fb5a72..829ad60f32 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -1,7 +1,7 @@ - pg_freespacemap + pg_freespacemap — examine the free space map pg_freespacemap diff --git a/doc/src/sgml/pgprewarm.sgml b/doc/src/sgml/pgprewarm.sgml index e103a2746d..75f45b91b6 100644 --- a/doc/src/sgml/pgprewarm.sgml +++ b/doc/src/sgml/pgprewarm.sgml @@ -1,7 +1,7 @@ - pg_prewarm + pg_prewarm — preload relation data into buffer caches pg_prewarm diff --git a/doc/src/sgml/pgrowlocks.sgml b/doc/src/sgml/pgrowlocks.sgml index 91dfd452ee..b5e655735a 100644 --- a/doc/src/sgml/pgrowlocks.sgml +++ b/doc/src/sgml/pgrowlocks.sgml @@ -1,7 +1,7 @@ - pgrowlocks + pgrowlocks — show a table's row locking information pgrowlocks diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index ded33acd18..abdee744ac 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -1,7 +1,8 @@ - pg_stat_statements + pg_stat_statements — + track statistics of SQL planning and execution pg_stat_statements diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml index 581bea2788..4071da4ed9 100644 --- a/doc/src/sgml/pgstattuple.sgml +++ b/doc/src/sgml/pgstattuple.sgml @@ -1,7 +1,7 @@ - pgstattuple + pgstattuple — obtain tuple-level statistics pgstattuple diff --git a/doc/src/sgml/pgsurgery.sgml b/doc/src/sgml/pgsurgery.sgml index 6c6be70c24..29bccd7f36 100644 --- a/doc/src/sgml/pgsurgery.sgml +++ b/doc/src/sgml/pgsurgery.sgml @@ -1,7 +1,7 @@ - pg_surgery + pg_surgery — perform low-level surgery on relation data pg_surgery diff --git a/doc/src/sgml/pgtrgm.sgml b/doc/src/sgml/pgtrgm.sgml index f0344590dd..07bfcac931 100644 --- a/doc/src/sgml/pgtrgm.sgml +++ b/doc/src/sgml/pgtrgm.sgml @@ -1,7 +1,8 @@ - pg_trgm + pg_trgm — + support for similarity of text using trigram matching pg_trgm diff --git a/doc/src/sgml/pgvisibility.sgml b/doc/src/sgml/pgvisibility.sgml index 68c43b7f39..097f7e0566 100644 --- a/doc/src/sgml/pgvisibility.sgml +++ b/doc/src/sgml/pgvisibility.sgml @@ -1,7 +1,7 @@ - pg_visibility + pg_visibility — visibility map information and utilities pg_visibility diff --git a/doc/src/sgml/pgwalinspect.sgml b/doc/src/sgml/pgwalinspect.sgml index 08eedab071..119e162e60 100644 --- a/doc/src/sgml/pgwalinspect.sgml +++ b/doc/src/sgml/pgwalinspect.sgml @@ -1,7 +1,7 @@ - pg_walinspect + pg_walinspect — low-level WAL inspection pg_walinspect diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml index 78f2d7d8d5..644f51835b 100644 --- a/doc/src/sgml/postgres-fdw.sgml +++ b/doc/src/sgml/postgres-fdw.sgml @@ -1,7 +1,8 @@ - postgres_fdw + postgres_fdw — + access data stored in external Postgres servers postgres_fdw diff --git a/doc/src/sgml/seg.sgml b/doc/src/sgml/seg.sgml index 72387c7d45..dc66e24f2f 100644 --- a/doc/src/sgml/seg.sgml +++ b/doc/src/sgml/seg.sgml @@ -1,7 +1,7 @@ - seg + seg — a datatype for line segments or floating point intervals seg diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml index fd4bb83cbf..b368e587cb 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -1,7 +1,8 @@ - sepgsql + sepgsql — + SELinux-, label-based mandatory access control (MAC) security module sepgsql diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index 786f113072..85d49f6653 100644 --- a/doc/src/sgml/sslinfo.sgml +++ b/doc/src/sgml/sslinfo.sgml @@ -1,7 +1,7 @@ - sslinfo + sslinfo — obtain client SSL information sslinfo diff --git a/doc/src/sgml/tablefunc.sgml b/doc/src/sgml/tablefunc.sgml index c1b70953f0..e10fe7009d 100644 --- a/doc/src/sgml/tablefunc.sgml +++ b/doc/src/sgml/tablefunc.sgml @@ -1,7 +1,7 @@ - tablefunc + tablefunc — functions that return tables (<function>crosstab</function> and others) tablefunc diff --git a/doc/src/sgml/tcn.sgml b/doc/src/sgml/tcn.sgml index 82afe9ada4..32a1025cc6 100644 --- a/doc/src/sgml/tcn.sgml +++ b/doc/src/sgml/tcn.sgml @@ -1,7 +1,7 @@ - tcn + tcn — a trigger function to notify listeners of changes to table content tcn diff --git a/doc/src/sgml/test-decoding.sgml b/doc/src/sgml/test-decoding.sgml index 9b07195427..5d1ae8f4f5 100644 --- a/doc/src/sgml/test-decoding.sgml +++ b/doc/src/sgml/test-decoding.sgml @@ -1,7 +1,7 @@ - test_decoding + test_decoding — SQL-based test/example module for WAL logical decoding test_decoding diff --git a/doc/src/sgml/tsm-system-rows.sgml b/doc/src/sgml/tsm-system-rows.sgml index f5357791c0..e3fb4d15dd 100644 --- a/doc/src/sgml/tsm-system-rows.sgml +++ b/doc/src/sgml/tsm-system-rows.sgml @@ -1,7 +1,8 @@ - tsm_system_rows + tsm_system_rows — + the <literal>SYSTEM_ROWS</literal> sampling method for <literal>TABLESAMPLE</literal> tsm_system_rows diff --git a/doc/src/sgml/tsm-system-time.sgml b/doc/src/sgml/tsm-system-time.sgml index 0de15ae7e8..05c6be0cac 100644 --- a/doc/src/sgml/tsm-system-time.sgml +++ b/doc/src/sgml/tsm-system-time.sgml @@ -1,7 +1,8 @@ - tsm_system_time + tsm_system_time — + the <literal>SYSTEM_TIME</literal> sampling method for <literal>TABLESAMPLE</literal> tsm_system_time diff --git a/doc/src/sgml/unaccent.sgml b/doc/src/sgml/unaccent.sgml index 139a87d4ff..f3ddc64bbc 100644 --- a/doc/src/sgml/unaccent.sgml +++ b/doc/src/sgml/unaccent.sgml @@ -1,7 +1,7 @@ - unaccent + unaccent — a text search dictionary which removes diacritics unaccent diff --git a/doc/src/sgml/uuid-ossp.sgml b/doc/src/sgml/uuid-ossp.sgml index 0a42d516e8..6f851ac85f 100644 --- a/doc/src/sgml/uuid-ossp.sgml +++ b/doc/src/sgml/uuid-ossp.sgml @@ -1,7 +1,7 @@ - uuid-ossp + uuid-ossp — a UUID generator uuid-ossp diff --git a/doc/src/sgml/xml2.sgml b/doc/src/sgml/xml2.sgml index e9a223ca5b..9fd613f967 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -1,7 +1,7 @@ - xml2 + xml2 — XPath querying and XSLT functionality xml2 -- 2.30.2 --25vdpgp7jprtb5l7 Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v6-0002-Install-trusted-and-obsolete-markers-in-section-t.patch" From 8cc5e8a38305c604d03138ffa8607559465995b5 Mon Sep 17 00:00:00 2001 From: Alvaro Herrera Date: Fri, 20 Jan 2023 12:32:22 +0100 Subject: [PATCH v6 2/3] Install [trusted] and [obsolete] markers in section title I'm not sure about this part. --- doc/src/sgml/btree-gin.sgml | 2 +- doc/src/sgml/btree-gist.sgml | 2 +- doc/src/sgml/citext.sgml | 2 +- doc/src/sgml/cube.sgml | 2 +- doc/src/sgml/dict-int.sgml | 2 +- doc/src/sgml/fuzzystrmatch.sgml | 2 +- doc/src/sgml/hstore.sgml | 2 +- doc/src/sgml/intagg.sgml | 2 +- doc/src/sgml/intarray.sgml | 2 +- doc/src/sgml/isn.sgml | 2 +- doc/src/sgml/lo.sgml | 2 +- doc/src/sgml/ltree.sgml | 2 +- doc/src/sgml/pgcrypto.sgml | 2 +- doc/src/sgml/pgtrgm.sgml | 2 +- doc/src/sgml/seg.sgml | 2 +- doc/src/sgml/tablefunc.sgml | 2 +- doc/src/sgml/tcn.sgml | 2 +- doc/src/sgml/tsm-system-rows.sgml | 2 +- doc/src/sgml/tsm-system-time.sgml | 2 +- doc/src/sgml/unaccent.sgml | 2 +- doc/src/sgml/uuid-ossp.sgml | 2 +- doc/src/sgml/xml2.sgml | 2 +- 22 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml index 46117209ce..db96f02ba9 100644 --- a/doc/src/sgml/btree-gin.sgml +++ b/doc/src/sgml/btree-gin.sgml @@ -1,7 +1,7 @@ - btree_gin — GIN operator classes with B-tree behavior + btree_gin — GIN operator classes with B-tree behavior [trusted] btree_gin diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml index 31e7c78aae..be14779a92 100644 --- a/doc/src/sgml/btree-gist.sgml +++ b/doc/src/sgml/btree-gist.sgml @@ -1,7 +1,7 @@ - btree_gist — GiST operator classes with B-tree behavior + btree_gist — GiST operator classes with B-tree behavior [trusted] btree_gist diff --git a/doc/src/sgml/citext.sgml b/doc/src/sgml/citext.sgml index 8322885661..ff8a98c21b 100644 --- a/doc/src/sgml/citext.sgml +++ b/doc/src/sgml/citext.sgml @@ -1,7 +1,7 @@ - citext — a case-insensitive character string type + citext — a case-insensitive character string type [trusted] citext diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 0fb7080748..1998e6d81a 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -1,7 +1,7 @@ - cube — a multi-dimensional cube data type + cube — a multi-dimensional cube data type [trusted] cube (extension) diff --git a/doc/src/sgml/dict-int.sgml b/doc/src/sgml/dict-int.sgml index 8dd07b9bc1..293ba83ce6 100644 --- a/doc/src/sgml/dict-int.sgml +++ b/doc/src/sgml/dict-int.sgml @@ -2,7 +2,7 @@ dict_int — - example full-text search dictionary for integers + example full-text search dictionary for integers [trusted] dict_int diff --git a/doc/src/sgml/fuzzystrmatch.sgml b/doc/src/sgml/fuzzystrmatch.sgml index 860f021815..2c6a666da8 100644 --- a/doc/src/sgml/fuzzystrmatch.sgml +++ b/doc/src/sgml/fuzzystrmatch.sgml @@ -2,7 +2,7 @@ fuzzystrmatch — - determine string similarities and distance + determine string similarities and distance [trusted] fuzzystrmatch diff --git a/doc/src/sgml/hstore.sgml b/doc/src/sgml/hstore.sgml index 7d93e49e91..b75c63f348 100644 --- a/doc/src/sgml/hstore.sgml +++ b/doc/src/sgml/hstore.sgml @@ -1,7 +1,7 @@ - hstore — hstore key/value datatype + hstore — hstore key/value datatype [trusted] hstore diff --git a/doc/src/sgml/intagg.sgml b/doc/src/sgml/intagg.sgml index 44a766eb4b..ce7b929a34 100644 --- a/doc/src/sgml/intagg.sgml +++ b/doc/src/sgml/intagg.sgml @@ -1,7 +1,7 @@ - intagg — integer aggregator and enumerator + intagg — integer aggregator and enumerator [obsolete] intagg diff --git a/doc/src/sgml/intarray.sgml b/doc/src/sgml/intarray.sgml index c72d49b01d..9194e94c28 100644 --- a/doc/src/sgml/intarray.sgml +++ b/doc/src/sgml/intarray.sgml @@ -1,7 +1,7 @@ - intarray — manipulate arrays of integers + intarray — manipulate arrays of integers [trusted] intarray diff --git a/doc/src/sgml/isn.sgml b/doc/src/sgml/isn.sgml index ea2aabc87d..a609969af9 100644 --- a/doc/src/sgml/isn.sgml +++ b/doc/src/sgml/isn.sgml @@ -1,7 +1,7 @@ - isn — data types for international standard numbers (ISBN, EAN, UPC, etc.) + isn — data types for international standard numbers (ISBN, EAN, UPC, etc.) [trusted] isn diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index 6d9bcebd42..511e576cac 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -1,7 +1,7 @@ - lo — manage large objects + lo — manage large objects [trusted] lo diff --git a/doc/src/sgml/ltree.sgml b/doc/src/sgml/ltree.sgml index bb66e33944..25d98e3f7d 100644 --- a/doc/src/sgml/ltree.sgml +++ b/doc/src/sgml/ltree.sgml @@ -1,7 +1,7 @@ - ltree — hierarchical tree-like data type + ltree — hierarchical tree-like data type [trusted] ltree diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml index 2e29f1d6f7..2231a65dde 100644 --- a/doc/src/sgml/pgcrypto.sgml +++ b/doc/src/sgml/pgcrypto.sgml @@ -1,7 +1,7 @@ - pgcrypto — cryptographic functions + pgcrypto — cryptographic functions [trusted] pgcrypto diff --git a/doc/src/sgml/pgtrgm.sgml b/doc/src/sgml/pgtrgm.sgml index 07bfcac931..1497172762 100644 --- a/doc/src/sgml/pgtrgm.sgml +++ b/doc/src/sgml/pgtrgm.sgml @@ -2,7 +2,7 @@ pg_trgm — - support for similarity of text using trigram matching + support for similarity of text using trigram matching [trusted] pg_trgm diff --git a/doc/src/sgml/seg.sgml b/doc/src/sgml/seg.sgml index dc66e24f2f..4656dff681 100644 --- a/doc/src/sgml/seg.sgml +++ b/doc/src/sgml/seg.sgml @@ -1,7 +1,7 @@ - seg — a datatype for line segments or floating point intervals + seg — a datatype for line segments or floating point intervals [trusted] seg diff --git a/doc/src/sgml/tablefunc.sgml b/doc/src/sgml/tablefunc.sgml index e10fe7009d..79f721886a 100644 --- a/doc/src/sgml/tablefunc.sgml +++ b/doc/src/sgml/tablefunc.sgml @@ -1,7 +1,7 @@ - tablefunc — functions that return tables (<function>crosstab</function> and others) + tablefunc — functions that return tables (<function>crosstab</function> and others) [trusted] tablefunc diff --git a/doc/src/sgml/tcn.sgml b/doc/src/sgml/tcn.sgml index 32a1025cc6..a848e622e1 100644 --- a/doc/src/sgml/tcn.sgml +++ b/doc/src/sgml/tcn.sgml @@ -1,7 +1,7 @@ - tcn — a trigger function to notify listeners of changes to table content + tcn — a trigger function to notify listeners of changes to table content [trusted] tcn diff --git a/doc/src/sgml/tsm-system-rows.sgml b/doc/src/sgml/tsm-system-rows.sgml index e3fb4d15dd..c36e0c7662 100644 --- a/doc/src/sgml/tsm-system-rows.sgml +++ b/doc/src/sgml/tsm-system-rows.sgml @@ -2,7 +2,7 @@ tsm_system_rows — - the <literal>SYSTEM_ROWS</literal> sampling method for <literal>TABLESAMPLE</literal> + the SYSTEM_ROWS sampling method for TABLESAMPLE [trusted] tsm_system_rows diff --git a/doc/src/sgml/tsm-system-time.sgml b/doc/src/sgml/tsm-system-time.sgml index 05c6be0cac..10fd27abb6 100644 --- a/doc/src/sgml/tsm-system-time.sgml +++ b/doc/src/sgml/tsm-system-time.sgml @@ -2,7 +2,7 @@ tsm_system_time — - the <literal>SYSTEM_TIME</literal> sampling method for <literal>TABLESAMPLE</literal> + the SYSTEM_TIME sampling method for TABLESAMPLE [trusted] tsm_system_time diff --git a/doc/src/sgml/unaccent.sgml b/doc/src/sgml/unaccent.sgml index f3ddc64bbc..7b02b66530 100644 --- a/doc/src/sgml/unaccent.sgml +++ b/doc/src/sgml/unaccent.sgml @@ -1,7 +1,7 @@ - unaccent — a text search dictionary which removes diacritics + unaccent — a text search dictionary which removes diacritics [trusted] unaccent diff --git a/doc/src/sgml/uuid-ossp.sgml b/doc/src/sgml/uuid-ossp.sgml index 6f851ac85f..43b49e2b5a 100644 --- a/doc/src/sgml/uuid-ossp.sgml +++ b/doc/src/sgml/uuid-ossp.sgml @@ -1,7 +1,7 @@ - uuid-ossp — a UUID generator + uuid-ossp — a UUID generator [trusted] uuid-ossp diff --git a/doc/src/sgml/xml2.sgml b/doc/src/sgml/xml2.sgml index 9fd613f967..2bd4a3fd3a 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -1,7 +1,7 @@ - xml2 — XPath querying and XSLT functionality + xml2 — XPath querying and XSLT functionality [obsolete] xml2 -- 2.30.2 --25vdpgp7jprtb5l7 Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v6-0003-Install-pagebreaks-between-contrib-section.patch" From 1d40f660d22d4965d3e026972edcaf419d4431f1 Mon Sep 17 00:00:00 2001 From: Alvaro Herrera Date: Fri, 20 Jan 2023 11:55:44 +0100 Subject: [PATCH v6 3/3] Install pagebreaks between contrib section This makes the PDF much more readable, but I don't like the mechanism used. --- doc/src/sgml/contrib.sgml | 54 ++++++++++++++++++++++++++++++++-- doc/src/sgml/stylesheet-fo.xsl | 6 ++++ 2 files changed, 58 insertions(+), 2 deletions(-) diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 8816e06337..e412680e46 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -35,8 +35,8 @@ in the contrib directory of a configured source tree; or to build and install - just one selected module, do the same in that module's subdirectory. - Many of the modules have regression tests, which can be executed by + just one selection, do the same in that selection's subdirectory. + Many have regression tests, which can be executed by running: make check @@ -100,55 +100,105 @@ CREATE EXTENSION extension_name; component for details. + &adminpack; + &amcheck; + &auth-delay; + &auto-explain; + &basebackup-to-shell; + &basic-archive; + &bloom; + &btree-gin; + &btree-gist; + &citext; + &cube; + &dblink; + &dict-int; + &dict-xsyn; + &earthdistance; + &file-fdw; + &fuzzystrmatch; + &hstore; + &intagg; + &intarray; + &isn; + &lo; + <ree; + &oldsnapshot; + &pageinspect; + &passwordcheck; + &pgbuffercache; + &pgcrypto; + &pgfreespacemap; + &pgprewarm; + &pgrowlocks; + &pgstatstatements; + &pgstattuple; + &pgsurgery; + &pgtrgm; + &pgvisibility; + &pgwalinspect; + &postgres-fdw; + &seg; + &sepgsql; + &contrib-spi; + &sslinfo; + &tablefunc; + &tcn; + &test-decoding; + &tsm-system-rows; + &tsm-system-time; + &unaccent; + &uuid-ossp; + &xml2; diff --git a/doc/src/sgml/stylesheet-fo.xsl b/doc/src/sgml/stylesheet-fo.xsl index 0c4dff92c4..9dde0a89dd 100644 --- a/doc/src/sgml/stylesheet-fo.xsl +++ b/doc/src/sgml/stylesheet-fo.xsl @@ -132,4 +132,10 @@ + + + + + -- 2.30.2 --25vdpgp7jprtb5l7--