Hi all,

In thinking about user documentation, I was wondering whether we should
think about adding doc/target/ and doc/boards directories.  In it, we
would place a documentation file for each supported target and board,
respectively.  It may be possible to consolidate some guides, but this
would allow us to provide a nice addition to the user guide that would
answer the example question:  "what do I do to get target XX working?"

Basically, I am suggesting target Quick Setup Guides, References, and
FAQs.  If we consider the same thing for the JTAG interfaces, this would
allow us to move most of the part-specific text out of the main User
Guide proper, allowing it to focus on introducing the general concepts
that apply to all targets, boards, and interfaces.

With a little planning, these might be done with similar LaTeX tricks as
the quick/full reference guide proposed recently, allowing us to
generate a standard looking PDF for each target that fits nicely on a
2-page double-sided template.  Each could have its own conforming
OpenOCD Target Reference Guide and Target FAQ as well.

Thoughts?  As with my earlier suggestions, I could be talked into
providing the LaTeX skeletons that others can then flesh out over time.

Cheers,

Zach


_______________________________________________
Openocd-development mailing list
Openocd-development@lists.berlios.de
https://lists.berlios.de/mailman/listinfo/openocd-development

Reply via email to