[Swift-devel] Proposed sites.xml management for 0.92 release

[Michael Wilde]

Sarah, David,

While there has been no response on the email list on this, Justin tells me that he's OK with it. He wont be able to work on it due to other priorities, though.

Can you both collaborate to implement it? Its very similar to what you did with swiftconfig, David.

Lets first resolve: should it be in shell, python, or perl? (I favor these in the order listed)

I think we need this asap. Can the two of you work together to make it happen?

Lets use this email thread and the wiki page to work out the details, on swift-devel.

The main steps are:

- create the initial command
- create and test a library of templates
  (drawing the templates from the test suite?)
- create the doc page content (wiki) for end users:
  http://www.ci.uchicago.edu/wiki/bin/view/SWFT/GenSites
  -- should describe the command(s) and conventions
  -- should describe the templates, perhaps with comments in each template
  -- gensites -T  # lists all template
  -- gensites -h # gives basic help
  -- gensites -h template # gives the help for specific template(s)
- add any support for genapps? (gentc.sh)

Do you want to do a voice call or txt chat to get this going, or should we do it all in email?

- Mike


----- Original Message -----
> Based on discussions in the last 2 weekly meetings, I want to propose
> this for 0.92, based on Justin's page
> http://www.ci.uchicago.edu/wiki/bin/view/SWFT/CoastersCookbook under
> "Script snippets".
> 
> Im proposing here a few name changes, specific file location
> conventions, but basically staying in the spirit of Justin's scripts.
> 
> gensites.sh -> etc/gensites
> settings.sh -> merged into a local swift.properties file
> 
> The swift command "sites" will generate a sites.xml file in the
> current directory based on the users "site settings" (obtained from
> swift.properties) and one or more template files that are provided in
> the Swift release and which can be augmented with the user's own
> template collection(s).
> 
> User selects a site template from $SWIFT/etc/sites
> 
> gensites templates >sites.xml
> 
> gensites -p sites.properties templates >sites.xml
> 
> gensites -L template.dir templates >sites.xml
> 
> The user typically runs gensites only once per run directory
> 
> Templates are searched for in the following locations:
> 
> - current directory
> - etc/sites in the Swift directory
> - $HOME/.swift/sites in the user's home directory
> - any -L directories specified on the gensites command line
> 
> The user's sites-related properties are obtained from:
> 
> - sites.properties in the current directory
> - the -p file specified on the gensites command line
> - $HOME/.swift/sites.properties
> - $HOME/.swift/swift.properties lines with starting with #site
> 
> Obviously the fine details of this need to be nailed down; there's
> some room for discussion for how simple and/or flexible to make this.
> As long as the search and editing rules are clearly stated, I think
> users will be well served and happy.
> 
> Each template should have comments describing its use, nature, and
> user-changeable settings and defaults.
> 
> The command should flag required parameters that were not specified in
> the user's settings. The generated sites.xml file could contain
> comments stating where the options and templates came from.
> 
> Im putting this text in:
> 
> http://www.ci.uchicago.edu/wiki/bin/view/SWFT/GenSites
> 
> and we can document specific site file templates in:
> 
> http://www.ci.uchicago.edu/wiki/bin/view/SWFT/SiteFiles
> 
> - Mike
> 
> 
> --
> Michael Wilde
> Computation Institute, University of Chicago
> Mathematics and Computer Science Division
> Argonne National Laboratory
> 
> _______________________________________________
> Swift-devel mailing list
> Swift-devel at ci.uchicago.edu
> http://mail.ci.uchicago.edu/mailman/listinfo/swift-devel

-- 
Michael Wilde
Computation Institute, University of Chicago
Mathematics and Computer Science Division
Argonne National Laboratory