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

Поиск
Список
Период
Сортировка
От Bruce Momjian
Тема Re: [DOCS] Re: [HACKERS] So what is the current documentation status?
Дата
Msg-id 199808170253.WAA15525@candle.pha.pa.us
обсуждение исходный текст
Ответ на Re: [DOCS] Re: [HACKERS] So what is the current documentation status?  ("Thomas G. Lockhart" <lockhart@alumni.caltech.edu>)
Список 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@candle.pha.pa.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)

В списке pgsql-hackers по дате отправления:

Предыдущее
От: "Thomas G. Lockhart"
Дата:
Сообщение: Re: [DOCS] Re: [HACKERS] So what is the current documentation status?
Следующее
От: Tom Lane
Дата:
Сообщение: Re: Quick cut at an autoconf tutorial