Re: [DOCS] Re: [HACKERS] So what is the current documentation status?

From: "Thomas G(dot) Lockhart" <lockhart(at)alumni(dot)caltech(dot)edu>
To: Bruce Momjian <maillist(at)candle(dot)pha(dot)pa(dot)us>
Cc: tgl(at)sss(dot)pgh(dot)pa(dot)us, pgsql-hackers(at)postgreSQL(dot)org, pgsql-docs(at)postgreSQL(dot)org, Brandon Ibach <bibach(at)vweb(dot)infomansol(dot)com>
Subject: Re: [DOCS] Re: [HACKERS] So what is the current documentation status?
Date: 1998-08-17 02:16:51
Message-ID: 35D79293.82F44A03@alumni.caltech.edu
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> I really like libpq.3 as a manual page. I use it for quick reference.
> I have printf as a manual pages, and that is a library function.
> How is libpq.3 different?

printf == single function
libpq == entire library of functions

It should be noted that many people have trouble giving up man pages.
But we have limited resources for documentation, and man pages clearly
fall at the bottom of the list in usefulness and viability (at least for
things like full library interfaces). We should choose the most
appropriate format for each of our documentation resources, at least
until we have the documentation under control.

There is someone working on a man page output from the sgml, and if that
comes through then this is pretty much a moot point.

btw, had a chance to look at the new reference pages? They are near the
end of the User's Guide on the web site and in /pub/patches on the ftp
site.

- Tom

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 1998-08-17 02:53:44 Re: [DOCS] Re: [HACKERS] So what is the current documentation status?
Previous Message Bruce Momjian 1998-08-17 01:04:32 Re: [HACKERS] So what is the current documentation status?