From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 00/32] Create an User's manual and improve development-process book
Date: Mon, 17 Oct 2016 16:43:42 -0600 [thread overview]
Message-ID: <20161017164342.28d4f0c3@lwn.net> (raw)
In-Reply-To: <cover.1476717925.git.mchehab@s-opensource.com>
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 :)
- 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.
- 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?
Thanks for doing all of this,
jon
next prev parent reply other threads:[~2016-10-17 22:43 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-17 16:55 [PATCH 00/32] Create an User's manual and improve development-process book Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 01/32] Documentation/applying-patches.txt: fix a bad external link Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 02/32] REPORTING-BUGS: convert to ReST markup Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 03/32] README: convert it " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 04/32] Documentation/kernel-parameters.txt: convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 05/32] docs-rst: add documents to development-process Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 06/32] docs-rst: create an user's manual book Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 07/32] Documentation/adding-syscalls.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 08/32] Documentation/bad_memory.txt: " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 09/32] Documentation/basic_profiling.rst: convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 10/32] Documentation/binfmt_misc.txt: convert it " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 11/32] Documentation/serial-console.txt: " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 12/32] Documentation/braille-console: " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 13/32] Documentation/BUG-HUNTING: convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 14/32] Documentation/CodeOfConflict: add it to the development-process book Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 15/32] Documentation/devices.rst: convert it to ReST markup Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 16/32] Documentation/dynamic-debug-howto.txt: " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 17/32] Documentation/initrd.txt: convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 18/32] Documentation/init.txt: " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 19/32] Documentation/magic-number.txt: convert it " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 20/32] Documentation/md.txt: Convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 21/32] Documentation/module-signing.txt: convert " Mauro Carvalho Chehab
2016-10-17 16:55 ` [PATCH 22/32] Documentation/mono.txt: " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 23/32] Documentation/java.txt: " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 24/32] Documentation/oops-tracing.txt: " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 25/32] Documentation/parport.txt: " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 26/32] Documentation/ramoops.txt: convert it to ReST format Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 27/32] Documentation/sysfs-rules.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 28/32] Documentation/sysrq.txt: convert " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 29/32] Documentation/unicode.txt: convert it " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 30/32] Documentation/VGA-softcursor.txt: convert " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 31/32] Documentation/volatile-considered-harmful.txt: " Mauro Carvalho Chehab
2016-10-17 16:56 ` [PATCH 32/32] Documentation/parport.txt: fix table to show on LaTeX Mauro Carvalho Chehab
2016-10-17 22:43 ` Jonathan Corbet [this message]
2016-10-18 4:30 ` [PATCH 00/32] Create an User's manual and improve development-process book Markus Heiser
2016-10-18 13:37 ` Renaming Documentation/ [was [PATCH 00/32] Create an User's manual and improve development-process book] Jonathan Corbet
2016-10-18 14:16 ` Theodore Ts'o
2016-10-18 8:37 ` [PATCH 00/32] Create an User's manual and improve development-process book Mauro Carvalho Chehab
2016-10-18 10:01 ` Jani Nikula
2016-10-18 10:20 ` Mauro Carvalho Chehab
2016-10-18 10:35 ` Jani Nikula
2016-10-18 10:42 ` Mauro Carvalho Chehab
2016-10-18 23:25 ` Jonathan Corbet
2016-10-19 9:27 ` Mauro Carvalho Chehab
2016-10-19 10:08 ` Markus Heiser
2016-10-19 10:44 ` [PATCH] Documentation/sphinx: rename kernel-doc.py to kerneldoc.py Jani Nikula
2016-10-19 10:57 ` Markus Heiser
2016-10-21 20:27 ` Jonathan Corbet
2016-10-27 20:17 ` [PATCH 00/32] Create an User's manual and improve development-process book Andrew Morton
2016-10-27 20:36 ` Jonathan Corbet
2016-10-27 22:40 ` Mauro Carvalho Chehab
2016-11-08 13:57 ` Daniel Vetter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161017164342.28d4f0c3@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.