postgresql/doc/src/sgml
Peter Eisentraut 721856ff24 Remove distprep
A PostgreSQL release tarball contains a number of prebuilt files, in
particular files produced by bison, flex, perl, and well as html and
man documentation.  We have done this consistent with established
practice at the time to not require these tools for building from a
tarball.  Some of these tools were hard to get, or get the right
version of, from time to time, and shipping the prebuilt output was a
convenience to users.

Now this has at least two problems:

One, we have to make the build system(s) work in two modes: Building
from a git checkout and building from a tarball.  This is pretty
complicated, but it works so far for autoconf/make.  It does not
currently work for meson; you can currently only build with meson from
a git checkout.  Making meson builds work from a tarball seems very
difficult or impossible.  One particular problem is that since meson
requires a separate build directory, we cannot make the build update
files like gram.h in the source tree.  So if you were to build from a
tarball and update gram.y, you will have a gram.h in the source tree
and one in the build tree, but the way things work is that the
compiler will always use the one in the source tree.  So you cannot,
for example, make any gram.y changes when building from a tarball.
This seems impossible to fix in a non-horrible way.

Second, there is increased interest nowadays in precisely tracking the
origin of software.  We can reasonably track contributions into the
git tree, and users can reasonably track the path from a tarball to
packages and downloads and installs.  But what happens between the git
tree and the tarball is obscure and in some cases non-reproducible.

The solution for both of these issues is to get rid of the step that
adds prebuilt files to the tarball.  The tarball now only contains
what is in the git tree (*).  Getting the additional build
dependencies is no longer a problem nowadays, and the complications to
keep these dual build modes working are significant.  And of course we
want to get the meson build system working universally.

This commit removes the make distprep target altogether.  The make
dist target continues to do its job, it just doesn't call distprep
anymore.

(*) - The tarball also contains the INSTALL file that is built at make
dist time, but not by distprep.  This is unchanged for now.

The make maintainer-clean target, whose job it is to remove the
prebuilt files in addition to what make distclean does, is now just an
alias to make distprep.  (In practice, it is probably obsolete given
that git clean is available.)

The following programs are now hard build requirements in configure
(they were already required by meson.build):

- bison
- flex
- perl

Reviewed-by: Michael Paquier <michael@paquier.xyz>
Reviewed-by: Andres Freund <andres@anarazel.de>
Discussion: https://www.postgresql.org/message-id/flat/e07408d9-e5f2-d9fd-5672-f53354e9305e@eisentraut.org
2023-11-06 15:18:04 +01:00
..
images Stop recommending auto-download of DTD files, and indeed disable it. 2023-02-08 17:15:25 -05:00
keywords doc: Update SQL keywords list to SQL:2023 2023-04-05 07:55:28 +02:00
ref doc: pg_resetwal: Add comments how the multipliers are derived 2023-11-06 09:16:00 +01:00
.gitignore Generate automatically code and documentation related to wait events 2023-07-05 10:53:11 +09:00
Makefile Remove distprep 2023-11-06 15:18:04 +01:00
README.links
acronyms.sgml doc: New glossary entries 2023-05-04 07:32:09 +02:00
adminpack.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
advanced.sgml Remove trailing whitespace from *.sgml files. 2022-04-20 11:04:49 -04:00
amcheck.sgml Teach contrib/amcheck to check the unique constraint violation 2023-10-28 00:21:23 +03:00
appendix-obsolete-default-roles.sgml Fix file references inside some SGML comments 2022-06-20 14:33:41 +02:00
appendix-obsolete-pgreceivexlog.sgml Fix file references inside some SGML comments 2022-06-20 14:33:41 +02:00
appendix-obsolete-pgresetxlog.sgml Fix file references inside some SGML comments 2022-06-20 14:33:41 +02:00
appendix-obsolete-pgxlogdump.sgml Fix file references inside some SGML comments 2022-06-20 14:33:41 +02:00
appendix-obsolete-recovery-config.sgml Remove promote_trigger_file. 2022-11-29 12:08:38 +13:00
appendix-obsolete.sgml Revert "Rename contrib module basic_archive to basic_wal_module" 2023-01-26 09:13:39 +09:00
arch-dev.sgml Doc: Miscellaneous doc updates for MERGE. 2023-02-26 09:06:04 +00:00
archive-modules.sgml doc: Fix some typos and grammar 2023-04-12 13:03:09 +09:00
array.sgml
auth-delay.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
auto-explain.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
backup-manifest.sgml Fix file references inside some SGML comments 2022-06-20 14:33:41 +02:00
backup.sgml doc: Additional information about timeline ID hexadecimal format 2023-03-20 08:48:46 +01:00
basebackup-to-shell.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
basic-archive.sgml Revert "Rename contrib module basic_archive to basic_wal_module" 2023-01-26 09:13:39 +09:00
bgworker.sgml Add option to bgworkers to allow the bypass of role login check 2023-10-12 09:24:17 +09:00
biblio.sgml
bki.sgml Add support event triggers on authenticated login 2023-10-16 03:18:22 +03:00
bloom.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
brin.sgml Doc: add missed entries in BRIN extensibility tables. 2023-04-10 15:50:29 -04:00
btree-gin.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
btree-gist.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
btree.sgml doc: add section about heap-only tuples (HOT) 2022-08-12 15:05:13 -04:00
catalogs.sgml doc: Fix some grammar and inconsistent tags 2023-10-23 09:58:55 +09:00
charset.sgml doc: wording improvements 2023-10-27 17:23:34 -04:00
citext.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
client-auth.sgml doc: move HBA reload instructions above the syntax details 2023-11-03 14:03:22 -04:00
color.sgml Add color support for new frontend detail/hint messages 2022-04-11 17:36:44 +02:00
config.sgml Doc: Make link names consistent in logical replication commands. 2023-10-30 10:46:31 +05:30
contrib-spi.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
contrib.sgml Remove the "snapshot too old" feature. 2023-09-05 19:53:43 +12:00
cube.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
custom-rmgr.sgml doc: Fix some grammar and inconsistent tags 2023-10-23 09:58:55 +09:00
custom-scan.sgml Doc: Improve documentation for creating custom scan paths. 2023-08-30 17:45:00 +09:00
datatype.sgml doc: improve bpchar and character type length details 2023-10-31 10:13:11 -04:00
datetime.sgml doc: add missing word to sentence about Paris 2023-10-31 13:18:42 -04:00
dblink.sgml dblink: Replace WAIT_EVENT_EXTENSION with custom wait events 2023-10-05 10:23:22 +09:00
ddl.sgml Catalog not-null constraints 2023-08-25 13:31:24 +02:00
dfunc.sgml Remove HP-UX port. 2022-07-08 14:05:05 +12:00
dict-int.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
dict-xsyn.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
diskusage.sgml
dml.sgml
docguide.sgml doc: fix Apple Silicon Homebrew prefix change documentation 2023-03-27 14:16:45 +02:00
earthdistance.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
ecpg.sgml Doc: remove misleading info about ecpg's CONNECT/DISCONNECT DEFAULT. 2023-10-25 17:34:51 -04:00
errcodes.sgml
event-trigger.sgml Add support event triggers on authenticated login 2023-10-16 03:18:22 +03:00
extend.sgml Add @extschema:name@ and no_relocate options to extensions. 2023-03-20 18:37:11 -04:00
external-projects.sgml doc: Replace list of drivers and PLs with wiki link 2023-08-23 14:13:07 +02:00
fdwhandler.sgml Re-allow FDWs and custom scan providers to replace joins with pseudoconstant quals. 2023-08-15 16:45:00 +09:00
features.sgml Add XMLText function (SQL/XML X038) 2023-11-06 09:38:29 +01:00
file-fdw.sgml doc: Add example for how to set file_fdw column option 2023-09-18 14:59:16 +02:00
filelist.sgml Allow using syncfs() in frontend utilities. 2023-09-06 16:27:16 -07:00
func.sgml Add XMLText function (SQL/XML X038) 2023-11-06 09:38:29 +01:00
fuzzystrmatch.sgml Add support for Daitch-Mokotoff Soundex in contrib/fuzzystrmatch. 2023-04-07 17:32:26 -04:00
generate-errcodes-table.pl Update copyright for 2023 2023-01-02 15:00:37 -05:00
generate-keywords-table.pl doc: Update SQL keywords list to SQL:2023 2023-04-05 07:55:28 +02:00
generic-wal.sgml Custom WAL Resource Managers. 2022-04-06 23:06:46 -07:00
geqo.sgml Doc: add XML ID attributes to <sectN> and <varlistentry> tags. 2023-01-09 15:08:24 -05:00
gin.sgml
gist.sgml
glossary.sgml doc: New glossary entries 2023-05-04 07:32:09 +02:00
hash.sgml
high-availability.sgml doc: wording improvements 2023-10-27 17:23:34 -04:00
history.sgml doc: rename "decades" to be more generic 2023-06-23 22:50:55 -04:00
hstore.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
indexam.sgml Doc: indexUnchanged is strictly a hint. 2023-10-24 09:27:27 -07:00
indices.sgml doc: wording improvements 2023-10-27 17:23:34 -04:00
info.sgml
information_schema.sgml doc: Clarify not-null constraints in information schema 2023-10-04 15:03:48 +02:00
install-binaries.sgml
install-windows.sgml doc: Tell about "vcregress taptest" for regression tests on Windows 2023-09-26 08:16:12 +09:00
installation.sgml Remove distprep 2023-11-06 15:18:04 +01:00
intagg.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
intarray.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
intro.sgml doc: add links to Postgres features intro 2023-10-28 14:02:46 -04:00
isn.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
jit.sgml Add JIT deform_counter 2023-09-08 15:05:12 +02:00
json.sgml SQL JSON path enhanced numeric literals 2023-03-05 15:19:58 +01:00
keywords.sgml
legal.sgml Update copyright for 2023 2023-01-02 15:00:37 -05:00
libpq.sgml Reword memory terminology for PQresultMemorySize 2023-10-24 22:18:19 +02:00
limits.sgml doc: add function argument and query parameter limits 2023-10-31 09:23:09 -04:00
lo.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
lobj.sgml Update copyright for 2023 2023-01-02 15:00:37 -05:00
logical-replication.sgml Doc: Make link names consistent in logical replication commands. 2023-10-30 10:46:31 +05:30
logicaldecoding.sgml doc: wording improvements 2023-10-27 17:23:34 -04:00
ltree.sgml Validate ltree siglen GiST option to be int-aligned 2023-04-23 14:30:09 +03:00
maintenance.sgml doc: improve text around consistency of statistics values 2023-10-27 21:24:55 -04:00
manage-ag.sgml doc: CREATE DATABASE doesn't copy db-level perms. from template 2023-11-03 13:39:50 -04:00
meson.build meson: docs: Install all manpages, not just ones in man1 2023-11-03 14:48:52 -07:00
mk_feature_tables.pl Pre-beta mechanical code beautification. 2023-05-19 17:24:48 -04:00
monitoring.sgml Introduce pg_stat_checkpointer 2023-10-30 09:47:16 +09:00
mvcc.sgml Doc: minor wording adjustments in transaction isolation discussion. 2023-06-28 12:48:14 -04:00
nls.sgml doc: Fix some typos and grammar 2023-10-25 09:40:55 +09:00
notation.sgml
oid2name.sgml |--- gitweb subject length limit ----------------|-email limit-| 2023-10-27 11:06:10 -04:00
pageinspect.sgml pageinspect: Fix gist_page_items() with included columns 2023-05-19 12:37:58 +09:00
parallel.sgml Fix typos in comments, code and documentation 2023-01-03 16:26:14 +09:00
passwordcheck.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
perform.sgml Doc: Miscellaneous doc updates for MERGE. 2023-02-26 09:06:04 +00:00
pgbuffercache.sgml Add missing XML ID attribute 2023-04-13 09:48:38 +02:00
pgcrypto.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgfreespacemap.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgprewarm.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgrowlocks.sgml pgrowlocks: change lock mode output labels for consistency 2023-09-26 17:41:48 -04:00
pgstatstatements.sgml pg_stat_statements: Add local_blk_{read|write}_time 2023-10-19 14:03:31 +09:00
pgstattuple.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgsurgery.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgtrgm.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgvisibility.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
pgwalinspect.sgml doc: Fix some typos and grammar 2023-10-25 09:40:55 +09:00
planstats.sgml C comment: improve statistics computation comment example 2023-10-31 11:42:02 -04:00
plhandler.sgml doc: use wording "restore" instead of "reload" of dumps 2022-07-21 14:55:23 -04:00
plperl.sgml Doc: clarify behavior of row-limit arguments in the PLs' SPI wrappers. 2023-05-02 17:55:01 -04:00
plpgsql.sgml doc: Replace reference to ERRCODE_RAISE_EXCEPTION by "raise_exception" 2023-11-02 07:33:02 +09:00
plpython.sgml Doc: clarify behavior of row-limit arguments in the PLs' SPI wrappers. 2023-05-02 17:55:01 -04:00
pltcl.sgml Doc: clarify behavior of row-limit arguments in the PLs' SPI wrappers. 2023-05-02 17:55:01 -04:00
postgres-fdw.sgml postgres_fdw: Replace WAIT_EVENT_EXTENSION with custom wait events 2023-10-05 09:50:42 +09:00
postgres.sgml Allow using syncfs() in frontend utilities. 2023-09-06 16:27:16 -07:00
problems.sgml Doc: add XML ID attributes to <sectN> and <varlistentry> tags. 2023-01-09 15:08:24 -05:00
protocol.sgml doc: add reference to wire protocol details 2023-11-01 13:57:29 -04:00
queries.sgml doc: change "cross product" to "Cartesian product" 2023-09-07 15:48:18 -04:00
query.sgml Doc: improve tutorial section about grouped aggregates. 2022-11-08 18:25:03 -05:00
rangetypes.sgml
reference.sgml Don't install postmaster symlink anymore 2023-01-26 11:33:01 +01:00
regress.sgml doc: Extend documentation of PG_TEST_EXTRA 2023-09-08 11:34:43 +02:00
release-17.sgml Stamp HEAD as 17devel. 2023-06-29 19:05:23 -04:00
release.sgml Stamp HEAD as 17devel. 2023-06-29 19:05:23 -04:00
replication-origins.sgml Refer to replication origin roident as "ID" in user facing messages and docs 2022-08-18 08:57:13 +07:00
rowtypes.sgml Doc: add XML ID attributes to <sectN> and <varlistentry> tags. 2023-01-09 15:08:24 -05:00
rules.sgml Doc: add XML ID attributes to <sectN> and <varlistentry> tags. 2023-01-09 15:08:24 -05:00
runtime.sgml doc: Add note to prevent server spoofing with SCRAM 2023-06-03 17:44:09 -04:00
seg.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
sepgsql.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
sourcerepo.sgml Remove distprep 2023-11-06 15:18:04 +01:00
sources.sgml doc: Clarify where ereport severity levels are defined 2023-09-28 15:33:37 +02:00
spgist.sgml doc: Fix network_ops -> inet_ops in SpGiST operator class list 2023-01-25 20:00:36 +09:00
spi.sgml Don't crash if cursor_to_xmlschema is used on a non-data-returning Portal. 2023-09-18 14:28:17 -04:00
sslinfo.sgml Revert "Add notBefore and notAfter to SSL cert info display" 2023-07-20 17:18:12 +02:00
standalone-install.xml doc: Add installation instructions for building with meson 2022-12-01 15:32:38 +01:00
standalone-profile.xsl Fix generation of distribution tarball 2023-04-19 13:59:52 +09:00
start.sgml
storage.sgml doc: 1-byte varlena headers can be used for user PLAIN storage 2023-10-31 09:10:35 -04:00
stylesheet-common.xsl doc: New glossary entries 2023-05-04 07:32:09 +02:00
stylesheet-fo.xsl doc/PDF: Add page breaks for <sect1> in contrib appendix 2023-03-20 14:01:09 +01:00
stylesheet-html-common.xsl doc: Make HTML ids discoverable 2023-04-13 10:16:33 +02:00
stylesheet-html-nochunk.xsl docs: html: load stylesheet via custom.css.source 2023-04-04 21:29:45 -07:00
stylesheet-man.xsl
stylesheet-speedup-common.xsl
stylesheet-speedup-xhtml.xsl
stylesheet-text.xsl
stylesheet.css doc: Make HTML ids discoverable 2023-04-13 10:16:33 +02:00
stylesheet.css.xml docs: html: load stylesheet via custom.css.source 2023-04-04 21:29:45 -07:00
stylesheet.xsl docs: html: load stylesheet via custom.css.source 2023-04-04 21:29:45 -07:00
syncfs.sgml Allow using syncfs() in frontend utilities. 2023-09-06 16:27:16 -07:00
syntax.sgml doc: mention ORDER BY for some aggregates, add ORDER BY examples 2023-11-03 13:05:27 -04:00
system-views.sgml Doc: Make link names consistent in logical replication commands. 2023-10-30 10:46:31 +05:30
tableam.sgml Fix doc oversight for custom WAL resource managers. 2022-08-25 10:26:31 -07:00
tablefunc.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
tablesample-method.sgml
tcn.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
test-decoding.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
textsearch.sgml Replace link to Hunspell with the current homepage 2022-11-21 23:25:48 +01:00
trigger.sgml Doc: Update struct Trigger definition. 2022-09-02 16:45:00 +09:00
tsm-system-rows.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
tsm-system-time.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
typeconv.sgml
unaccent.sgml unaccent: Add support for quoted translated characters 2023-09-20 12:29:36 +09:00
user-manag.sgml doc: clarify how the bootstrap user name is chosen 2023-10-10 15:27:26 -04:00
uuid-ossp.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
vacuumlo.sgml
version.sgml.in meson: Add initial version of meson based build system 2022-09-21 22:37:17 -07:00
wal.sgml Remove wal_sync_method=fsync_writethrough on Windows. 2023-07-14 12:30:13 +12:00
xact.sgml doc: Fix some typos and grammar 2023-10-25 09:40:55 +09:00
xaggr.sgml Remove trailing whitespace from *.sgml files. 2022-04-20 11:04:49 -04:00
xfunc.sgml doc: Expand section related to LWLocks and shared memory 2023-11-01 14:54:13 +09:00
xindex.sgml Doc fix: Interfacing Extensions to Indexes 2023-10-25 13:26:11 -07:00
xml2.sgml Describe each contrib module in its SGML section title 2023-01-20 20:01:59 +01:00
xmltools_dep_wrapper meson: docs: Add xml{lint,proc} wrapper to collect dependencies 2022-10-05 09:56:05 -07:00
xoper.sgml Extend ALTER OPERATOR to allow setting more optimization attributes. 2023-10-20 12:28:46 -04:00
xplang.sgml
xtypes.sgml

README.links

<!-- doc/src/sgml/README.links -->

Linking within DocBook documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get chapter/section number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title

<link>
	use to supply text for the link, only uses linkend, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html
	can be embedded inside of <command>, unlike <xref>


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link
	text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

- For an internal link, if you want to supply text, use <link>, else
  <xref>.

- Specific nouns like GUC variables, SQL commands, and contrib modules
  usually have xreflabels.

- For an external link, use <ulink>, with or without link text.

- xreflabels added to tags prevent the chapter/section for id's from being
  referenced;  only the xreflabel is accessible.  Therefore, use xreflabels
  only when linking is common, and chapter/section information is unneeded.