On Thu, 18 Jan 2018, Randy Dunlap <rdun...@infradead.org> wrote: > On 01/18/2018 06:09 AM, Jani Nikula wrote: >> On Thu, 11 Jan 2018, Konstantin Ryabitsev <konstan...@linuxfoundation.org> >> wrote: >>> On Wed, Jan 10, 2018 at 02:05:16PM -0700, Jonathan Corbet wrote: >>>>> Does such document belong with the rest of the kernel docs in the >>>>> tree, >>>>> or should it remain fully external? I'll be happy to port it to RST if >>>>> you think it should live alongside other documents like coding >>>>> standards. >>>> >>>> My immediate impression is that there is a lot of useful information >>>> there, but quite a bit of it covers topics that are somewhat peripheral >>>> to kernel development itself. I fear it would languish because few would >>>> think to look for it there. Thus, my first inclination is external. >>>> >>>> That said, if others want it in the docs tree, I'll happily take it. As >>>> I said, there's lots of good stuff there. >>> >>> Yeah, I was going to have a much slimmer version for the kernel devs. >>> >>> Let me do this -- I'll go ahead and produce the document I think would >>> be good for kernel devs, based on the more generic document I mentioned >>> earlier. Then I will get in touch again so we can see if that version is >>> something that should go into the doc tree or continue to live >>> externally. Converting from .md into .rst is straightforward enough. >> >> If you all choose to host it externally after all, I think the kernel >> documentation should at least have a minimal document pointing people at >> the external documentation. > > and/or somewhere on wiki.kernel.org.
On a side note, I was browsing for the generated kernel documentation at https://www.kernel.org/ and realized that AFAICT there are no links to https://www.kernel.org/doc/ or https://www.kernel.org/doc/html/latest/. The former could use some love, but I think the latter is nice enough to warrant a link from the main page. 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 majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
