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
+...@section 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.
+...@example
+/target/Atmel_AT91SAM9260.cfg not /target/Atmel AT91SAM9260.cfg
+...@end example
+
+Rule 2: The manufacturer name must be prefixed to group files.
+...@example
+/board/Atmel_AT91SAM7S-EK.cfg not /board/AT91SAM7S-EK.cfg
+...@end example
+
+Rule 3: The name used must be as close as possible to the original name given
by
+the manufacturer, including capitalization.
+...@example
+/target/Atmel_AT91SAM7S256.cfg not sam7s256.cfg or at91sam7s256.cfg
+...@end example
+
+Rule 4: If a config file covers a range of targets, then the biggest common
+denominator must be used.
+...@example
+/target/Atmel_AT91SAM7S.cfg covers all AT91SAM7Sxxx targets
+...@end 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.
+...@example
+/target/Atmel_AT91SAM7S16.cfg is not covered by /target/Atmel_AT91SAM7S.cfg
+...@end example
+
+
@include fdl.texi
@node OpenOCD Index
-----Original Message-----
From: oyvindhar...@gmail.com [mailto:oyvindhar...@gmail.com] On Behalf Of
Øyvind Harboe
Sent: 04 March 2009 10:37 AM
To: Pieter Conradie
Cc: openocd-development@lists.berlios.de
Subject: Re: [Openocd-development] Naming convention of *.cfg files
On Wed, Mar 4, 2009 at 9:01 AM, Pieter Conradie
<pieter.conra...@psitek.com> wrote:
> Hi everyone,
>
>
>
> I have noticed discrepancies in the names of the CFG files, which could
> confuse users of OpenOCD. Example: at91sam9260.cfg vs. sam7x256.cfg
>
>
>
> Maybe we need a naming convention.
Sounds good to me. If you are willing to step up to the plate and
submit a patch
to the openocd documentation which defines the naming convention that could
be a good start?
> 1. Capitalization: Should we start to use capitalization to reflect the
> actual name that manufacturers use? Example: AT91SAM9260.cfg vs.
> at91sam9260.cfg
makes sense to me. Proper capitalisation/naming can make this look prettier.
I'm also in favour of using spaces in the names if hat helps it make more
human readable.
> 2. Manufacturer name prefixed to files to group them, e.g.
> /target/Atmel_AT91SAM9260.cfg or /target/Atmel/AT91SAM9260.cfg. See
> samsung_s3c2410.cfg. The same should apply to the board directory, e.g.
> /board/Atmel_AT91SAM9260-EK.cfg or /board/Atmel/AT91SAM9260-EK.cfg
I'm not sure how well this will work or how obvious it will be. What
about a PCB
with an FPGA from A and a MCU from B produced by C?
-
Øyvind Harboe
PayBack incident management system
Reduce costs and increase quality, free Starter Edition
http://www.payback.no/index_en.html
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 Openocd-development@lists.berlios.de https://lists.berlios.de/mailman/listinfo/openocd-development
