[PATCH] s3:winbindd: document "winbind:ignore domains"

[David Mulder]

I've submitted a revised patch.

On 01/23/2017 02:42 PM, Alexander Bokovoy wrote:
> On ma, 23 tammi 2017, David Mulder wrote:
>> So the doc for the parameterized options should be in ./parameters.all.xml?
> No. parameters.all.xml is generated from the files in
> docs-xml/smbdotconf/*/*.xml
>
> You need to create a file named docs-xml/smbdotconf/<category>/parametricoption.xml
> and use parameter name with ':' in it. Check other files, like
> docs-xml/smbdotconf/printing/spoolssosversion.xml. In fact, the actual
> file name does not matter as long as it is unique. The category split is
> purely for us to be able to manage 500+ option descriptions.
>
> printing/spoolssosversion.xml actually has three parametric options
> documented in the same file.
>
> When XML files are processed, content of all individual XML
> files is concatenated together in parameters.all.xml.
>
>> On 01/23/2017 02:22 PM, Ralph Böhme wrote:
>>> On Mon, Jan 23, 2017 at 11:19:10PM +0200, Alexander Bokovoy wrote:
>>>> On ma, 23 tammi 2017, Ralph Böhme wrote:
>>>>> On Mon, Jan 23, 2017 at 09:48:49AM -0700, David Mulder wrote:
>>>>>> Ok, so I could leave the source in source3/winbindd/winbindd_util.c as it
>>>>>> was, and document it with that xml file, and then it wont auto-generate the
>>>>>> parameter mappings?
>>>>> I believe there's no easy way to sort this out. You can't, afaict, document a
>>>>> parametric option in the XML docs. :/
>>>>>
>>>>> Folks, I might be missing something, can we somehow document this option?
>>>> There are three separate things at play here:
>>>>    - when XML snippet defines parametric option, do not generate C
>>>>      boilerplate code to access the option (lp_cfg_...()),
>>>>    - add a section to smb.conf documentation that describes all documented
>>>>      parametric options, and
>>>>    - document independent parametric options
>>>>
>>>> I think we have already first item covered by script/generate_param.py
>>>> which ignores parameter descriptions which have : in them.
>>>>
>>>> The second part exists as well but not as a separate section for
>>>> parametrics -- rather than that, we have them in the common list of
>>>> smb.conf's options. I guess this is just OK for now, they are sorted by
>>>> the option name without colon in it (like the XML file name).
>>>>
>>>> The third part is there already for *some* options, so just continue
>>>> documenting the rest:
>>>>
>>>> $ cd docs-xml/smbdotconf
>>>> $ git grep 'parameter name'|cut -d= -f2|grep :
>>>> "ldapsam:editposix"
>>>> "ldapsam:trusted"
>>>> "fss: prune stale"
>>>> "fss: sequence timeout"
>>>> "rpc_daemon:DAEMON"
>>>> "rpc_server:SERVER"
>>>> "spoolss: architecture"
>>>> "spoolss: os_major"
>>>> "spoolss: os_minor"
>>>> "spoolss: os_build"
>>>> "share:fake_fscaps"
>>>> "idmap config DOMAIN : OPTION"
>>> ah, I forgot that we already have a bunch of those documented. Thanks a *lot*
>>> for refreshing my memories! :)
>>>
>>> Cheerio!
>>> -slow
>>>
>> -- 
>> David Mulder
>> SUSE Labs Software Engineer - Samba
>> dmulder at suse.com
>> SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg)
>>
>>

-- 
David Mulder
SUSE Labs Software Engineer - Samba
dmulder at suse.com
SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg)