pgsql: Convert documentation to DocBook XML - Mailing list pgsql-committers

From Peter Eisentraut
Subject pgsql: Convert documentation to DocBook XML
Date
Msg-id E1eHsqZ-0004co-9d@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
Convert documentation to DocBook XML

Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/3c49c6facb22cdea979f5d1465ba53f972d32163

Modified Files
--------------
config/docbook.m4                                 |  22 +-
configure                                         | 158 +------
configure.in                                      |   4 +-
doc/src/sgml/Makefile                             |  93 ++--
doc/src/sgml/adminpack.sgml                       |  14 +-
doc/src/sgml/advanced.sgml                        |  22 +-
doc/src/sgml/amcheck.sgml                         |   8 +-
doc/src/sgml/arch-dev.sgml                        |  14 +-
doc/src/sgml/array.sgml                           |  18 +-
doc/src/sgml/auth-delay.sgml                      |   2 +-
doc/src/sgml/auto-explain.sgml                    |   6 +-
doc/src/sgml/backup.sgml                          |  82 ++--
doc/src/sgml/bgworker.sgml                        |   2 +-
doc/src/sgml/brin.sgml                            |   8 +-
doc/src/sgml/catalogs.sgml                        | 202 ++++-----
doc/src/sgml/charset.sgml                         |  36 +-
doc/src/sgml/client-auth.sgml                     |  88 ++--
doc/src/sgml/config.sgml                          | 362 +++++++--------
doc/src/sgml/contrib.sgml                         |  18 +-
doc/src/sgml/cube.sgml                            |   6 +-
doc/src/sgml/custom-scan.sgml                     |   2 +-
doc/src/sgml/datatype.sgml                        | 176 ++++----
doc/src/sgml/datetime.sgml                        |   8 +-
doc/src/sgml/dblink.sgml                          |  10 +-
doc/src/sgml/ddl.sgml                             | 126 +++---
doc/src/sgml/dfunc.sgml                           |   2 +-
doc/src/sgml/dict-int.sgml                        |   2 +-
doc/src/sgml/dict-xsyn.sgml                       |   2 +-
doc/src/sgml/diskusage.sgml                       |  10 +-
doc/src/sgml/dml.sgml                             |  24 +-
doc/src/sgml/docguide.sgml                        | 217 +--------
doc/src/sgml/earthdistance.sgml                   |   4 +-
doc/src/sgml/ecpg.sgml                            | 192 ++++----
doc/src/sgml/errcodes.sgml                        |   8 +-
doc/src/sgml/event-trigger.sgml                   |  18 +-
doc/src/sgml/extend.sgml                          |  56 +--
doc/src/sgml/external-projects.sgml               |   6 +-
doc/src/sgml/fdwhandler.sgml                      |  40 +-
doc/src/sgml/file-fdw.sgml                        |   2 +-
doc/src/sgml/func.sgml                            | 520 +++++++++++-----------
doc/src/sgml/geqo.sgml                            |   6 +-
doc/src/sgml/gin.sgml                             |  24 +-
doc/src/sgml/gist.sgml                            |   6 +-
doc/src/sgml/high-availability.sgml               | 154 +++----
doc/src/sgml/history.sgml                         |  16 +-
doc/src/sgml/hstore.sgml                          |   8 +-
doc/src/sgml/indexam.sgml                         |  26 +-
doc/src/sgml/indices.sgml                         |  72 +--
doc/src/sgml/information_schema.sgml              |  28 +-
doc/src/sgml/install-windows.sgml                 |   6 +-
doc/src/sgml/installation.sgml                    |  50 +--
doc/src/sgml/intarray.sgml                        |   4 +-
doc/src/sgml/intro.sgml                           |  14 +-
doc/src/sgml/isn.sgml                             |   4 +-
doc/src/sgml/json.sgml                            |  12 +-
doc/src/sgml/keywords.sgml                        |   8 +-
doc/src/sgml/libpq.sgml                           | 156 +++----
doc/src/sgml/lo.sgml                              |   2 +-
doc/src/sgml/lobj.sgml                            |  14 +-
doc/src/sgml/logical-replication.sgml             |  28 +-
doc/src/sgml/logicaldecoding.sgml                 |  44 +-
doc/src/sgml/ltree.sgml                           |   6 +-
doc/src/sgml/maintenance.sgml                     |  80 ++--
doc/src/sgml/manage-ag.sgml                       |  38 +-
doc/src/sgml/monitoring.sgml                      | 108 ++---
doc/src/sgml/mvcc.sgml                            |  66 +--
doc/src/sgml/nls.sgml                             |   2 +-
doc/src/sgml/oid2name.sgml                        |   2 +-
doc/src/sgml/parallel.sgml                        |  34 +-
doc/src/sgml/passwordcheck.sgml                   |   8 +-
doc/src/sgml/perform.sgml                         |  68 +--
doc/src/sgml/pgbuffercache.sgml                   |   2 +-
doc/src/sgml/pgcrypto.sgml                        |   8 +-
doc/src/sgml/pgprewarm.sgml                       |   2 +-
doc/src/sgml/pgrowlocks.sgml                      |   2 +-
doc/src/sgml/pgstandby.sgml                       |   8 +-
doc/src/sgml/pgstatstatements.sgml                |   8 +-
doc/src/sgml/pgstattuple.sgml                     |   4 +-
doc/src/sgml/pgtrgm.sgml                          |   4 +-
doc/src/sgml/planstats.sgml                       |   6 +-
doc/src/sgml/plhandler.sgml                       |  14 +-
doc/src/sgml/plperl.sgml                          |  22 +-
doc/src/sgml/plpgsql.sgml                         | 166 +++----
doc/src/sgml/plpython.sgml                        |  30 +-
doc/src/sgml/pltcl.sgml                           |  16 +-
doc/src/sgml/postgres-fdw.sgml                    |  40 +-
doc/src/sgml/postgres.sgml                        |  26 +-
doc/src/sgml/problems.sgml                        |   2 +-
doc/src/sgml/protocol.sgml                        |  60 +--
doc/src/sgml/queries.sgml                         |  56 +--
doc/src/sgml/query.sgml                           |   8 +-
doc/src/sgml/rangetypes.sgml                      |  14 +-
doc/src/sgml/recovery-config.sgml                 |  34 +-
doc/src/sgml/ref/abort.sgml                       |  10 +-
doc/src/sgml/ref/alter_aggregate.sgml             |   6 +-
doc/src/sgml/ref/alter_collation.sgml             |   6 +-
doc/src/sgml/ref/alter_conversion.sgml            |   4 +-
doc/src/sgml/ref/alter_database.sgml              |  12 +-
doc/src/sgml/ref/alter_default_privileges.sgml    |  14 +-
doc/src/sgml/ref/alter_domain.sgml                |   8 +-
doc/src/sgml/ref/alter_event_trigger.sgml         |   6 +-
doc/src/sgml/ref/alter_extension.sgml             |   6 +-
doc/src/sgml/ref/alter_foreign_data_wrapper.sgml  |   4 +-
doc/src/sgml/ref/alter_foreign_table.sgml         |  28 +-
doc/src/sgml/ref/alter_function.sgml              |  22 +-
doc/src/sgml/ref/alter_group.sgml                 |  12 +-
doc/src/sgml/ref/alter_index.sgml                 |  18 +-
doc/src/sgml/ref/alter_language.sgml              |   4 +-
doc/src/sgml/ref/alter_large_object.sgml          |   2 +-
doc/src/sgml/ref/alter_materialized_view.sgml     |   8 +-
doc/src/sgml/ref/alter_opclass.sgml               |   6 +-
doc/src/sgml/ref/alter_operator.sgml              |   4 +-
doc/src/sgml/ref/alter_opfamily.sgml              |  14 +-
doc/src/sgml/ref/alter_policy.sgml                |   8 +-
doc/src/sgml/ref/alter_publication.sgml           |  12 +-
doc/src/sgml/ref/alter_role.sgml                  |  44 +-
doc/src/sgml/ref/alter_rule.sgml                  |   4 +-
doc/src/sgml/ref/alter_schema.sgml                |   4 +-
doc/src/sgml/ref/alter_sequence.sgml              |   4 +-
doc/src/sgml/ref/alter_server.sgml                |   4 +-
doc/src/sgml/ref/alter_statistics.sgml            |   4 +-
doc/src/sgml/ref/alter_subscription.sgml          |  16 +-
doc/src/sgml/ref/alter_system.sgml                |  10 +-
doc/src/sgml/ref/alter_table.sgml                 |  56 +--
doc/src/sgml/ref/alter_tablespace.sgml            |  10 +-
doc/src/sgml/ref/alter_trigger.sgml               |   4 +-
doc/src/sgml/ref/alter_tsconfig.sgml              |   4 +-
doc/src/sgml/ref/alter_tsdictionary.sgml          |   4 +-
doc/src/sgml/ref/alter_tsparser.sgml              |   4 +-
doc/src/sgml/ref/alter_tstemplate.sgml            |   4 +-
doc/src/sgml/ref/alter_type.sgml                  |   6 +-
doc/src/sgml/ref/alter_user.sgml                  |   4 +-
doc/src/sgml/ref/alter_user_mapping.sgml          |   4 +-
doc/src/sgml/ref/alter_view.sgml                  |   4 +-
doc/src/sgml/ref/analyze.sgml                     |  22 +-
doc/src/sgml/ref/begin.sgml                       |  26 +-
doc/src/sgml/ref/checkpoint.sgml                  |   6 +-
doc/src/sgml/ref/close.sgml                       |   8 +-
doc/src/sgml/ref/cluster.sgml                     |  10 +-
doc/src/sgml/ref/clusterdb.sgml                   |  10 +-
doc/src/sgml/ref/comment.sgml                     |   2 +-
doc/src/sgml/ref/commit.sgml                      |   6 +-
doc/src/sgml/ref/commit_prepared.sgml             |   4 +-
doc/src/sgml/ref/copy.sgml                        |   6 +-
doc/src/sgml/ref/create_access_method.sgml        |   8 +-
doc/src/sgml/ref/create_aggregate.sgml            |  20 +-
doc/src/sgml/ref/create_cast.sgml                 |  10 +-
doc/src/sgml/ref/create_collation.sgml            |  10 +-
doc/src/sgml/ref/create_conversion.sgml           |   6 +-
doc/src/sgml/ref/create_database.sgml             |  18 +-
doc/src/sgml/ref/create_domain.sgml               |   4 +-
doc/src/sgml/ref/create_event_trigger.sgml        |  12 +-
doc/src/sgml/ref/create_extension.sgml            |   6 +-
doc/src/sgml/ref/create_foreign_data_wrapper.sgml |  10 +-
doc/src/sgml/ref/create_foreign_table.sgml        |  16 +-
doc/src/sgml/ref/create_function.sgml             |  36 +-
doc/src/sgml/ref/create_group.sgml                |   4 +-
doc/src/sgml/ref/create_index.sgml                |  38 +-
doc/src/sgml/ref/create_language.sgml             |  20 +-
doc/src/sgml/ref/create_materialized_view.sgml    |  20 +-
doc/src/sgml/ref/create_opclass.sgml              |  12 +-
doc/src/sgml/ref/create_operator.sgml             |  16 +-
doc/src/sgml/ref/create_opfamily.sgml             |  12 +-
doc/src/sgml/ref/create_policy.sgml               |   8 +-
doc/src/sgml/ref/create_publication.sgml          |   6 +-
doc/src/sgml/ref/create_role.sgml                 |  36 +-
doc/src/sgml/ref/create_rule.sgml                 |  10 +-
doc/src/sgml/ref/create_schema.sgml               |   4 +-
doc/src/sgml/ref/create_sequence.sgml             |   6 +-
doc/src/sgml/ref/create_server.sgml               |  16 +-
doc/src/sgml/ref/create_statistics.sgml           |   8 +-
doc/src/sgml/ref/create_subscription.sgml         |  18 +-
doc/src/sgml/ref/create_table.sgml                | 100 ++---
doc/src/sgml/ref/create_table_as.sgml             |  42 +-
doc/src/sgml/ref/create_tablespace.sgml           |  18 +-
doc/src/sgml/ref/create_transform.sgml            |  10 +-
doc/src/sgml/ref/create_trigger.sgml              |  18 +-
doc/src/sgml/ref/create_tsconfig.sgml             |   6 +-
doc/src/sgml/ref/create_tsdictionary.sgml         |   6 +-
doc/src/sgml/ref/create_tsparser.sgml             |   6 +-
doc/src/sgml/ref/create_tstemplate.sgml           |   6 +-
doc/src/sgml/ref/create_type.sgml                 |  26 +-
doc/src/sgml/ref/create_user.sgml                 |   4 +-
doc/src/sgml/ref/create_user_mapping.sgml         |   8 +-
doc/src/sgml/ref/create_view.sgml                 |  26 +-
doc/src/sgml/ref/createdb.sgml                    |  16 +-
doc/src/sgml/ref/createuser.sgml                  |  16 +-
doc/src/sgml/ref/deallocate.sgml                  |   6 +-
doc/src/sgml/ref/declare.sgml                     |  28 +-
doc/src/sgml/ref/delete.sgml                      |  10 +-
doc/src/sgml/ref/discard.sgml                     |   2 +-
doc/src/sgml/ref/do.sgml                          |   2 +-
doc/src/sgml/ref/drop_access_method.sgml          |   4 +-
doc/src/sgml/ref/drop_aggregate.sgml              |   8 +-
doc/src/sgml/ref/drop_cast.sgml                   |   2 +-
doc/src/sgml/ref/drop_collation.sgml              |   6 +-
doc/src/sgml/ref/drop_conversion.sgml             |   4 +-
doc/src/sgml/ref/drop_database.sgml               |   4 +-
doc/src/sgml/ref/drop_domain.sgml                 |   6 +-
doc/src/sgml/ref/drop_event_trigger.sgml          |   6 +-
doc/src/sgml/ref/drop_extension.sgml              |   6 +-
doc/src/sgml/ref/drop_foreign_data_wrapper.sgml   |   6 +-
doc/src/sgml/ref/drop_foreign_table.sgml          |   6 +-
doc/src/sgml/ref/drop_function.sgml               |   6 +-
doc/src/sgml/ref/drop_group.sgml                  |   4 +-
doc/src/sgml/ref/drop_index.sgml                  |   4 +-
doc/src/sgml/ref/drop_language.sgml               |   8 +-
doc/src/sgml/ref/drop_materialized_view.sgml      |   8 +-
doc/src/sgml/ref/drop_opclass.sgml                |   8 +-
doc/src/sgml/ref/drop_operator.sgml               |   6 +-
doc/src/sgml/ref/drop_opfamily.sgml               |  12 +-
doc/src/sgml/ref/drop_owned.sgml                  |  10 +-
doc/src/sgml/ref/drop_policy.sgml                 |   4 +-
doc/src/sgml/ref/drop_publication.sgml            |   4 +-
doc/src/sgml/ref/drop_role.sgml                   |  12 +-
doc/src/sgml/ref/drop_rule.sgml                   |   6 +-
doc/src/sgml/ref/drop_schema.sgml                 |   6 +-
doc/src/sgml/ref/drop_sequence.sgml               |   6 +-
doc/src/sgml/ref/drop_server.sgml                 |   6 +-
doc/src/sgml/ref/drop_statistics.sgml             |   4 +-
doc/src/sgml/ref/drop_subscription.sgml           |   6 +-
doc/src/sgml/ref/drop_table.sgml                  |  10 +-
doc/src/sgml/ref/drop_tablespace.sgml             |   6 +-
doc/src/sgml/ref/drop_transform.sgml              |   6 +-
doc/src/sgml/ref/drop_trigger.sgml                |   4 +-
doc/src/sgml/ref/drop_tsconfig.sgml               |   6 +-
doc/src/sgml/ref/drop_tsdictionary.sgml           |   6 +-
doc/src/sgml/ref/drop_tsparser.sgml               |   6 +-
doc/src/sgml/ref/drop_tstemplate.sgml             |   6 +-
doc/src/sgml/ref/drop_type.sgml                   |   6 +-
doc/src/sgml/ref/drop_user.sgml                   |   4 +-
doc/src/sgml/ref/drop_user_mapping.sgml           |   4 +-
doc/src/sgml/ref/drop_view.sgml                   |   6 +-
doc/src/sgml/ref/dropdb.sgml                      |  12 +-
doc/src/sgml/ref/dropuser.sgml                    |  12 +-
doc/src/sgml/ref/ecpg-ref.sgml                    |   4 +-
doc/src/sgml/ref/end.sgml                         |  12 +-
doc/src/sgml/ref/execute.sgml                     |  10 +-
doc/src/sgml/ref/explain.sgml                     |   6 +-
doc/src/sgml/ref/fetch.sgml                       |  12 +-
doc/src/sgml/ref/grant.sgml                       |  32 +-
doc/src/sgml/ref/import_foreign_schema.sgml       |   4 +-
doc/src/sgml/ref/initdb.sgml                      |  18 +-
doc/src/sgml/ref/insert.sgml                      |   8 +-
doc/src/sgml/ref/listen.sgml                      |   6 +-
doc/src/sgml/ref/load.sgml                        |   6 +-
doc/src/sgml/ref/lock.sgml                        |  16 +-
doc/src/sgml/ref/move.sgml                        |   8 +-
doc/src/sgml/ref/notify.sgml                      |   6 +-
doc/src/sgml/ref/pg_basebackup.sgml               |  28 +-
doc/src/sgml/ref/pg_ctl-ref.sgml                  |  14 +-
doc/src/sgml/ref/pg_dump.sgml                     |  46 +-
doc/src/sgml/ref/pg_dumpall.sgml                  |  12 +-
doc/src/sgml/ref/pg_isready.sgml                  |   4 +-
doc/src/sgml/ref/pg_receivewal.sgml               |  22 +-
doc/src/sgml/ref/pg_recvlogical.sgml              |  20 +-
doc/src/sgml/ref/pg_resetwal.sgml                 |   2 +-
doc/src/sgml/ref/pg_restore.sgml                  |  22 +-
doc/src/sgml/ref/pg_rewind.sgml                   |   6 +-
doc/src/sgml/ref/pg_waldump.sgml                  |   2 +-
doc/src/sgml/ref/pgarchivecleanup.sgml            |   6 +-
doc/src/sgml/ref/pgbench.sgml                     |   6 +-
doc/src/sgml/ref/pgtestfsync.sgml                 |   6 +-
doc/src/sgml/ref/pgtesttiming.sgml                |   2 +-
doc/src/sgml/ref/pgupgrade.sgml                   |  20 +-
doc/src/sgml/ref/postgres-ref.sgml                |  52 +--
doc/src/sgml/ref/postmaster.sgml                  |   2 +-
doc/src/sgml/ref/prepare.sgml                     |  14 +-
doc/src/sgml/ref/prepare_transaction.sgml         |  14 +-
doc/src/sgml/ref/psql-ref.sgml                    |  76 ++--
doc/src/sgml/ref/reassign_owned.sgml              |  10 +-
doc/src/sgml/ref/refresh_materialized_view.sgml   |   8 +-
doc/src/sgml/ref/reindex.sgml                     |   4 +-
doc/src/sgml/ref/reindexdb.sgml                   |  12 +-
doc/src/sgml/ref/release_savepoint.sgml           |  12 +-
doc/src/sgml/ref/reset.sgml                       |  12 +-
doc/src/sgml/ref/revoke.sgml                      |  10 +-
doc/src/sgml/ref/rollback.sgml                    |   8 +-
doc/src/sgml/ref/rollback_prepared.sgml           |   4 +-
doc/src/sgml/ref/rollback_to.sgml                 |  12 +-
doc/src/sgml/ref/savepoint.sgml                   |  14 +-
doc/src/sgml/ref/security_label.sgml              |   2 +-
doc/src/sgml/ref/select.sgml                      |  68 +--
doc/src/sgml/ref/select_into.sgml                 |  16 +-
doc/src/sgml/ref/set.sgml                         |  16 +-
doc/src/sgml/ref/set_role.sgml                    |   8 +-
doc/src/sgml/ref/set_session_auth.sgml            |   6 +-
doc/src/sgml/ref/set_transaction.sgml             |  12 +-
doc/src/sgml/ref/show.sgml                        |  12 +-
doc/src/sgml/ref/start_transaction.sgml           |  18 +-
doc/src/sgml/ref/truncate.sgml                    |   4 +-
doc/src/sgml/ref/unlisten.sgml                    |   6 +-
doc/src/sgml/ref/update.sgml                      |   6 +-
doc/src/sgml/ref/vacuum.sgml                      |  18 +-
doc/src/sgml/ref/vacuumdb.sgml                    |  14 +-
doc/src/sgml/ref/values.sgml                      |  16 +-
doc/src/sgml/reference.sgml                       |   2 +-
doc/src/sgml/regress.sgml                         |  12 +-
doc/src/sgml/release-10.sgml                      |  80 ++--
doc/src/sgml/release-7.4.sgml                     | 104 ++---
doc/src/sgml/release-8.0.sgml                     |  98 ++--
doc/src/sgml/release-8.1.sgml                     |  88 ++--
doc/src/sgml/release-8.2.sgml                     |  78 ++--
doc/src/sgml/release-8.3.sgml                     |  90 ++--
doc/src/sgml/release-8.4.sgml                     |  86 ++--
doc/src/sgml/release-9.0.sgml                     |  86 ++--
doc/src/sgml/release-9.1.sgml                     |  98 ++--
doc/src/sgml/release-9.2.sgml                     | 114 ++---
doc/src/sgml/release-9.3.sgml                     | 112 ++---
doc/src/sgml/release-9.4.sgml                     | 240 +++++-----
doc/src/sgml/release-9.5.sgml                     | 118 ++---
doc/src/sgml/release-9.6.sgml                     |  86 ++--
doc/src/sgml/release-old.sgml                     |  22 +-
doc/src/sgml/replication-origins.sgml             |   2 +-
doc/src/sgml/rowtypes.sgml                        |  10 +-
doc/src/sgml/rules.sgml                           |  10 +-
doc/src/sgml/runtime.sgml                         | 116 ++---
doc/src/sgml/seg.sgml                             |   8 +-
doc/src/sgml/sepgsql.sgml                         |  18 +-
doc/src/sgml/sourcerepo.sgml                      |   2 +-
doc/src/sgml/sources.sgml                         |  10 +-
doc/src/sgml/spgist.sgml                          |  18 +-
doc/src/sgml/spi.sgml                             |  12 +-
doc/src/sgml/standalone-install.xml               |  12 +-
doc/src/sgml/start.sgml                           |  10 +-
doc/src/sgml/storage.sgml                         |  32 +-
doc/src/sgml/syntax.sgml                          |  96 ++--
doc/src/sgml/tablefunc.sgml                       |   4 +-
doc/src/sgml/tablesample-method.sgml              |   2 +-
doc/src/sgml/textsearch.sgml                      |  62 +--
doc/src/sgml/trigger.sgml                         |  20 +-
doc/src/sgml/tsm-system-rows.sgml                 |   2 +-
doc/src/sgml/tsm-system-time.sgml                 |   2 +-
doc/src/sgml/typeconv.sgml                        |  24 +-
doc/src/sgml/user-manag.sgml                      |  36 +-
doc/src/sgml/uuid-ossp.sgml                       |   6 +-
doc/src/sgml/vacuumlo.sgml                        |   4 +-
doc/src/sgml/wal.sgml                             |  62 +--
doc/src/sgml/xaggr.sgml                           |  18 +-
doc/src/sgml/xfunc.sgml                           |  66 +--
doc/src/sgml/xindex.sgml                          |  38 +-
doc/src/sgml/xml2.sgml                            |   4 +-
doc/src/sgml/xoper.sgml                           |   2 +-
doc/src/sgml/xplang.sgml                          |  18 +-
doc/src/sgml/xtypes.sgml                          |   6 +-
src/Makefile.global.in                            |   2 -
346 files changed, 4257 insertions(+), 4585 deletions(-)


pgsql-committers by date:

Previous
From: Simon Riggs
Date:
Subject: Re: pgsql: Generational memory allocator
Next
From: Tomas Vondra
Date:
Subject: Re: pgsql: Generational memory allocator