I've been reviewing the OpenWrt documentation on the wiki and figured
the releases could use some documentation love as well as packages
documentation that get integrated into each release. I've started with
the Attitude Adjustment AA-12.09-beta2 release and have come up with a
set of scripts designed to help with documentation [0] be
automatically generated. Please review the code [0] and results [1]
and let me know what you think.

Given that opkg [2] was designed to produce smaller package files than
Debian does I've extracted documentation for each package from the
original AA release Packages file [3]. For now I've ran 'opkg
list-intsalled' against a DB120 and AP136 reference design board
running the AA-12.09-beta2 image [4] and noticed they both have the
same set of packages installed. To help parse the Packages file I'm
using deb822 module from the python-debian [5] package. Its not the
greatest but its *something* that I think we can start off with. One
convenient thing it does to the average developer browsing is spit out
the delta between the upstream package and refers to those files.
There's a few enhancements that this could use but for that I think
its best to get feedback at this point and work and collaborate
together.

To enhance this further I figure we could extract even more
information from Kconfig as well but that itself is a project alone
and requires some thought as to whether or not perhaps we want throw
more into Packages instead and have Kconfig parse the package
documentation for us there. It would also be good if the script would
just write onto the wiki itself, right now I had to add each page
manually. If we can configure MoinMoin to just let us have some wiki
content on some files then those could be read and we could then just
read the files which would be generated through some cronjob script.

Just an initial shot, let me know what you guys think.

[0] http://wiki.openwrt.org/doc/devel/packages/doc-scripts
[1] http://wiki.openwrt.org/doc/devel/packages/list
[2] http://wiki.openwrt.org/doc/devel/packages/opkg
[3] 
http://downloads.openwrt.org/attitude_adjustment/12.09-beta2/ar71xx/generic/packages/Packages
[4] http://downloads.openwrt.org/attitude_adjustment/12.09-beta2/ar71xx/generic/
[5] http://packages.debian.org/sid/python-debian

  Luis
_______________________________________________
openwrt-devel mailing list
[email protected]
https://lists.openwrt.org/mailman/listinfo/openwrt-devel

Reply via email to