Received: from localhost (maia-4.hub.org [200.46.204.183])
	by postgresql.org (Postfix) with ESMTP id 05D759F9916;
	Wed, 29 Aug 2007 15:20:28 -0300 (ADT)
Received: from postgresql.org ([200.46.204.71])
	by localhost (mx1.hub.org [200.46.204.183]) (amavisd-maia, port 10024)
	with ESMTP id 62490-07; Wed, 29 Aug 2007 15:20:17 -0300 (ADT)
X-Greylist: from auto-whitelisted by SQLgrey-1.7.5
X-Greylist: from auto-whitelisted by SQLgrey-1.7.5
Received: from mailbox.samurai.com (mailbox.samurai.com [205.207.28.82])
	by postgresql.org (Postfix) with ESMTP id 5B7A39F97D6;
	Wed, 29 Aug 2007 15:20:17 -0300 (ADT)
Received: from localhost (mailbox.samurai.com [205.207.28.82])
	by mailbox.samurai.com (Postfix) with ESMTP id 228FE61D32;
	Wed, 29 Aug 2007 14:20:14 -0400 (EDT)
X-Virus-Scanned: by amavisd-new at mailbox.samurai.com
Received: from mailbox.samurai.com ([205.207.28.82])
	by localhost (mailbox.samurai.com [205.207.28.82]) (amavisd-new,
	port 10024)
	with LMTP id m+GwSR2XFZO0; Wed, 29 Aug 2007 14:20:12 -0400 (EDT)
Received: from [10.10.30.139] (204.11.227.33.static.etheric.net
	[204.11.227.33]) (using TLSv1 with cipher RC4-MD5 (128/128 bits))
	(No client certificate requested)
	by mailbox.samurai.com (Postfix) with ESMTP id 6471861D2D;
	Wed, 29 Aug 2007 14:20:11 -0400 (EDT)
Subject: Re: [HACKERS] Contrib modules documentation online
From: Neil Conway <neilc@samurai.com>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: Josh Berkus <josh@agliodbs.com>, pgsql-hackers@postgresql.org,
	Albert Cervera i Areny <albert@nan-tic.com>, pgsql-docs@postgresql.org
In-Reply-To: <7046.1188410001@sss.pgh.pa.us>
References: <200708290157.07968.albert@nan-tic.com>
	<200708291009.07942.josh@agliodbs.com> <7046.1188410001@sss.pgh.pa.us>
Content-Type: text/plain
Date: Wed, 29 Aug 2007 11:18:44 -0700
Message-Id: <1188411524.32003.6.camel@dell.linuxdev.us.dell.com>
Mime-Version: 1.0
X-Mailer: Evolution 2.10.1 
Content-Transfer-Encoding: 7bit
X-Virus-Scanned: Maia Mailguard 1.0.1
X-Archive-Number: 200708/27
X-Sequence-Number: 4374

On Wed, 2007-08-29 at 13:53 -0400, Tom Lane wrote:
> Why wouldn't we just remove the README files altogether?  I can't
> see maintaining duplicate sets of documentation.

I agree that duplication is bad, but I think README files in the
individual contrib directories is useful and worth keeping: if I'm about
to install a contrib module and want to learn how to install and use it,
this change would only make that information *more* difficult to find.

I wonder if it would be possible to keep the master version of the
contrib docs as SGML, and generate plaintext READMEs from it during the
documentation build.

-Neil