[pulseaudio-discuss] [PATCH 2/3] doc: Fix description how boolean values can be specified

[Tanu Kaskinen]

On Mon, 2013-04-29 at 16:00 +0200, David Henningsson wrote:
> On 04/17/2013 03:07 PM, Peter Meerwald wrote:
> > From: Peter Meerwald <p.meerwald at bct-electronic.com>
> >
> > "any word starting with the letters" parts; this does not hold
> > any longer with commit 0e29e7365907ffbe90df768a4dea277dba40d495
> > core-util: Don't accept random words in pa_parse_boolean()
> 
> Tanu, was this change intentional?

Yes, it seemed silly to accept garbage in pa_parse_boolean(). I didn't
know that the behaviour was documented.

We could revert my commit, or we could accept this patch that changes
the documentation. I prefer changing the documentation.

-- 
Tanu

> >
> > Signed-off-by: Peter Meerwald <p.meerwald at bct-electronic.com>
> > ---
> >   man/pulse-cli-syntax.5.xml.in |    9 ++++-----
> >   1 file changed, 4 insertions(+), 5 deletions(-)
> >
> > diff --git a/man/pulse-cli-syntax.5.xml.in b/man/pulse-cli-syntax.5.xml.in
> > index 159e24c..a5e3446 100644
> > --- a/man/pulse-cli-syntax.5.xml.in
> > +++ b/man/pulse-cli-syntax.5.xml.in
> > @@ -32,16 +32,15 @@ USA.
> >     <description>
> >       <p>
> >         PulseAudio provides a simple command line language used by configuration
> > -      scripts and the pacmd interactive shell, and the modules module-cli and
> > +      scripts, the pacmd interactive shell, and the modules module-cli and
> >         module-cli-protocol-{unix,tcp}. Empty lines and lines beginning with a
> >         hashmark (#) are silently ignored. Several commands are supported.
> >       </p>
> >
> >       <p>
> > -      Note that any boolean arguments can be given positively as '1', 'on' or any
> > -      word starting with the letters 't' or 'y'. Likewise, negative values can be
> > -      given as '0', 'off' or any word starting with the letters 'f' or 'n'.
> > -      Case is ignored.
> > +      Note that any boolean arguments can be given positively as '1', 't', 'y',
> > +      'true', 'yes' or 'on'. Likewise, negative values can be given as '0',
> > +      'f', 'n', 'false', 'no' or 'off'. Case is ignored.
> >       </p>
> >     </description>
> >
> >
> 
> 
> 


---------------------------------------------------------------------
Intel Finland Oy
Registered Address: PL 281, 00181 Helsinki 
Business Identity Code: 0357606 - 4 
Domiciled in Helsinki 

This e-mail and any attachments may contain confidential material for
the sole use of the intended recipient(s). Any review or distribution
by others is strictly prohibited. If you are not the intended
recipient, please contact the sender and delete all copies.