[PATCH] Fix the last of the defaults and include a test to check them

Michael Adam obnox at samba.org
Sun Feb 2 16:25:35 MST 2014

Hi Garming,

On 2014-02-03 at 10:41 +1300, Garming Sam wrote:
> >One other question about metadata:
> >Could you provide a list of metadata entries that you
> >added and their precise meaning?
> >So far I saw "function", "synonym", "generated_function",
> >"constant", "parm"
> function corresponds to what function name is generated i.e. lp_xxxx
> and lpcfg_xxxx. In the case where no name is specified, the
> parameter name with underscores instead of spaces will be generated
> automatically (unless it's marked not to generate).
> generated_function = "0" if you don't want to generate an lp
> function from this parameter. This is basically for special cases,
> which may happen where there is some kind of conflict currently.
> synonym is currently marked for any synonyms, but normal synonyms do
> not usually have an xml page, so this only actually appears for
> inverted synonyms currently. Currently marking a synonym means that
> no lp function is also generated.
> constant refers to whether or not the parameter should be constant,
> but this is actually only currently used for strings. Constant in
> this case indicates whether or not substitutions occur with the
> string, I believe.
> parm, I was actually never entirely sure of. Some of the functions
> are in the form FN_XX_PARM_XX and they take a different parameter,
> share_params (instead of an integer which corresponds to the service
> index). If anyone could shed light on it, that would be helpful.
> There's not actually that many of them. And they look nearly
> obsolete in the s4 macros.
> But yeah, with all this metadata stuff, it's previous obvious to see
> which things were outliers.

Thanks for the explanation!

According to my pervious mail, I have prepared a first patchset for
pushing. It does not add any function= occurrences except for those
where the function starts with a "_". I.e those additions of
function metadata that can be avoided by renaming variables and FN_
definitions. A few of the original patches also added "parm" or
"constant" metadata: I kept that portion of the original patches
removing the function bit. One additional change is that I split
the patch "docs: insert meta data into enable spoolss and
writeable for marking a synonym" into two (keeping authorship etc).

See this state in my master-param-reviewed branch:

If you are OK with that I'd push these and pursue the
renaming of the functions+variables (and encourage you to
join in. :-)

Cheers - Michael

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 215 bytes
Desc: Digital signature
URL: <http://lists.samba.org/pipermail/samba-technical/attachments/20140203/6de288ec/attachment.pgp>

More information about the samba-technical mailing list