Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1502889

Re: [PATCH 00/32] Create an User's manual and improve development-process book

Show all headers | View raw

Em Tue, 18 Oct 2016 13:35:39 +0300
Jani Nikula <jani.nikula@linux.intel.com> escreveu:

> On Tue, 18 Oct 2016, Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> > Em Tue, 18 Oct 2016 13:01:01 +0300
> > Jani Nikula <jani.nikula@linux.intel.com> escreveu:
> >  
> >> On Tue, 18 Oct 2016, Jonathan Corbet <corbet@lwn.net> 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. :)

:)

> 
> 
> BR,
> Jani.
> 
> 
> 



Thanks,
Mauro

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH 00/32] Create an User's manual and improve development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 16/32] Documentation/dynamic-debug-howto.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 19/32] Documentation/magic-number.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 31/32] Documentation/volatile-considered-harmful.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 25/32] Documentation/parport.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 32/32] Documentation/parport.txt: fix table to show on LaTeX Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 27/32] Documentation/sysfs-rules.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 21/32] Documentation/module-signing.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 05/32] docs-rst: add documents to development-process Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 17/32] Documentation/initrd.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:00 +0200
  [PATCH 13/32] Documentation/BUG-HUNTING: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 04/32] Documentation/kernel-parameters.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 20/32] Documentation/md.txt: Convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 14/32] Documentation/CodeOfConflict: add it to the development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 10/32] Documentation/binfmt_misc.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 09/32] Documentation/basic_profiling.rst: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 02/32] REPORTING-BUGS: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 06/32] docs-rst: create an user's manual book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 11/32] Documentation/serial-console.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 03/32] README: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 12/32] Documentation/braille-console: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 22/32] Documentation/mono.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 07/32] Documentation/adding-syscalls.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 28/32] Documentation/sysrq.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 24/32] Documentation/oops-tracing.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 29/32] Documentation/unicode.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 30/32] Documentation/VGA-softcursor.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 26/32] Documentation/ramoops.txt: convert it to ReST format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 23/32] Documentation/java.txt: convert to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:10 +0200
  [PATCH 08/32] Documentation/bad_memory.txt: convert it to ReST markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-17 19:20 +0200
  Re: [PATCH 00/32] Create an User's manual and improve  development-process book Jonathan Corbet <corbet@lwn.net> - 2016-10-18 00:50 +0200
    Re: [PATCH 00/32] Create an User's manual and improve development-process book Markus Heiser <markus.heiser@darmarit.de> - 2016-10-18 06:40 +0200
      Renaming Documentation/ [was  [PATCH 00/32] Create an User's manual  and improve development-process book] Jonathan Corbet <corbet@lwn.net> - 2016-10-18 15:40 +0200
        Re: Renaming Documentation/ [was  [PATCH 00/32] Create an User's  manual and improve development-process book] Theodore Ts'o <tytso@mit.edu> - 2016-10-18 16:20 +0200
    Re: [PATCH 00/32] Create an User's manual and improve  development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-18 10:40 +0200
    Re: [PATCH 00/32] Create an User's manual and improve development-process book Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-18 12:10 +0200
      Re: [PATCH 00/32] Create an User's manual and improve  development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-18 12:30 +0200
        Re: [PATCH 00/32] Create an User's manual and improve development-process book Jani Nikula <jani.nikula@linux.intel.com> - 2016-10-18 12:40 +0200
          Re: [PATCH 00/32] Create an User's manual and improve  development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-18 12:50 +0200
        Re: [PATCH 00/32] Create an User's manual and improve  development-process book Jonathan Corbet <corbet@lwn.net> - 2016-10-19 01:30 +0200
          Re: [PATCH 00/32] Create an User's manual and improve  development-process book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-19 16:20 +0200
          Re: [PATCH 00/32] Create an User's manual and improve development-process book Markus Heiser <markus.heiser@darmarit.de> - 2016-10-19 17:00 +0200

csiph-web