Re: Get rid of "Section.N.N.N" on DOCs

From: Bruce Momjian <bruce(at)momjian(dot)us>
To: Marcos Pegoraro <marcos(at)f10(dot)com(dot)br>
Cc: Peter Eisentraut <peter(at)eisentraut(dot)org>, Douglas Domingues da Silveira <douglas(at)f10(dot)com(dot)br>, Robert Treat <rob(at)xzilla(dot)net>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Get rid of "Section.N.N.N" on DOCs
Date: 2026-06-30 00:09:58
Message-ID: akMJVtSk8TjYciRV@momjian.us
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Jun 24, 2026 at 11:00:23AM -0300, Marcos Pegoraro wrote:
> Em qua., 24 de jun. de 2026 às 09:49, Peter Eisentraut <peter(at)eisentraut(dot)org>
> escreveu:
>
> I have no idea what this patch is supposed to accomplish.
>
>
> The goal of this thread was to make it easier to read the DOCs, changing how
> xref to Section, Chapter, Appendix and Tables are shown.
> To have this done, it's not enough to just change the .XSL file so that it no
> longer shows the numbers but its title, it's necessary to change all places
> where that xref is used.
>
> An example of how is shown today.
>   For more information on parallel query, see Chapter 15.
>
> If I only change the XSL file, it'll change to this
>   For more information on parallel query, see Parallel Query.
>
> But, as you can see, new text would become confused or duplicated, so we have
> to change not only the XSL file, but all places where that xref was used, and
> this job we did with the help of AI.
>   For more information, see Parallel Query.
>
> Douglas sent initially two files, one xref_review.HTML to visually see how that
> diff would become, and the patch itself.
> I think the best way for you to see the result is to open xref_review.HTML.
>
> Then now he sent just the rebase of that patch

I think one big problem is that the patch appeared without discussion of
its purpose. Our TODO list has a good order of how to propose changes:

https://wiki.postgresql.org/wiki/Todo#Development_Process
Desirability -> Design -> Implement -> Test -> Review -> Commit

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

Do not let urgent matters crowd out time for investment in the future.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Fujii Masao 2026-06-30 00:38:17 Re: md5_password_warnings for password auth with MD5-encrypted passwords
Previous Message Henson Choi 2026-06-30 00:07:11 Re: Row pattern recognition