Re: Contrib docs v1

From: Albert Cervera i Areny <albert(at)nan-tic(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: pgsql-patches(at)postgresql(dot)org
Subject: Re: Contrib docs v1
Date: 2007-11-11 13:05:19
Message-ID: 200711111405.20567.albert@nan-tic.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-patches

A Diumenge 11 Novembre 2007, Bruce Momjian va escriure:
> Albert Cervera i Areny wrote:
> > Sorry, I missed them, indeed I packed btree_gist instead of the good one
> > btree-gist. The cube and xml2 have been added to.
>
> Thanks. All applied. I know people liked the README files in each
> /contrib directory but we have no chance of keeping them in sync with
> the SGML so I removed them.
>
> I still have lots of adjustments to make but at least it is in.

I know there are many things to improve but as you say at least it is in. Now
we can improve it incrementally.

>
> Albert, can you do the new dict_int and dict_xsyn READMEs. I could do
> them but I am afraid I would not do as consistent of a job as you did.
> Thanks. Those README's are still in CVS /contrib, of course.

Of course. I'll send them ASAP.

>
> ---------------------------------------------------------------------------
>
> > A Divendres 09 Novembre 2007, Bruce Momjian va escriure:
> > > Albert Cervera i Areny wrote:
> > > > I attach the patch for the contrib docs. Mainly it's been formatting
> > > > the README files of each directory into SGML.
> > > >
> > > > I've removed TODOs, history, licenses (all of them are BSD AFAICS),
> > > > file descriptions and install instructions (I only left one for them
> > > > all).
> > > >
> > > > The hole contrib is one single chapter after Full Text Search. I
> > > > think this gives it a lot of visibility as it's where other functions
> > > > are, and given that most contrib modules provide functions seemed a
> > > > good place. However, Tom showed some concerns with that so a final
> > > > position should be decided. Each section is the name of the contrib
> > > > module. The first paragraph summarises what it does. And usually the
> > > > last subsection contains the author(s). The rest is pretty different
> > > > from one another and possibly some polishing will have to be done
> > > > afterwards.
> > >
> > > Your patch was missing these SGML files:
> > >
> > > onsgmls:contrib.sgml:26:1:E: cannot find "btree-gist.sgml"; tried
> > > "btree-gist.sgml", "./btree-gist.sgml" onsgmls:contrib.sgml:28:1:E:
> > > cannot find "cube.sgml"; tried "cube.sgml", "./cube.sgml"
> > > onsgmls:contrib.sgml:53:1:E: cannot find "xml2.sgml"; tried
> > > "xml2.sgml", "./xml2.sgml"
> > >
> > > Are you still working on those?
> >
> > --
> > Albert Cervera i Areny
> > http://www.NaN-tic.com
>
> [ Attachment, skipping... ]
>
> > ---------------------------(end of broadcast)---------------------------
> > TIP 6: explain analyze is your friend

--
Albert Cervera i Areny
http://www.NaN-tic.com

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Albert Cervera i Areny 2007-11-11 13:10:27 Re: Placement of contrib modules in SGML documentation
Previous Message Bruce Momjian 2007-11-11 05:14:59 Re: Placement of contrib modules in SGML documentation

Browse pgsql-patches by date

  From Date Subject
Next Message Bruce Momjian 2007-11-11 14:28:24 Re: [PATCHES] Contrib docs v1
Previous Message Pavel Stehule 2007-11-11 07:27:03 Re: tsearch2api .. wrapper for integrated fultext