[Arm-netbook] Documentation Proposal

[cnxsoft]

Hi,

Since there seems to be a bit a tension regarding documentation and 
tracking changes, I would like to make a proposal about how it could be 
organized.

*Software changes*
For kernel, u-boot, tools changes, let's use Amery github account 
https://github.com/amery (if that's OK with him).
Each time code is committed there is a log entry, so If somebody wants 
to see the software changes, he could just check the log (git log could 
also refer to the corresponding mailing list thread). If need-be, a text 
based ChangeLog could be also generated automatically.

*Wiki*
The wiki would be a good place for how-tos, such as the existing how to 
prepare an SD card 
(http://rhombus-tech.net/allwinner_a10/a10_mmc_boot/), how to compile 
the kernel (http://rhombus-tech.net/allwinner_a10/kernel_compile/).
It can also be used introduce/describe the project, hardware, available 
software.

*Mailing list*
IMHO, the mailing list should be used for all sort of exchange. If 
somebody post a patch for example, and it's accepted, it will be 
committed to github (and there will be a log for that).
For tools and scripts,, they could also be added to github.

*Bug Tracking*
Amery suggested to use the issues tracker in github. That's fine, but 
there may be some things that are user-space related (e.g. X11 
acceleration, video decoding, rootfs modifications), so I'm not sure 
it's ideal to use github for those.

On a slightly different topic, it seems we now focus development on the 
kernel/bootloader, but nothing is done on Linux distributions yet. It 
might be a good idea to select some distributions e.g. Ubuntu, Debian. 
(Pick your choice).
We don't need to take care of the main rootfs which can be retrieved 
online, but AllWinner A10 specific items could be stored in hardware 
packs as Linaro does with their supported platform, and simply use a 
tool (called linaro-media-create) to create an image based on the rootfs 
and the hardware pack. We could also have the A10 hardware pack in 
github, where changes would be documented (log after each commit) and 
use github issue tracker for bugs/feature requests.

For example, software changes made to the software would be not 
documented in the Wiki as details about the changes are accessible in 
github, but the method to retrieve the different binaries, how-to create 
an image and possibly a Changelog between releases would be added to the 
WiKi.

Waiting for feedback and suggestions.

Peace,
Jean-Luc

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.phcomp.co.uk/pipermail/arm-netbook/attachments/20120519/6d406cf8/attachment.html