Re: man pages for contrib programs

From: Thom Brown <thom(at)linux(dot)com>
To: Peter Eisentraut <peter_e(at)gmx(dot)net>
Cc: pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: man pages for contrib programs
Date: 2012-04-04 20:10:05
Message-ID: CAA-aLv5=Dh_Wv8hsUwJM4N0=CDbJ1-7B0r5BptY2ig56u5hFeg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 4 April 2012 19:53, Peter Eisentraut <peter_e(at)gmx(dot)net> wrote:
> ... would be really nice to have.  Especially pgbench and pg_upgrade for
> me, but it would be useful to have man pages for everything.
>
> Unfortunately, we can't just replace the sect1's in in Appendix F [0]
> with refentry's, because the content model of DocBook doesn't allow
> that.  (You can't have a mixed sequence of sect1 and refentry, only one
> or the other.)
>
> [0] http://www.postgresql.org/docs/devel/static/contrib.html
>
> Which leads to a somewhat related point.  The current content listing in
> Appendix F mixes extensions (backend modules) with client and server
> programs.  Who can guess which is which here:
>
> ...
> pg_archivecleanup
> pgbench
> pg_buffercache
> pgcrypto
> pg_freespacemap
> pgrowlocks
> pg_standby
> pg_stat_statements
> ...
>
> I think it would be useful to split this up into three sections:
>
> F.1. Extensions
> F.2. Client Applications
> F.3. Server Applications

This is something I raised previously, but it didn't really attract
much comment: http://archives.postgresql.org/pgsql-hackers/2011-10/msg00781.php

+1 to anything that separates these out. Cramming them into one list
like we currently have is confusing.

--
Thom

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Jay Levitt 2012-04-04 20:19:08 Re: Switching to Homebrew as recommended Mac install?
Previous Message Peter Eisentraut 2012-04-04 20:07:27 postgres long options without value