[PATCH] Correct defaults in documentation

[Andrew Bartlett]

On Sat, 2014-01-25 at 16:36 +0200, Alexander Bokovoy wrote:
> On Sat, Jan 25, 2014 at 03:45:11PM +1300, Andrew Bartlett wrote:
> > Jeremy (and anyone else on the team interested),
> > 
> > This patch, the diffstat of which is below, fixes many of the incorrect
> > defaults in our documentation, as well as correcting the 'type'
> > parameter in the metadata at the head of each file.  These errors were
> > found by an improved docs.py test and the new generate-param.py script,
> > which like these patches is part of the branch Garming and I have worked
> > on at:
> > git://git.catalyst.net.nz/samba.git polished-param2
> > 
> > Please review/push.
> Reviewed-by: Alexander Bokovoy <ab at samba.org>
> 
> Couple of questions:
> 
> - When we set default to empty string (<value></value>), will it be a
>   NULL or an empty string ("")?

"" (enforced by loadparm internal rules)

> - Would this distinction continue to exist for values with an empty
>   string where we have <value><comment></comment></value>?

Yes, the comment element is simply ignored by the generator (seen as a
child element).  

> - Do we need to maintain such difference (unallocated vs empty string)
>   if one exists for any parameter?

Loadparm does not permit such a difference.  lp_*() callers can assume
that a pointer is always returned. 

> I'm currently not being able to push due to travelling, please push.

Thanks!

Andrew Bartlett

-- 
Andrew Bartlett                       http://samba.org/~abartlet/
Authentication Developer, Samba Team  http://samba.org
Samba Developer, Catalyst IT          http://catalyst.net.nz/services/samba