Re: [PATCH 00/32] Create an User's manual and improve development-process book
From: Mauro Carvalho Chehab
Date: Tue Oct 18 2016 - 06:43:04 EST
Em Tue, 18 Oct 2016 13:35:39 +0300
Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> escreveu:
> On Tue, 18 Oct 2016, Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote:
> > Em Tue, 18 Oct 2016 13:01:01 +0300
> > Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> escreveu:
> >> On Tue, 18 Oct 2016, Jonathan Corbet <corbet@xxxxxxx> wrote:
> >> > So I raised this topic in talks at both Kernel Recipes and LinuxCon
> >> > Europe, and nobody threw things at me. I have come to suspect that I'm
> >> > worrying a little too much about it; maybe we should go ahead and move
> >> > the documents and see who screams.
> >> While at it, how about unifying some of the FilenamesInCamelCase,
> >> filenames-with-hyphens, and filenames_with_underscores too...? To at
> >> least move things towards just one of them within one directory.
> > Sure, let's do it. I would just keep README as README.rst , as people
> > are more used to see readme files on upercases.
> Right, I guess I'd keep the top level files as-is, and just do this
> within Documentation.
Well IMHO, the most important documentation for an user/admin's guide
is at /README. So, most of its contents (if not all) should be
moved to Documentation/admin-guide.
> > For the rest, what's your preference?
> > - FooBar.rst
> > - foo_bar.rst
> > - foo-bar.rst
> > My personal preference is for "foo-bar".
> Same here, but I don't mind so much *which* one it is as long as at
> least each directory has consistent naming.
Yeah, my preference here is also not strong... whatever works
best for the others fit to me.
> > Thanks! Life would be very boring if everybody would have the same
> > opinion :) So, feel free to disagree with me. Your views are very
> > welcome, even when differs from my own :)
> Thanks, good to check we're on the same page here and not
> antagonizing. :)