Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

Started by jian he7 months ago6 messageshackers
Jump to latest
#1jian he
jian.universality@gmail.com

hi.

with commit like:
https://git.postgresql.org/cgit/postgresql.git/commit/?id=78ee60ed84bb3a1cf0b6bd9a715dcbcf252a90f5

we can make a url link that points directly to a specific subsection
of the document.
for example:
https://www.postgresql.org/docs/devel/sql-createtable.html#SQL-CREATETABLE-PARMS-LIKE-OPT-COMMENTS
will link to exactly the CREATE TABLE LIKE INCLUDING COMMENTS section.

The attached patch adds XML ID attributes to <varlistentry> tags for
create_foreign_table.sgml,
and alter_foreign_table.sgml.
While working on CREATE TABLE LIKE, I happened to find this issue.
Maybe we can have a way to automate all <varlistentry>, but there are
so many <varlistentry>.

Attachments:

v1-0001-Doc-add-XML-ID-attributes-to-varlistentry-tags-for-create_foreign.patchtext/x-patch; charset=US-ASCII; name=v1-0001-Doc-add-XML-ID-attributes-to-varlistentry-tags-for-create_foreign.patchDownload+22-23
v1-0002-Doc-add-XML-ID-attributes-to-varlistentry-tags-for-alter_foreign_.patchtext/x-patch; charset=US-ASCII; name=v1-0002-Doc-add-XML-ID-attributes-to-varlistentry-tags-for-alter_foreign_.patchDownload+34-35
#2Quan Zongliang
quanzongliang@yeah.net
In reply to: jian he (#1)
Re: Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

On 9/19/25 11:08 AM, jian he wrote:

hi.

with commit like:
https://git.postgresql.org/cgit/postgresql.git/commit/?id=78ee60ed84bb3a1cf0b6bd9a715dcbcf252a90f5

we can make a url link that points directly to a specific subsection
of the document.
for example:
https://www.postgresql.org/docs/devel/sql-createtable.html#SQL-CREATETABLE-PARMS-LIKE-OPT-COMMENTS
will link to exactly the CREATE TABLE LIKE INCLUDING COMMENTS section.

The attached patch adds XML ID attributes to <varlistentry> tags for
create_foreign_table.sgml,
and alter_foreign_table.sgml.
While working on CREATE TABLE LIKE, I happened to find this issue.
Maybe we can have a way to automate all <varlistentry>, but there are
so many <varlistentry>.

LGTM

And I tested this patch on macOS Intel.

--
Quan Zongliang

#3Quan Zongliang
quanzongliang@yeah.net
In reply to: Quan Zongliang (#2)
Re: Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

On 9/22/25 9:27 AM, Quan Zongliang wrote:

On 9/19/25 11:08 AM, jian he wrote:

hi.

with commit like:
https://git.postgresql.org/cgit/postgresql.git/commit/?
id=78ee60ed84bb3a1cf0b6bd9a715dcbcf252a90f5

we can make a url link that points directly to a specific subsection
of the document.
for example:
https://www.postgresql.org/docs/devel/sql-createtable.html#SQL-
CREATETABLE-PARMS-LIKE-OPT-COMMENTS
will link to exactly the CREATE TABLE LIKE INCLUDING COMMENTS section.

The attached patch adds XML ID attributes to <varlistentry> tags for
create_foreign_table.sgml,
and alter_foreign_table.sgml.
While working on CREATE TABLE LIKE, I happened to find this issue.
Maybe we can have a way to automate all <varlistentry>, but there are
so many <varlistentry>.

LGTM

And I tested this patch on macOS Intel.

Since no more suggestions have been provided. And this is a very minor
change. Although there are currently no other documents linked to these
tags. This patch makes this document more complete and in line with
conventions of other similar documents. So I changed it to "Ready for
Committer"

Show quoted text

--
Quan Zongliang

#4wenhui qiu
qiuwenhuifx@gmail.com
In reply to: Quan Zongliang (#3)
Re: Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

Hi

Since no more suggestions have been provided. And this is a very minor
change. Although there are currently no other documents linked to these
tags. This patch makes this document more complete and in line with
conventions of other similar documents. So I changed it to "Ready for
Committer"

Agree +1

Thanks

On Thu, Nov 13, 2025 at 10:20 AM Quan Zongliang <quanzongliang@yeah.net>
wrote:

Show quoted text

On 9/22/25 9:27 AM, Quan Zongliang wrote:

On 9/19/25 11:08 AM, jian he wrote:

hi.

with commit like:
https://git.postgresql.org/cgit/postgresql.git/commit/?
id=78ee60ed84bb3a1cf0b6bd9a715dcbcf252a90f5

we can make a url link that points directly to a specific subsection
of the document.
for example:
https://www.postgresql.org/docs/devel/sql-createtable.html#SQL-
CREATETABLE-PARMS-LIKE-OPT-COMMENTS
will link to exactly the CREATE TABLE LIKE INCLUDING COMMENTS section.

The attached patch adds XML ID attributes to <varlistentry> tags for
create_foreign_table.sgml,
and alter_foreign_table.sgml.
While working on CREATE TABLE LIKE, I happened to find this issue.
Maybe we can have a way to automate all <varlistentry>, but there are
so many <varlistentry>.

LGTM

And I tested this patch on macOS Intel.

Since no more suggestions have been provided. And this is a very minor
change. Although there are currently no other documents linked to these
tags. This patch makes this document more complete and in line with
conventions of other similar documents. So I changed it to "Ready for
Committer"

--
Quan Zongliang

#5jian he
jian.universality@gmail.com
In reply to: wenhui qiu (#4)
Re: Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

On Thu, Nov 13, 2025 at 10:47 AM wenhui qiu <qiuwenhuifx@gmail.com> wrote:

Hi

Since no more suggestions have been provided. And this is a very minor
change. Although there are currently no other documents linked to these
tags. This patch makes this document more complete and in line with
conventions of other similar documents. So I changed it to "Ready for
Committer"

Agree +1

hi.

similar to the changes made in
/messages/by-id/202511141101.kiv5idbnwn2b@alvherre.pgsql
I added IDs to the <refsect1> too.

--
jian
https://www.enterprisedb.com/

Attachments:

v2-0001-Doc-add-IDs-to-create_foreign_table.sgml-s-varlistentry-and-refse.patchtext/x-patch; charset=US-ASCII; name=v2-0001-Doc-add-IDs-to-create_foreign_table.sgml-s-varlistentry-and-refse.patchDownload+24-25
v2-0002-Doc-add-IDs-to-alter_foreign_table.sgml-s-varlistentry-and-refsec.patchtext/x-patch; charset=US-ASCII; name=v2-0002-Doc-add-IDs-to-alter_foreign_table.sgml-s-varlistentry-and-refsec.patchDownload+39-40
#6Peter Eisentraut
peter_e@gmx.net
In reply to: jian he (#5)
Re: Doc: add XML ID attributes to <varlistentry> tags for create_foreign_table, alter_foreign_table

On 19.11.25 12:19, jian he wrote:

On Thu, Nov 13, 2025 at 10:47 AM wenhui qiu <qiuwenhuifx@gmail.com> wrote:

Hi

Since no more suggestions have been provided. And this is a very minor
change. Although there are currently no other documents linked to these
tags. This patch makes this document more complete and in line with
conventions of other similar documents. So I changed it to "Ready for
Committer"

Agree +1

hi.

similar to the changes made in
/messages/by-id/202511141101.kiv5idbnwn2b@alvherre.pgsql
I added IDs to the <refsect1> too.

committed