On Thu, Apr 14, 2011 at 4:10 PM, Tomek CEDRO <[email protected]> wrote: > On Thu, Apr 14, 2011 at 2:02 PM, Øyvind Harboe <[email protected]> > wrote: >> I don't particularly like wiki's as they would not be in sync with the >> git source >> code. >> What's wrong with updating the documentation in OpenOCD git? > > No no, its not about doubling the manual! The manual is built up from > the doxygen and describes openocd usage and configuration (very well > by the way). Wiki is about placing documentation on some specific > hardware and software in one place. This way we could create one big > website with detailed desctiprion of many different embedded systems - > it could store information on protocols, photos, pinouts, errata, > notes, todos, and many more. It would be more general knowledge > helpful for OpenOCD's developers - just as it is in case of OpenWRT > hardware database for instance :-) There are lots of such pages and > projects spread around the web and mailing list archives, but these > are usually outdated, and such wiki would be great place to leave > comments/notes/ideas for later (re)use. Sourceforge provides such > ability with no effort (one click install, self update) so we should > make use of it :-)
I am supporting Tomek's idea - every bigger open source project has wiki pages, especially for development purposes. What it help also is that it gives inspiration and gives more "fame" to the project, as Tomek pointed out. It is not official documentation, but developers scratchpad. When you search solution for some completely other problem, you can end up on OpenOCD wiki and be attracted by the project and expertise of the dev community gathered around the project. That would be a great benefit. I prefer surfing wiki pages in search for general information then open hundreds of .txt files - it's faser. My $0.02. BR, Drasko _______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
