Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S943481AbcJSOy1 convert rfc822-to-8bit (ORCPT <rfc822;w@1wt.eu>);
        Wed, 19 Oct 2016 10:54:27 -0400
Received: from smtp1.goneo.de ([85.220.129.30]:58850 "EHLO smtp1.goneo.de"
        rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
        id S943063AbcJSOyY (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
        Wed, 19 Oct 2016 10:54:24 -0400
X-Spam-Flag: NO
X-Spam-Score: -2.9
Content-Type: text/plain; charset=us-ascii
Mime-Version: 1.0 (Mac OS X Mail 6.6 \(1510\))
Subject: Re: [PATCH 00/32] Create an User's manual and improve development-process book
From: Markus Heiser <markus.heiser@darmarit.de>
In-Reply-To: <20161018172542.20e03081@lwn.net>
Date: Wed, 19 Oct 2016 12:08:10 +0200
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>
Content-Transfer-Encoding: 8BIT
Message-Id: <C1B90562-38F2-4929-98B0-F2BE2079358A@darmarit.de>
References: <cover.1476717925.git.mchehab@s-opensource.com> <20161017164342.28d4f0c3@lwn.net> <87shruvuw2.fsf@intel.com> <20161018082018.17e09799@vento.lan> <20161018172542.20e03081@lwn.net>
To: Jonathan Corbet <corbet@lwn.net>
X-Mailer: Apple Mail (2.1510)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Length: 1609
Lines: 46


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