aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/style.txt
AgeCommit message (Collapse)Author
2016-05-24Make #include guard naming consistentMarc Schink
Change-Id: Ie13e8af0bb74ed290f811dcad64ad06c9d8cb4fa Signed-off-by: Marc Schink <openocd-dev@marcschink.de> Reviewed-on: http://openocd.zylin.com/2956 Tested-by: jenkins Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2012-01-09docs: fix doxygen buildSpencer Oliver
This fixes issues with newer versions of doxygen Change-Id: Id5d3287857cb154e26064b4ce37f6b72117d5254 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/350 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
2010-01-08Doc/examples: clarify usage messagesDavid Brownell
Update/bugfix the "hello" example; emphasize using EBNF syntax, matching the User's Guide. Correct the Texinfo style guide to say EBNF, not BNF. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-26styleguide: add some embedded style rules.Øyvind Harboe
Embedded and pthreads rely on modest and predictable stack usage. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-13update developer manual for new typesZachary T Welch
Update the style guide and chase obvious references to structures that have been renamed.
2009-10-08Change most in-tree references from SVN to GIT.dbrownell
Also, talk about "mainline" not "trunk". The release.txt and release.sh files need more updates. git-svn-id: svn://svn.berlios.de/openocd/trunk@2825 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-09-21Remove annoying end-of-line whitespace from doc/* files.dbrownell
git-svn-id: svn://svn.berlios.de/openocd/trunk@2744 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-08Add style rule to avoid combining assignment and logical tests.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2503 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-18Update Style Guide documentation to explain basic type rules.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2284 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-18David Brownell <david-b@pacbell.net>:zwelch
Take a whack at providing some texinfo style docs. Mostly it's just basic "how 2 write sane dox" stuff. git-svn-id: svn://svn.berlios.de/openocd/trunk@2270 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27Numerous minor updates and fixes for The Manual:zwelch
- Link Scripting Overview into the TCL Primer; both need more work. - Remove redundant OpenOCD from Scripting Overview subpage title. - Fix incorrect tag in Doxygen style guide example. - Fix minor typo in first introductory paragraph of main page. git-svn-id: svn://svn.berlios.de/openocd/trunk@1932 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27Add new Style Guides for languages used (and to be used) by project.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1924 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23Add extended doxygen-based style guide draft; requires more work.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1896 b42882b7-edfa-0310-969c-e2dbd0fdcd60