[M3devel] organization of scripts folder

[Olaf Wagner]

Hi Randy,

I think it is a good idea to clean up and restructure the scripts
folder. The current layout has grown and was never 'designed'.

However, we should make sure that nothing breaks when we move scripts
around, especially for regression testing in Tinderbox and Hudson.
So changing things is fine as long as we consider and correct the
potential damage. As a backup, we could provide a script which creates
symbolic links for some current scripts which are called from outside
the scripts package itself in our test frameworks.

Olaf

Quoting Randy Coleburn <rcoleburn at scires.com>:

> 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
-- 
Olaf Wagner -- elego Software Solutions GmbH
                Gustav-Meyer-Allee 25 / Gebäude 12, 13355 Berlin, Germany
phone: +49 30 23 45 86 96  mobile: +49 177 2345 869  fax: +49 30 23 45 86 95
    http://www.elegosoft.com | Geschäftsführer: Olaf Wagner | Sitz: Berlin
Handelregister: Amtsgericht Charlottenburg HRB 77719 | USt-IdNr: DE163214194