Hi all, I have updated the config file naming convention according to all the suggestions. Is this better?
Regards,
Pieter
Index: openocd.texi
===================================================================
--- openocd.texi (revision 1399)
+++ openocd.texi (working copy)
@@ -3825,8 +3825,51 @@
at91sam9260.cfg nslu2.cfg sam7x256.cfg wi-9c.cfg
@end example
+...@section Config (*.cfg) file naming convention
+Here are the basic rules to give consistency to the file names and to group
+config files.
+Rule 1: The file name must be in lower case (no capitalisation).
+...@example
+/target/samsung_s3c2410.cfg not Samsung_S3C2410.cfg
+...@end example
+
+Rule 2: The file name may not contain spaces. Use underscores ('_') instead to
+separate words. *All* non-ascii problematic chars must be replaced by
+underscores ('_') or removed. This avoids having to work out if quotes and what
+type of quote must be used to specify a file.
+...@example
+/target/atmel_at91sam9260.cfg not /target/atmel at91sam9260.cfg
+...@end example
+
+Rule 3: The file name used must be as close as possible to the original name
+given by the manufacturer.
+...@example
+/target/atmel_at91sam7s256.cfg not /target/atmel_sam7s256.cfg
+/board/atmel_at91sam7s-ek.cfg not /board/atmel_sam7s_ek.cfg
+...@end example
+
+Rule 4: For target files the CPU manufacturer name must be prefixed. For
boards,
+the board manufacturer name must be used.
+...@example
+/target/nxp_lpc2129.cfg not /target/lpc219.cfg
+/board/olimex_sam9_l9260.cfg not /target/sam9_l9260.cfg
+...@end example
+
+Rule 5: If a config file covers a range of targets, then the biggest common
+denominator name must be used.
+...@example
+/target/atmel_at91sam7s.cfg covers all AT91SAM7Sxxx targets
+...@end example
+
+Rule 6: If a config file is for a specific target, not covered by a generic
+config file, then the full name must be used.
+...@example
+/target/atmel_at91sam7s16.cfg is not covered by /target/atmel_at91sam7s.cfg
+...@end example
+
+
@include fdl.texi
@node OpenOCD Index
Notice
This email is intended for the addressee only and may contain legally
privileged and/or confidential information. If you have received this email in
error and are not the intended recipient, you are hereby informed that you are
not entitled to read, broadcast, distribute or in any manner whatsoever use the
contents of this email or any attachments thereto. You are requested to please
notify Psitek that you have received the email and then delete it. Unless
clearly stated otherwise, the content and sentiments expressed in this email or
any attachments thereto are those of the sender and not of Psitek (Proprietary)
Limited. Psitek does not accept liability for any damages, loss or expense of
any nature whatsoever arising (a) out of or in connection with the email or any
attachments thereto and/or (b) from any act or omission by the recipient
relying upon the content of the email or attachments. Psitek further disclaims
liability for any damages caused by computer and/or software viruses. Should
this email contain the terms of a contract, no binding agreement will result
until such time as a written (hardcopy) document is signed on behalf of Psitek.
openocd.texi.patch
Description: openocd.texi.patch
_______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
