Re: Hooks

From: "Tsunakawa, Takayuki" <tsunakawa(dot)takay(at)jp(dot)fujitsu(dot)com>
To: 'David Fetter' <david(at)fetter(dot)org>
Cc: 'Jim Nasby' <Jim(dot)Nasby(at)BlueTreble(dot)com>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, PostgreSQL Development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Hooks
Date: 2016-12-28 01:33:13
Message-ID: 0A3221C70F24FB45833433255569204D1F66D7BC@G01JPEXMBYT05
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

From: David Fetter [mailto:david(at)fetter(dot)org]
> > How about putting a descriptive comment at the location where each
> > hook variable is defined, using some convention (e.g. like
> > Javadoc-style)? A separate document such as README and wiki can fail
> > to be updated. OTOH, if someone wants to add a new hook, we can
> > expect him to add appropriate comment by following existing hooks.
> > Using a fixed tag, e.g. "<Hook>", would facilitate finding all hooks.
> I like this idea, but it's a much bigger one than mine because it's
> essentially inventing (or adopting, whatever we settle on) literate
> programming for the PostgreSQL project.

I didn't intend to invent a new heavy rule or tool. I just meant comments just like the existing function descriptions, something like

* Hook name: Authentication hook
* Description: ...
* Arguments: ...
* Return value: ...
* Note: ...

> In the realm of generated documentation, we do have a doxygen
> for the project, but I haven't really found
> it helpful thus far.

Me, too.

> At the moment, our practice is that (most--hooks being an exception)
> user-facing features must come with with user-facing docs which are written
> separately from the source code implementing them.

OK. Anyway, if we can see in the PostgreSQL documentation what hooks are available, it would be the best. I imagine you meant adding a new chapter under the part "V. Server Programming".

Takayuki Tsunakawa

In response to

  • Re: Hooks at 2016-12-28 01:13:11 from David Fetter


  • Re: Hooks at 2016-12-28 01:41:56 from David Fetter

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Langote 2016-12-28 01:41:17 Re: Declarative partitioning - another take
Previous Message David Fetter 2016-12-28 01:13:11 Re: Hooks