Received: from localhost (unknown [200.46.204.182]) by postgresql.org (Postfix) with ESMTP id 72B4C2E0197 for ; Sun, 16 Dec 2007 13:39:55 -0400 (AST) Received: from postgresql.org ([200.46.204.71]) by localhost (mx1.hub.org [200.46.204.182]) (amavisd-maia, port 10024) with ESMTP id 47932-07 for ; Sun, 16 Dec 2007 13:39:49 -0400 (AST) Received: from outmail136051.authsmtp.net (outmail136051.authsmtp.net [62.13.136.51]) by postgresql.org (Postfix) with ESMTP id 180D02E02FB for ; Sun, 16 Dec 2007 13:39:49 -0400 (AST) Received: from outmail128184.authsmtp.net (outmail128184.authsmtp.net [62.13.128.184]) by punt2.authsmtp.com (8.13.8/8.13.8/Kp) with ESMTP id lBGHdjc2012685; Sun, 16 Dec 2007 17:39:45 GMT Received: from [192.168.0.3] (85-211-24-246.dyn.gotadsl.co.uk [85.211.24.246]) (authenticated bits=0) by mail.authsmtp.com (8.13.8/8.13.8/Kp) with ESMTP id lBGHdgoC078791; Sun, 16 Dec 2007 17:39:42 GMT Subject: Re: Plug in docs From: Simon Riggs To: "Joshua D. Drake" Cc: Bruce Momjian , pgsql-docs@postgresql.org In-Reply-To: <47654B3A.7030206@commandprompt.com> References: <200712160812.lBG8C5x15519@momjian.us> <47654B3A.7030206@commandprompt.com> Content-Type: text/plain Date: Sun, 16 Dec 2007 17:40:06 +0000 Message-Id: <1197826806.12912.37.camel@ebony.site> Mime-Version: 1.0 X-Mailer: Evolution 2.8.2 Content-Transfer-Encoding: 7bit X-Server-Quench: e26f41ad-abfd-11dc-814e-001185d377ca X-AuthRoute: OCdxZQATClZOTQEd DAteCiNZVAwpPBRK HVkIKg5MJUcNSQVJ NksadRtFaQNbaVxS HGQLW1NEUVp7Wmp/ bwgfZQBDYEtPQQdu TkpNRE1QERpoT0Bz cWZKBUYBdwJOf3dx K0dgXXUVCUZ8I0J8 ExpJRD9QMXphaTRM TUhZc1ZJcANLfxdA PlN4UyBcLwdSbGoL MygYBAV5BTFCJ2xU REkBKlkJKW9y X-Authentic-SMTP: 61633235383639.squirrel.dmpriest.net.uk:787/Kp X-Report-SPAM: If SPAM / abuse - report it at: http://www.authsmtp.com/abuse X-Virus-Status: No virus detected - but ensure you scan with your own anti-virus system! X-Virus-Scanned: Maia Mailguard 1.0.1 X-Archive-Number: 200712/53 X-Sequence-Number: 4721 On Sun, 2007-12-16 at 07:58 -0800, Joshua D. Drake wrote: > Bruce Momjian wrote: > > Simon Riggs wrote: > >> Looks like we need some docs on all these new plugin APIs we've > >> introduced in this release. > >> > >> - PL/pgSQL hooks > >> - planner hooks > >> - join order hooks > > > > Do we normally document these? I don't believe that there is a "normal" yet that applies for these. > I think these are > > documented-in-the-source-code type issues. > > If they are an API they need to be documented. Code is poor (even well > documented code) substitute for good old fashioned docs. Agreed. Doesn't need to be War and Peace, just an overview. -- Simon Riggs 2ndQuadrant http://www.2ndQuadrant.com