Red Hat Bugzilla – Bug 1305554
include the '=' symbol in sssd man pages as delimiter between an option and a boolean
Last modified: 2016-02-11 03:52:26 EST
[+] Description of problem:
- I have ran into a few cases where the use of sssd.conf did not contain the proper delimiter between the options and their booleans contained within. The manuals should clearly state that the delimiter '=' is required.
[+] Actual results:
[+] Expected results:
enumerate = (bool)
What I guess would even be better is for us to finally start validating the config..
We might try to do a limited validation by python bindings.
sh$ rpm -ql sssd-common | grep /sssd/sssd.api.d
Help on class SSSDConfig in module SSSDConfig:
| class SSSDConfig
| Primary class for operating on SSSD configurations
| Method resolution order:
| Methods defined here:
| __init__(self, schemafile=None, schemaplugindir=None)
| Initialize the SSSD config parser/editor. This constructor does not
| open or create a config file. If the schemafile and schemaplugindir
| are not passed, it will use the system defaults.
| The path to the api schema config file. Usually
| The path the directory containing the provider schema config files.
| Usually /usr/share/sssd/sssd.api.d
(In reply to Striker Leggette from comment #0)
> [+] Description of problem:
> - I have ran into a few cases where the use of sssd.conf did not contain
> the proper delimiter between the options and their booleans contained
> within. The manuals should clearly state that the delimiter '=' is required.
> [+] Actual results:
> enumerate (bool)
> [+] Expected results:
> enumerate = (bool)
I think it's clearly explained in the top of the sssd.conf manual page.
SSSD.CONF(5) File Formats and Conventions SSSD.CONF(5)
sssd.conf - the configuration file for SSSD
The file has an ini-style syntax and consists of sections and
parameters. A section begins with the name of the section in square
brackets and continues until the next section begins. An example of
section with single and multi-valued parameters:
key = value
key2 = value2,value3
The data types used are string (no quotes needed), integer and bool
(with values of “TRUE/FALSE”).
A line comment starts with a hash sign (“#”) or a semicolon (“;”).
Inline comments are not supported.
All sections can have an optional description parameter. Its function
is only as a label for the section.
sssd.conf must be a regular file, owned by root and only root may read
from or write to the file.
In my opinion it might be confusing for users.
People might think they need to add boolean value to brackets.
"enumerate = (true)"
We are consistent in this think and do not use character "=" between name on option and it's type.
I would close this ticket as not a bug.
There was not any objections for closing the ticket (Comment 2).
I will close it as won't fix.
Feel free to reopen with clarification if you disagree.