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

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

 



Em Mon, 12 Sep 2016 10:40:41 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> On Mon, 12 Sep 2016 11:47:51 -0300
> Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote:
> 
> > There are several documents related to Kernel development, where the
> > HOWTO working like an index to most of them.
> > 
> > Convert the documents mentioned at HOWTO (including it) to ReST and add them
> > at the Sphinx build.  
> 
> Some preliminary thoughts from seat 10A somewhere over New York state at
> the moment, seemingly...
> 
> - I only got parts of this in my inbox, cover letter not included; that
>   made it a bit hard to figure out what was going on.
> 
> - I like the general idea; it's the sort of thing I've been wanting to
>   do.
> 
> - 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 :)
> 
>   In a sense, much of what's in Documentation/ is "kernel development",
>   so the name may be a bit vague for a subset of the docs.  In the end, I
>   suspect we'll end up with sub-books on process, internal APIs, tools,
>   etc.  It's probably silly to think that we can come up with the ideal
>   organization from the outset, but it may be worth a try anyway.
> 
> - 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.
> 
> - Speaking of dangling links, it's important to fix up references to
>   documents from elsewhere in the docs tree when we move them.  It's an
>   easy thing to forget.
> 
> Anyway, mostly due to the known filename issues, I don't want to rush
> into this one in particular, so my inclination is to defer it past 4.9.
> Hopefully you don't object too strongly to that idea...?

After sleeping on it, perhaps we could re-order the patchset. I mean:
we can apply the patches that do the RST conversion, and postpone
past 4.9 the patches that rename the files and add them to the Sphinx
build.

That should help avoiding potential conflicts on those files, avoiding
rework.

If you prefer such approach, I can do such patch reorder.

> 
> Thanks,
> 
> jon



Thanks,
Mauro
--
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