Re: [PATCH 0/3] Improve Kernel documentation guide

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

 



On Thu, 17 Nov 2016 08:32:32 -0200
Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote:

> The Kernel documentation guide is currently a single file at the top of
> Documentation/ dir. Sphinx works best if the documentation is
> inside a subdirectory, as otherwise there's no way to have a PDF book
> with its contents, without including everything else.
> 
> The first patch on this series address this, by splitting the
> kernel-documentation.rst file into the Documentation/doc-guide dir.
> 
> The next two patches add the missing documentation for the
> parse-headers.pl script, responsible to generate cross-references
> between uAPI header files and the Kernel documentation.

OK, I've applied this series (and merged the result with Daniel's
change).  But there's one thing...

> +.. NOTE: the man pages below were generated using pod2rst tool:
> +.. http://search.cpan.org/~dowens/Pod-POM-View-Restructured-0.02/bin/pod2rst
> +.. If you need to change anything below this point, please do the changes
> +.. at parse-headers.pl directly, re-run the script and paste the output of
> +.. the script here.

Here we've just added another generated file to the tree, and, to top it
off, the results are, um, not as pretty as one might like.  What are the
chances of just making the rst doc be the definitive one and putting a
pointer into pod2rst?

Thanks,

jon
--
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