| Lists: | pgsql-hackers |
|---|
| From: | David Fetter <david(at)fetter(dot)org> |
|---|---|
| To: | PG Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | man pages |
| Date: | 2009-10-11 19:10:38 |
| Message-ID: | 20091011191038.GC14810@fetter.org |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-hackers |
Folks,
I'd like to see about creating man pages for the following:
- libpq
- SPI
- the built-in functions
These being what I've clicked through way too many web links to find
information about. If there are other things that should have man
pages, please mention same.
How would that be handled in our current doc build system? I'd really
appreciate any hints, tips or pointers on man page creation in our
current system :)
Cheers,
David.
--
David Fetter <david(at)fetter(dot)org> http://fetter.org/
Phone: +1 415 235 3778 AIM: dfetter666 Yahoo!: dfetter
Skype: davidfetter XMPP: david(dot)fetter(at)gmail(dot)com
Remember to vote!
Consider donating to Postgres: http://www.postgresql.org/about/donate
| From: | Andrew Chernow <ac(at)esilo(dot)com> |
|---|---|
| To: | David Fetter <david(at)fetter(dot)org> |
| Cc: | PG Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: man pages |
| Date: | 2009-10-11 19:32:08 |
| Message-ID: | 4AD232B8.9080501@esilo.com |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-hackers |
David Fetter wrote:
> Folks,
>
> I'd like to see about creating man pages for the following:
>
> - libpq
> - SPI
> - the built-in functions
That would be really helpful and convenient. I've often wanted libpq man pages.
--
Andrew Chernow
eSilo, LLC
every bit counts
http://www.esilo.com/
| From: | Alvaro Herrera <alvherre(at)commandprompt(dot)com> |
|---|---|
| To: | David Fetter <david(at)fetter(dot)org> |
| Cc: | PG Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: man pages |
| Date: | 2009-10-11 23:55:36 |
| Message-ID: | 20091011235536.GC11690@alvh.no-ip.org |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-hackers |
David Fetter wrote:
> Folks,
>
> I'd like to see about creating man pages for the following:
>
> - libpq
> - SPI
> - the built-in functions
>
> These being what I've clicked through way too many web links to find
> information about. If there are other things that should have man
> pages, please mention same.
We already have SPI manpages in HEAD. libpq would be very useful, I
agree; you should try to patch the SGML following the SPI example in
order to get those. It shouldn't be difficult.
As for builtin functions, I think that's going to be a very hard sell.
I'd focus on libpq at first :-)
--
Alvaro Herrera http://www.CommandPrompt.com/
The PostgreSQL Company - Command Prompt, Inc.
| From: | Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> |
|---|---|
| To: | Alvaro Herrera <alvherre(at)commandprompt(dot)com> |
| Cc: | David Fetter <david(at)fetter(dot)org>, PG Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: man pages |
| Date: | 2009-10-12 01:18:20 |
| Message-ID: | 18480.1255310300@sss.pgh.pa.us |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-hackers |
Alvaro Herrera <alvherre(at)commandprompt(dot)com> writes:
> As for builtin functions, I think that's going to be a very hard sell.
Fresh out of the box, there are 2227 entries in pg_proc as of CVS HEAD.
I don't see making a man page for each one as being a useful activity
...
regards, tom lane
| From: | David Fetter <david(at)fetter(dot)org> |
|---|---|
| To: | Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> |
| Cc: | Alvaro Herrera <alvherre(at)commandprompt(dot)com>, PG Hackers <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: man pages |
| Date: | 2009-10-12 01:36:20 |
| Message-ID: | 20091012013620.GE14810@fetter.org |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-hackers |
On Sun, Oct 11, 2009 at 09:18:20PM -0400, Tom Lane wrote:
> Alvaro Herrera <alvherre(at)commandprompt(dot)com> writes:
> > As for builtin functions, I think that's going to be a very hard
> > sell.
>
> Fresh out of the box, there are 2227 entries in pg_proc as of CVS
> HEAD. I don't see making a man page for each one as being a useful
> activity ...
How about a man page with all of them (or main sections of them) and a
bunch of symbolic links, as with *printf?
Cheers,
David.
--
David Fetter <david(at)fetter(dot)org> http://fetter.org/
Phone: +1 415 235 3778 AIM: dfetter666 Yahoo!: dfetter
Skype: davidfetter XMPP: david(dot)fetter(at)gmail(dot)com
Remember to vote!
Consider donating to Postgres: http://www.postgresql.org/about/donate