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

Groups > linux.kernel > #1502794

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

Show all headers | View raw

Em Mon, 17 Oct 2016 16:43:42 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> I've only been able to take a quick look at these - I'm buried fairly deep
> at the moment.  A few superficial thoughts.
> 
> On Mon, 17 Oct 2016 14:55:37 -0200
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > In my opinion, it would be better to move the converted files to be inside
> > a Sphinx build directory, but Jon seems reluctant to that, so, this series
> > use symlinks, as it is easy to move the files in the future with a very simple
> > patch, if we decide to do so.  
> 
> 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.  The work could go into docs-next soon,
> and there would be an opportunity to fix things up if all hell breaks
> loose at the kernel summit.
> 
> Can I make some silly requests?
> 
> - Can we move development-process to something shorter, like just
>   "process"?  We'll be typing it a lot, and tab completion doesn't work in
>   most email clients :)

OK!

> - I think we should leave pointers behind in the form of one-line "this
>   file has moved" messages.  Probably only SubmittingPatches and
>   CodingStyle need that treatment, I think.

Ok. Following such logic, I guess we should also add a similar notice to
the main README file too, that will be at the "user/admin-guide".

I would actually be a little more verbose there, providing pointers to the
main documentation books (e. g. the non-subsystem specific ones) there, 
like:

	The content of this file was moved to
	  Documentation/admin-guide/README.rst
	For Kernel's build and admin documentation, please see 
	  Documentation/admin-guide;
	For guides about the Kernel development process, please see
	  Documentation/process;
	...

> - The "user manual" is certainly something that has been on my mind as
>   well.  We have documentation for completely separate audiences all mixed
>   together now, and definitely need to fix that.  But rather than "user",
>   can we paint that shed "admin-guide" or something like that?  

Ok! "admin-guide" sounds a good name.

> Thanks for doing all of this,

Anytime!

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