[U-Boot] KernelDoc

Tom Rini
2012-09-27T17:26:16Z

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 09/26/12 23:19, Stefan Roese wrote:

[snip]
> BTW: I've done quite some Linux kernel work and never used this
> kernel-doc style so far. Its not mandatory in the Linux kernel. Not
> that this really matters in regards to U-Boot. But my personal
> feeling is, that we shouldn't make it much harder to push patches
> in U-Boot than in Linux.

Exactly. This gets at the point I was trying to make. It's not "make
these comments, magically get documentation". It's "make these
comments, write the rest of your documentation in the right XML
markup, get {pdf,html,man,etc,etc,etc} output". So the DM work is a
good reason / candidate to add the infrastructure (sine we already
have design docs). And someone could take the kernel mtdnand
template, update it with verbage about how we shim that in and also
get good docs. Other subsystems or "big" things could also make use
of this.

- --
Tom
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iQIcBAEBAgAGBQJQZIw3AAoJENk4IS6UOR1WTaoP/A3zdhlaZ7o7F8GXwPIOiSWT
b/ACtfiBPrFlZnLDMp0SGQ2NSdCwzkH1cL7jSPBbPXfIwefu3rWz4PZ8pQydfhm7
OHp4iiOfPGDc41OXsmQNK8NVxneyhzPRjNLQF6G/VAvALuPkZsD9nDOUxKLgqtEx
MhweRvo52DJTNROAnf+VkoUQ0k/epkCU/vquIKWQbLNg8ACEBQskPFm8Ze6Ix5yA
k0JXhGYjTBSpPdGC2w6qLHbtdWdtHf+R/CER0tpOyml0aLWfZpBt4irqNPI6gdrp
/5lX67k4KZ0wlWUWWcgCfF74Onxp8vavIA5MNcS9NvKuueglKqP+j7q9JP1Vv+7o
2GK3Z+GvFqrTLF84SVS25iC+D98EsOb4fKslieE5rjMTaNakQ3Hw9QTVY6tkypSA
zGlYUK40eKmlt72Xh37vhYRUtSZ+yjGkxEQC3fCLo/WBgTUsM/NGaiPIW0Jn1zA6
/dognravZFpofSY5tF7hkzjV4xhSU4Chq3fe3lBXI3fY4XwOrzNVq+hXGWAEz7fW
e/oTmisJj09sk6KdxS14eejoB4fS5WzuRbTS9b1iDzksqw+Odiud8j5KPM6iVaEb
NPyRLpSJOOgWg5uYXCUyfl67XjnnvmyPyWTrpUancWLPf7bSL7Pn0fJuK0IQNEUN
175m/a86u/PK4vRKjOp8
=EteI
-----END PGP SIGNATURE-----