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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <C1B90562-38F2-4929-98B0-F2BE2079358A@darmarit.de>
Date:   Wed, 19 Oct 2016 12:08:10 +0200
From:   Markus Heiser <markus.heiser@...marit.de>
To:     Jonathan Corbet <corbet@....net>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 00/32] Create an User's manual and improve development-process book


Am 19.10.2016 um 01:25 schrieb Jonathan Corbet <corbet@....net>:

> On Tue, 18 Oct 2016 08:20:18 -0200
> Mauro Carvalho Chehab <mchehab@...pensource.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@...r.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html