Skip to contentSkip to conversation

boards.cfg: update local documentation

PATCH New Mike Frysinger 2 participants 2 messages Oct 19, 2010

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 boards.cfg: update local documentation

The "options" field at the moment is only documented in the changelog which isn't terribly useful to people without git.

---
 boards.cfg |   14 +++++++++++---
 1 files changed, 11 insertions(+), 3 deletions(-)
boards.cfg +11 -3
index d6c3401..443f9bd 100644
@@ -3,9 +3,7 @@
 #
 # Syntax:
 #	white-space separated list of entries;
-#	each entry has the following fields:
-#
-#	Targetname  Architecture  CPU  Boardname  Vendor  SoC
+#	each entry has the fields documented below.
 #
 #	Unused fields can be specified as "-", or omitted if they
 #	are the last field on the line.
@@ -13,6 +11,16 @@
 #	Lines starting with '#' are comments.
 #	Blank lines are ignored.
 #
+#	The options field takes the form:
+#		<board config name>[:comma separated config options]
+#	Each config option has the form (value defaults to "1"):
+#		option[=value]
+#	So if you have:
+#		FOO:HAS_BAR,BAZ=64
+#	The file include/configs/FOO.h will be used, and these defines created:
+#		#define CONFIG_HAS_BAR	1
+#		#define CONFIG_BAZ	64
+#
 # To keep the list sorted, use something like
 #
 #	:.,$! sort -f -k2,2 -k3,3 -k6,6 -k5,5 -k1,1
Signature · 1 line
1.7.3.1
#1 lore raw

PATCH 1/1 boards.cfg: update local documentation

Dear Mike Frysinger,

Quoted 7 lines · In message <[email protected]> you wrote:

The "options" field at the moment is only documented in the changelog which isn't terribly useful to people without git.

---
 boards.cfg |   14 +++++++++++---
 1 files changed, 11 insertions(+), 3 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 5 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
We are Microsoft. Unix is irrelevant. Openness is futile.  Prepare to
be assimilated.