Re: [PATCH 09/17] kernel-docs.rst: convert it to ReST markup

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

 



I just saved the new .rst file and tested it with rst2html and rst2pdf.
Conversion ran without Errors, Markup/Layout looks sensible to me.

Some nit-picking:
> +
> +BOOKS: (Not on-line)
> +--------------------
> +
> +     * Title: **Linux Device Drivers**
> +
> +       :Author: Alessandro Rubini.
> +       :Publisher: O'Reilly & Associates.
> +       :Date: 1998.
> +       :Pages: 439.
> +       :ISBN: 1-56592-292-1
> +

It looks like every dot at the end of such a item line induces and line
break and an empty line between to items in this field list.

This makes it a bit harder to read and since all the items in the
previous Sections had no dots at the end of the line these look
inconsistent.

Indentation
-----------
The original text (and the conversion) uses 5 spaces for indentation.
Perhaps 4 or 2 spaces would be nicer.

> +
> +     * Name: **linux-kernel mailing list archives and search engines**
> [...]
> +       :URL: http://marc.theaimsgroup.com/?l=linux-kernel
It looks like this mirror is down. But this is perhaps something for an
extra patch.


If desired I can send a patch for these things. I don't know the
process-rule what to do in such a case. Sorry. Also: would a
"Tested-By: .." line make sense in such a case?


Thanks
-- Richard
--
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