On Tue, Mar 18, 2014 at 9:17 PM, Peter Stuge <[email protected]> wrote:

> Franck Jullien wrote:
> > >> commit d1333b5a7b0211280fe65181de4e9b68eca6950d
> > >> Author: Franck Jullien <[email protected]>
> > >> Date:   Tue Mar 18 20:04:30 2014 +0100
> > >>
> > >>     cfg: or1k_generic: allow TAP_TYPE override
> > >>
> > >>     This patch allows users to specify TAP_TYPE from
> > >>     the command line when using or1k_generic.cfg.
> > >
> > > Does this need a documentation update to go along with the change?
> >
> > Do we need to document any variable assignment from the command line ?
> > (that's a real question, I'm not ironic here).
>
> I'm also not sure - I was asking the same question. The TAP_TYPE
> variable will now have a meaning so perhaps it should be documented?
> I don't know either.
>
>
The question is if there's any or1k specific board configuration file
documentation in openocd.texi. My guess is no (and I don't think we should
document at that level). Then this specific variable probably shouldn't be
documented there either. Of course, the board config file itself counts as
documentation too (user readable/understandable source code) and in my
opinion that is enough.

Then again, the overall concept of being able to set variables on the
command line to affect configuration files probably should be documented in
openocd.texi. Perhaps it already is.

/Andreas
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/13534_NeoTech
_______________________________________________
OpenOCD-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openocd-devel

Reply via email to