[PATCH weston 10/25] man: document WESTON_LIBINPUT_LOG_PRIORITY env

[Peter Hutterer]

On Thu, Apr 05, 2018 at 04:53:53PM +0300, Pekka Paalanen wrote:
> On Thu, 5 Apr 2018 15:59:18 +1000
> Peter Hutterer <peter.hutterer at who-t.net> wrote:
> 
> > On Fri, Mar 23, 2018 at 02:00:50PM +0200, Pekka Paalanen wrote:
> > > From: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> > > 
> > > Commit c81c4241d9c9fc5f60c08177dd8a33ae4e4ddca1 added this environment
> > > variable. Document it.
> > > 
> > > It applies also to the fbdev-backend but that has no man page.
> > > 
> > > Signed-off-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>
> > > ---
> > >  man/weston-drm.man | 4 ++++
> > >  1 file changed, 4 insertions(+)
> > > 
> > > diff --git a/man/weston-drm.man b/man/weston-drm.man
> > > index 257237df..97f55e50 100644
> > > --- a/man/weston-drm.man
> > > +++ b/man/weston-drm.man
> > > @@ -125,6 +125,10 @@ instead of using the current tty.
> > >  .SH ENVIRONMENT
> > >  .
> > >  .TP
> > > +.B WESTON_LIBINPUT_LOG_PRIORITY
> > > +Libinput verbosity level as appearing in Weston's log. Valid values are
> > > +.BR debug ", " info ", and " error ". Default is " info .  
> > 
> > not that I care that much, but Libinput looks weird - should be 'libinput',
> > i.e. lowercase.
> 
> It's the first word in a sentence, so my brain says it needs to be
> capitalized. I also try very very hard to never start a sentence with a
> function name or such because my OCD would explode on the conflict. :-)

sort-of. That's not the case for proper nouns (i.e. names) of which libinput
is arguably one. The same would be true for e.g. systemd and almost all unix
commands. e.g. you wouldn't start a sentence like "Ls shows you the list of
files"

Reading this again, it's grammatically a tad weird anyway, reword to "The
minimum libinput verbosity level to be printed to Weston's log", it removes
some ambiguity and is OCD-compatible :)

Cheers,
   Peter


> > > +.TP
> > >  .B WESTON_TTY_FD
> > >  The file descriptor (integer) of the opened tty where
> > >  .B weston
> > > -- 
> > > 2.16.1