[DOC]: Re: [PATCH 3/7] Xserver-spec: Remove CreateCallbackList

[Matt Dew]

Alan,
  In the later xml files I started using <funcsynopsis> for function
callouts like that.

<funcsynopsis>
<funcprototype>
  <funcdef>Bool <function>CreateCallbackList</function></funcdef>
  <paramdef>CallbackListPtr *<parameter>CallbackFuncsPtr</parameter></paramdef>
  <paramdef>CallbackFuncsPtr <parameter>cbfuncs</parameter></paramdef>
</funcprototype>
</funcsynopsis>


which generates:
Bool CreateCallbackList(pcbl, cbfuncs);
  CallbackListPtr  *pcbl;
  CallbackFuncsPtr cbfuncs;


What do you think?
There's quite a few like that in Xserver-spec.xml. Luckily they are very consistent so sed or perl can do most of the heavy lifting.
Matt


On Sun, 2010-11-28 at 00:00 -0800, Alan Coopersmith wrote:
> The function is defined as a static, so can't be called by anyone
> but AddCallback.
> 
> Signed-off-by: Alan Coopersmith <alan.coopersmith at oracle.com>
> ---
>  doc/xml/Xserver-spec.xml |   18 ------------------
>  1 files changed, 0 insertions(+), 18 deletions(-)
> 
> diff --git a/doc/xml/Xserver-spec.xml b/doc/xml/Xserver-spec.xml
> index 1afae5d..6dc2911 100644
> --- a/doc/xml/Xserver-spec.xml
> +++ b/doc/xml/Xserver-spec.xml
> @@ -510,24 +510,6 @@ When CallCallbacks is invoked on the list, func will be called thusly:
>  Now for the details.
>  <blockquote><programlisting>
>  
> -	Bool CreateCallbackList(pcbl, cbfuncs)
> -	    CallbackListPtr  *pcbl;
> -	    CallbackFuncsPtr cbfuncs;
> -
> -</programlisting></blockquote>
> -CreateCallbackList creates a callback list.  We envision that this
> -function will be rarely used because the callback list is created
> -automatically (if it doesn't already exist) when the first call to
> -AddCallback is made on the list.  The only reason to explicitly create
> -the callback list with this function is if you want to override the
> -implementation of some of the other operations on the list by passing
> -your own cbfuncs.  You also lose something by explicit creation: you
> -introduce an order dependency during server startup because the list
> -must be created before any modules subscribe to it.  Returns TRUE if
> -successful.</para>
> -<para>
> -<blockquote><programlisting>
> -
>  	Bool AddCallback(pcbl, callback, subscriber_data)
>  	    CallbackListPtr *pcbl;
>  	    CallbackProcPtr callback;