Re: [PATCH 00/17] Create a book for Kernel development

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Am 13.09.2016 um 12:08 schrieb Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx>:

> On Mon, 12 Sep 2016, Jonathan Corbet <corbet@xxxxxxx> wrote:
>> - We should think about naming and organization a bit.  I would have
>> called this collection something like development-process, since it's
>> really focused on the process side of things.  Oh, and I would have
>> included the existing development-process document :)
> 
> If there are going to be renames, it would be great to unify a bit
> between NamesWithCamelCase, names_with_underlines and
> names-with-dashes. And think of the bikeshedding potential!
> 
>> - Some of this will need wider exposure for a different reason: I suspect
>> there will be resistance to renaming well-known documents like
>> SubmittingPatches.  Everybody knows it's there and directs people to
>> it; simply moving it out will create lots of dangling mental links, and
>> I think people will grumble.  I don't really know how to solve that one.
> 
> Can we have symlinks in the repo for the most important documents?

just my 2cent - for the most important documents:

for a transitional period let the origin file exist on the old location.
Replace the content by a remark that this file has been moved. E.g.

<snip: Documentation/CodingStyle>-------
As part of the reorganization of the documentation, this file was moved:

* ./development-process/CodingStyle.rst
* http://static.lwn.net/kerneldoc/development-process/CodingStyle.html
* http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/development-process/CodingStyle
<snap>-------

IMHO this has the additional advantage, that web-bookmarks to the src-tree
e.g. my ;-) old bookmark ...

 http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle

will not break.

-- Markus --

> 
> 
> BR,
> Jani.
> 
> 
> -- 
> Jani Nikula, Intel Open Source Technology Center
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux