From: Markus Heiser <markus.heiser@darmarit.de>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Jani Nikula <jani.nikula@linux.intel.com>,
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: Wed, 19 Oct 2016 12:08:10 +0200 [thread overview]
Message-ID: <C1B90562-38F2-4929-98B0-F2BE2079358A@darmarit.de> (raw)
In-Reply-To: <20161018172542.20e03081@lwn.net>
Am 19.10.2016 um 01:25 schrieb Jonathan Corbet <corbet@lwn.net>:
> On Tue, 18 Oct 2016 08:20:18 -0200
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
>
>>> 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.
>>
>> For the rest, what's your preference?
>>
>> - FooBar.rst
>> - foo_bar.rst
>> - foo-bar.rst
>>
>> My personal preference is for "foo-bar".
>
> I guess that would be mine too. CamelCase is not generally all that
> popular in kernel space. On one hand, I worry about further renaming
> files that we're already moving; on the other, if we're going to do it, I
> guess this would be the time, when people will have to look for them
> anyway...
OT / but related to sphinx extension: python files should not named "foo-bar" [1].
I you do so, you can't use them as regular modules ...
>>> import foo-bar
File "<console>", line 1
import foo-bar
^
SyntaxError: invalid syntax
Hope there comes the time, we rename Documentation/sphinx/kernel-doc.py
and make a py-package from the sphinx folder.
[1] https://www.python.org/dev/peps/pep-0008/#package-and-module-names
>
> jon
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at http://vger.kernel.org/majordomo-info.html
next prev parent reply other threads:[~2016-10-19 14:54 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 ` [PATCH 00/32] Create an User's manual and improve development-process book Jonathan Corbet
2016-10-18 4:30 ` 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 [this message]
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=C1B90562-38F2-4929-98B0-F2BE2079358A@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).