[M3devel] organization of scripts folder

[Randy Coleburn]

I would like to better understand the rationale behind the "scripts" folder in terms of how it is organized and supposed to be used.
 
Here is the current folder structure:
 
scripts
+---config
+---doc
+---examples
+---iphone
|   \---1
+---python
+---regression
\---win
 
In the past, I had put some BAT/CMD scripts in the "scripts" folder with the intent that these would be placed in the "bin" folder of the target install.  Later, the other subfolders were added, including the one named "win".
 
It seems there are perhaps multiple intentions for the scripts folder.  For example, there are scripts that one would use mainly in setting up, maintaining, or administering cm3.  There are other scripts that would be useful for certain target platforms as part of the installed system.  There may be other scripts useful for testing.
 
I am almost finished with testing of a new script I want to be included in the "bin" folder of the installed system on Windows platforms.  This script will replace some of the old ones I have out there.  It is designed to work with Win2000, WinXP, and Vista, whereas my old scripts don't work well on Vista.  I also have some scripts I've built that aid in rebuilding package sets based on the PkgInfo.txt file.
 
Before I remove my old scripts and replace them with the new ones, I thought it best for us to think about how the scripts folder should be organized.
 
As a first cut, I propose something along the following lines:
 
scripts
+---doc = documentation for stuff in the "scripts" folder tree
+---dev = scripts used for system development, maintenance, admin
+   +---windows = dev scripts written for Microsoft Windows (BAT, CMD)
+   +---posix = dev scripts written for unix shell (sh, bash, etc.)
+   \---python = dev scripts written in python
+---install = scripts that should be put in "bin" folder of target install

+   +---common = scripts common to all target platforms
+   +---windows = BAT/CMD scripts for Microsoft Windows
+   +---posix = shell scripts for POSIX platforms (sh, bash, etc.)
+   +---python = scripts written in python (applicable to any platform with python)
+   \---XXX = scripts for target platform XXX (XXX is name of platform)
+             (assuming XXX needs something special not covered above)
\---test = scripts used for regression testing
    +---windows = test scripts written for Microsoft Windows (BAT, CMD)
    +---posix = test scripts written for unix shell (sh, bash, etc.)
    \---python = test scripts written in python
 
What do you think?
 
Regards,
Randy Coleburn
 
 

CONFIDENTIALITY NOTICE:  This email and any attachments are intended solely for the use of the named recipient(s). This e-mail may contain confidential and/or proprietary information of Scientific Research Corporation.  If you are not a named recipient, you are prohibited from making any use of the information in the email and attachments.  If you believe you have received this email in error, please notify the sender immediately and permanently delete the email, any attachments, and all copies thereof from any drives or storage media and destroy any printouts of the email or attachments.

EXPORT COMPLIANCE NOTICE:  This email and any attachments may contain technical data subject to U.S export restrictions under the International Traffic in Arms Regulations (ITAR) or the Export Administration Regulations (EAR).  Export or transfer of this technical data and/or related information to any foreign person(s) or entity(ies), either within the U.S. or outside of the U.S., may require export authorization by the appropriate U.S. Government agency prior to export or transfer.  In addition, technical data may not be exported or transferred to certain countries or specified designated nationals identified by U.S. embargo controls without prior export authorization.  By accepting this email and any attachments, all recipients confirm that they understand and will comply with all applicable ITAR, EAR and embargo compliance requirements.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://m3lists.elegosoft.com/pipermail/m3devel/attachments/20091027/2be7de5f/attachment-0001.html>