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

From: Bruce Momjian <maillist(at)candle(dot)pha(dot)pa(dot)us>
To: lockhart(at)alumni(dot)caltech(dot)edu (Thomas G(dot) Lockhart)
Cc: tgl(at)sss(dot)pgh(dot)pa(dot)us, pgsql-hackers(at)postgreSQL(dot)org, pgsql-docs(at)postgreSQL(dot)org, bibach(at)vweb(dot)infomansol(dot)com
Subject: Re: [DOCS] Re: [HACKERS] So what is the current documentation status?
Date: 1998-08-17 02:53:44
Message-ID: 199808170253.WAA15525@candle.pha.pa.us
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.

OK, I am happy if you can output html to use that, or convert it myself
to man pages from that. Why not?

>
> 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.

No, but I need to look up the access method stuff, and was really
useful. However, the class diagram was unreadable, and I see that
converting it to gif with any normal resolution may be too large. Maybe
someone could do a rewrite in xfig? I have added the old catalog.gif to
the distribution so we can use that if we need to.

I am burried in a patch that is already 12k lines of diff, and I haven't
even started testing the regression tests or reviewing the diff.

--
Bruce Momjian | 830 Blythe Avenue
maillist(at)candle(dot)pha(dot)pa(dot)us | Drexel Hill, Pennsylvania 19026
+ If your life is a hard drive, | (610) 353-9879(w)
+ Christ can be your backup. | (610) 853-3000(h)

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 1998-08-17 03:14:53 Re: Quick cut at an autoconf tutorial
Previous Message Thomas G. Lockhart 1998-08-17 02:16:51 Re: [DOCS] Re: [HACKERS] So what is the current documentation status?