Re: [PATCH] Converted zorro.txt to rst format and relocated

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

 



On Mon, 23 Jan 2017 08:41:34 +1000
Darryl Bond <darryl.bond@xxxxxxxxx> wrote:

> Moved file zorro.rst to
>  equivalent location as source in main tree, ie drivers/zorro This required
>  creation of Documentation/drivers. It is my suggestion that the Documentation
>  tree is organised in the same fashion as the source tree. It is then clear
>  where the documentation pertains to. There will be times when a document file
>  pertains to many parts of the tree. This will need to be resolved on a case
>  by case basis.

OK, a good first try.  Here's a few notes...

 - This particular document is clearly aimed at driver authors - it
   covers the API used to work with this bus.  So it's natural home is in
   the driver API guide.

 - You should always CC the author of a document like this when you make
   changes.  That's Geert in this case, indicated at the top of the
   file.  For this particular document, I would be really tempted to ask
   whether the document needs to be preserved at all.

 - Most of the time, we take section numbers out when doing these
   conversions; Sphinx can generate them if need be.

Thanks for helping with the documentation!

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