pgsql: Doc: fix "Unresolved ID reference" warnings, clean up man page c

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: fix "Unresolved ID reference" warnings, clean up man page c
Date: 2020-05-11 18:16:11
Message-ID: E1jYCyJ-0002Yj-35@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Doc: fix "Unresolved ID reference" warnings, clean up man page cross-refs.

Use xreflabel attributes instead of endterm attributes to control the
appearance of links to subsections of SQL command reference pages.
This is simpler, it matches what we do elsewhere (e.g. for GUC variables),
and it doesn't draw "Unresolved ID reference" warnings from the PDF
toolchain.

Fix some places where the text was absolutely dependent on an <xref>
rendering exactly so, by using a <link> around the required text
instead. At least one of those spots had already been turned into
bad grammar by subsequent changes, and the whole idea is just too
fragile for my taste. <xref> does NOT have fixed output, don't write
as if it does.

Consistently include a page-level link in cross-man-page references,
because otherwise they are useless/nonsensical in man-page output.
Likewise, be consistent about mentioning "below" or "above" in same-page
references; we were doing that in about 90% of the cases, but now it's
100%.

Also get rid of another nonfunctional-in-PDF idea, of making
cross-references to functions by sticking ID tags on <row> constructs.
We can put the IDs on <indexterm>s instead --- which is probably not any
more sensible in abstract terms, but it works where the other doesn't.
(There is talk of attaching cross-reference IDs to most or all of
the docs' function descriptions, but for now I just fixed the two
that exist.)

Discussion: https://postgr.es/m/14480.1589154358@sss.pgh.pa.us

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/60c90c16c1885bb9aa2047b66f958b865c5d397e

Modified Files
--------------
doc/src/sgml/config.sgml | 3 +-
doc/src/sgml/func.sgml | 8 +-
doc/src/sgml/indices.sgml | 3 +-
doc/src/sgml/maintenance.sgml | 3 +-
doc/src/sgml/queries.sgml | 8 +-
doc/src/sgml/ref/alter_collation.sgml | 7 +-
doc/src/sgml/ref/alter_table.sgml | 16 ++--
doc/src/sgml/ref/create_aggregate.sgml | 8 +-
doc/src/sgml/ref/create_index.sgml | 15 ++--
doc/src/sgml/ref/create_materialized_view.sgml | 5 +-
doc/src/sgml/ref/create_table.sgml | 14 ++--
doc/src/sgml/ref/create_table_as.sgml | 4 +-
doc/src/sgml/ref/declare.sgml | 8 +-
doc/src/sgml/ref/delete.sgml | 4 +-
doc/src/sgml/ref/execute.sgml | 5 +-
doc/src/sgml/ref/insert.sgml | 11 ++-
doc/src/sgml/ref/lock.sgml | 5 +-
doc/src/sgml/ref/pg_dump.sgml | 25 +++---
doc/src/sgml/ref/pg_dumpall.sgml | 3 +-
doc/src/sgml/ref/postgres-ref.sgml | 7 +-
doc/src/sgml/ref/prepare.sgml | 4 +-
doc/src/sgml/ref/psql-ref.sgml | 67 +++++++---------
doc/src/sgml/ref/reindex.sgml | 7 +-
doc/src/sgml/ref/select.sgml | 102 ++++++++++++-------------
doc/src/sgml/ref/update.sgml | 5 +-
doc/src/sgml/ref/values.sgml | 13 ++--
26 files changed, 167 insertions(+), 193 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Julien Rouhaud 2020-05-11 19:46:32 Re: Add "-Wimplicit-fallthrough" to default flags (was Re: pgsql: Support FETCH FIRST WITH TIES)
Previous Message Peter Geoghegan 2020-05-11 18:02:57 pgsql: Adjust "root of to-be-deleted subtree" function.