On Mar 5, 2009, at 6:33 AM, Laurent Gauch wrote:


Hi Øyvind and list members,

I have taken artistic liberty to create the first draft of the Config file (*.cfg) naming convention. I guess that it is now open to debate. Over to you...

Best regards,
Pieter

Index: openocd.texi
===================================================================
--- openocd.texi        (revision 1399)
+++ openocd.texi        (working copy)
@@ -3825,8 +3825,43 @@
at91sam9260.cfg  nslu2.cfg     sam7x256.cfg    wi-9c.cfg
@end example

+ at section <https://lists.berlios.de/mailman/listinfo/openocd-development > Config (*.cfg) file naming convention

+Here are the basic rules to give consistency to the file names and to organise
+config files.

+Rule 1: File names may not contain spaces. Use underscores ('_') instead to +separate words. This avoids having to work out if quotes and what type of quote
+must be used to specify a file.
+ at example <https://lists.berlios.de/mailman/listinfo/openocd-development >
+/target/Atmel_AT91SAM9260.cfg not /target/Atmel AT91SAM9260.cfg
+ at end <https://lists.berlios.de/mailman/listinfo/openocd-development > example
+
+Rule 2: The manufacturer name must be prefixed to group files.
+ at example <https://lists.berlios.de/mailman/listinfo/openocd-development >
+/board/Atmel_AT91SAM7S-EK.cfg not /board/AT91SAM7S-EK.cfg
+ at end <https://lists.berlios.de/mailman/listinfo/openocd-development > example
+
+Rule 3: The name used must be as close as possible to the original name given by
+the manufacturer, including capitalization.
+ at example <https://lists.berlios.de/mailman/listinfo/openocd-development >
+/target/Atmel_AT91SAM7S256.cfg not sam7s256.cfg or at91sam7s256.cfg
+ at end <https://lists.berlios.de/mailman/listinfo/openocd-development > example
+
+Rule 4: If a config file covers a range of targets, then the biggest common
+denominator must be used.
+ at example <https://lists.berlios.de/mailman/listinfo/openocd-development >
+/target/Atmel_AT91SAM7S.cfg covers all AT91SAM7Sxxx targets
+ at end <https://lists.berlios.de/mailman/listinfo/openocd-development > example
+
+Rule 5: If a config file is for a specific target, not covered by a generic
+config file, then the full name must be used.
+used.
+ at example <https://lists.berlios.de/mailman/listinfo/openocd-development > +/target/Atmel_AT91SAM7S16.cfg is not covered by /target/ Atmel_AT91SAM7S.cfg + at end <https://lists.berlios.de/mailman/listinfo/openocd-development > example
+
+
@include fdl.texi

@node OpenOCD Index




For me it will be better to remove uppercase for any files.

/target/atmel_at91sam7s.cfg not /target/Atmel_AT91SAM7S.cfg
/board/atmel_at91sam7s-ek.cfg not /board/Atmel_AT91SAM7S-EK.cfg

I would like that ALL openocd source files use 'abcdef' but not 'AbcDeF , including .cfg files.

Laurent

Laurent Gauch

http://www.amontec.com
Making JTAG a snap !

______________________________

*Amontec To Exhibit at Embedded World 2009
*Amontec Hi-Speed JTAGkey2
Compare JTAGkey and JTAGkey2 speeds yourself at

Embedded World 2009 <http://www.embedded-world.de/en/> in Nuremberg,
Germany from 3rd - 5th March 2009
FTDI Hall 12 Stand 442




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


One thing to remember is that not all systems are case-sensitive. We should avoid any potential names where the only difference is case.

--
Rick Altherr
kc8...@kc8apf.net

"He said he hadn't had a byte in three days. I had a short, so I split it with him."
 -- Unsigned



Attachment: smime.p7s
Description: S/MIME cryptographic signature

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

Reply via email to