[Corredor-commits] SF.net SVN: corredor: [3] corredor/trunk

[<br...@us...>]

Revision: 3
          http://svn.sourceforge.net/corredor/?rev=3&view=rev
Author:   brlcad
Date:     2006-09-19 10:38:11 -0700 (Tue, 19 Sep 2006)

Log Message:
-----------
updated documentation including a stubbed BUGS file, details on getting involved, a rough sketch of plans, as well as a brief guide on installing

Modified Paths:
--------------
    corredor/trunk/README

Added Paths:
-----------
    corredor/trunk/BUGS
    corredor/trunk/HACKING
    corredor/trunk/INSTALL
    corredor/trunk/TODO

Added: corredor/trunk/BUGS
===================================================================
--- corredor/trunk/BUGS	                        (rev 0)
+++ corredor/trunk/BUGS	2006-09-19 17:38:11 UTC (rev 3)
@@ -0,0 +1,25 @@
+Corredor Bugs
+=============
+
+Bugs should be reported to the bug tracker on the project website at
+http://sourceforge.net/tracker/?atid=640802&group_id=102847
+
+The bugs and issues listed in here may or may not be the same as or
+related to the bugs reported to the bug tracker.  In general, users
+should not look to this file for information regarding the status of
+bugs.  Informal bug-related information that is intended for
+developers will generally be found here.  This may include short term
+issues that are in active development as well as long term and
+on-going issues.
+
+Recent Bugs
+-----------
+
+* none known yet, no formal release
+
+
+---
+Bugs should be reported to the bug tracker on the project website at
+http://sourceforge.net/tracker/?atid=640802&group_id=102847
+
+BUGS should be formatted to column 70 (M-q in emacs), no tabs.


Property changes on: corredor/trunk/BUGS
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: corredor/trunk/HACKING
===================================================================
--- corredor/trunk/HACKING	                        (rev 0)
+++ corredor/trunk/HACKING	2006-09-19 17:38:11 UTC (rev 3)
@@ -0,0 +1,84 @@
+The Hackers Guide to Corredor
+=============================
+
+Please read this document if you are planning on contributing to
+Corredor.
+
+Corredor is a relatively straight-forward project that is easily
+extended by the user community.  Corredor is comprised of three main
+components.  There is the primary driver application script
+(i.e. "corredor"), a library loader (i.e. Resources/library), and
+modules like the test bucket directories and the modular functionality
+of Corredor itself (i.e. Resources/Source).  Individuals looking to
+extend Corredor's functionality will likely be looking at the last of
+those three -- modules.
+
+
+TABLE OF CONTENTS
+-----------------
+  Introduction
+  Table of Contents
+  Communicating
+  How to Contribute
+  Coding Style & Standards
+  
+
+COMMUNICATING
+-------------
+
+As there are many ways to get started with Corredor, one of the most
+important steps for new contributors to do is get involved in the
+discussions and communicate with the Corredor developers.  There are
+mailing lists, on-line forums, and an IRC channel available for
+Corredor development and project communication.  All contributors are
+encouraged to participate in any of the available communication
+channels:
+
+* Internet Relay Chat
+
+  The primary and generally preferred mechanism for interactive
+  developer discussions is via Internet Relay Chat (IRC).  Several of
+  the core developers and core contributors of Corredor hang out in
+  #brlcad on the Freenode network, a channel that is currently shared
+  with the BRL-CAD project.  With most any IRC client, you should be
+  able to join #brlcad on irc.freenode.net, port 6667.  See
+  http://freenode.net and http://irchelp.org for more information
+
+* E-mail Mailing Lists
+
+  There are several mailing lists available for interaction, e.g. the
+  http://sourceforge.net/mail/?group_id=102847 "corredor-devel" mailing
+  list.  More involved contributors may also be interested in joining
+  the "corredor-commits" and "corredor-tracker" mailing lists.
+
+* On-line Forums
+
+  Discussion forums are available on the project site at
+  http://sourceforge.net/forum/?group_id=102847 for both developers
+  and users.  Of particular interest to developers is, of course, the
+  "Developers" forum where all contributors are incouraged to
+  participate.
+
+
+HOW TO CONTRIBUTE
+-----------------
+
+Basically, just jump in.  The project isn't complicated enough to
+warrant any heavy handed procedures.  Make a patch and post it
+"somewhere" (ideally the sf.net patches tracker) and it will get
+reviewed and probably included.  If you do make a patch, unified diffs
+of modified files and tarballs of new files are preferred.
+
+If you are really interested in becoming heavily involved in the
+project, commit access can be provided.
+
+
+CODING STYLE & STANDARDS
+------------------------
+
+The ONLY assumption Corredor or any of Corredor's source modules may
+make is the availability of a POSIX shell environment.  Anything
+outside of that must be tested for (e.g. trying to use sendmail) and
+remain optional.
+
+---


Property changes on: corredor/trunk/HACKING
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Added: corredor/trunk/INSTALL
===================================================================
--- corredor/trunk/INSTALL	                        (rev 0)
+++ corredor/trunk/INSTALL	2006-09-19 17:38:11 UTC (rev 3)
@@ -0,0 +1,109 @@
+Corredor Installation & Setup Guide
+===================================
+
+Installation of the Corredor Automation & Testing Suite is a fairly
+straightforward process that involves installing the Corredor files
+and then defining your run tests.  Corredor itself requires no
+compilation or preparation other than requiring that you have a POSIX
+compliant shell environment.  Suitable environments include Mac OS X,
+the Cygwin/Mingw compatibility environment for Windows, most of the
+various flavors of BSD, most of the various distributions of Linux,
+and most UNIX operating systems.
+
+TABLE OF CONTENTS
+-----------------
+  Introduction
+  Table of Contents
+  Quick Installation & Setup
+  Installation & Setup Details
+  Reporting Problems
+
+
+QUICK INSTALLATION & SETUP
+--------------------------
+
+Since you are reading this document, it is assumed that you have
+obtained the full sources of Corredor and are ready to get started
+setting up Corredor to work with your project.  For the impatient or
+simplistic, the following should get you going fairly quickly with
+minimal effort.
+
+1) Copy the "corredor" file and "Resources" directory into your
+project sources or into a system directory. Example:
+
+cp -R corredor Resources /path/to/your/project
+
+2) Create a directory that will contain run tests for your project.
+This directory will contain one file or directory per test.  Example:
+
+mkdir /path/to/your/project/Tests
+
+3) Create a test.  This is a simple shell script that minally contains
+the commands you want to run.  An example of such a script that will
+build a traditional GNU Build System project that uses configure:
+
+cat > /path/to/your/project/Tests/Build <<EOF
+#!/bin/sh
+if [ ! -f configure ] ; then
+    if [ -f autogen.sh ] ; then
+	sh autogen.sh
+    else
+	autoreconf -is
+    fi
+    if [ ! -f configure ] ; then
+	bomb "Could not find configure"
+    fi
+fi
+./configure
+if [ $? != 0 ] ; then
+    bomb "Configure failed"
+fi
+make
+if [ $? != 0 ] ; then
+    bomb "Compilation failed"
+fi
+log "Compilation succeeded"
+return 0
+
+EOF
+
+4) Create a ~/.corredorrc file with lines describing your project and
+where you've put files.  Example:
+
+cat > ~/.corredorrc <<EOF
+PACKAGE=name_of_your_project
+PACKAGE_SRC=/path/to/your/project
+TESTS_D=/path/to/your/project/tests
+EOF
+
+5) Run corredor.  You should now be able to run corredor and provide
+the "start" command.  It will copy your sources to a temporary
+directory (which is configurable) and run the tests in your test
+directory.  Example:
+
+/path/to/corredor start
+
+That should do it.  If that doesn't work, see the following section on
+INSTALLATION & SETUP DETAILS or review the proceeding instructions in
+closer detail.  If you have read and are still experiencing issues,
+please report those problems via the REPORTING PROBLEMS section below.
+
+INSTALLATION & SETUP DETAILS
+----------------------------
+
+Not yet written.  *ahem*
+
+
+REPORTING PROBLEMS
+------------------
+
+Please report any bugs encountered to the project bug tracker at
+http://sourceforge.net/tracker/?group_id=102847&atid=633006
+
+Similarly, please post any request for feature enhancements or support
+to http://sourceforge.net/tracker/?group_id=102847&atid=633009 and
+http://sourceforge.net/tracker/?group_id=102847&atid=633007
+respectively.
+
+---
+Cheers!


Property changes on: corredor/trunk/INSTALL
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native

Modified: corredor/trunk/README
===================================================================
--- corredor/trunk/README	2006-09-19 06:01:40 UTC (rev 2)
+++ corredor/trunk/README	2006-09-19 17:38:11 UTC (rev 3)
@@ -54,11 +54,14 @@
 GETTING STARTED
 ---------------
 
-To effectively utilize Corredor as an execution framework, some
+To effectively utilize Corredor as an execution framework, minimal
 preparation is required.  Namely, you will need to create execution
-scripts specific to you particular environment testing needs.
+scripts specific to you particular environment testing needs.  See the
+INSTALL file for a brief introduction on how to get started with
+Corredor.
+
 Corredor may also be used to benchmark the overall performance of
-shell environment.  See the BENCHMARK section for details.
+shell environment.  See the BENCHMARK section below for details.
 
 
 BENCHMARK
@@ -147,10 +150,11 @@
 CONTACT & CONTRIBUTIONS
 -----------------------
 
-Corredor is written and maintained by Christopher Sean Morrison.
-Feedback and contributions are always appreciated and welcome, and the
-project is always open to having others join in the direct development
-and improvement of Corredor.
+Corredor was originally conceived and remains primarily written and
+maintained by Christopher Sean Morrison.  Feedback and contributions
+are always appreciated and welcome, and the project is always open to
+having others join in the direct development and improvement of
+Corredor.  See the HACKING file for details on getting involved.
 
 Interactive support via IRC is preferred and generally available
 during UTC-5 hours on the Freenode network (irc.freenode.net:6667) in

Added: corredor/trunk/TODO
===================================================================
--- corredor/trunk/TODO	                        (rev 0)
+++ corredor/trunk/TODO	2006-09-19 17:38:11 UTC (rev 3)
@@ -0,0 +1,51 @@
+Corredor To Do List
+===================
+
+Included below is a list of items that are scheduled or desirable to
+have done at some point.  Most recently added items are on top, older
+topics are on the bottom.  This is not an official list, it's more of
+a scratch pad to use for tracking development ideas and informal
+plans in a lightweight manner.
+
+THESE SHOULD HAPPEN BEFORE THE FIRST RELEASE
+--------------------------------------------
+
+* basic local operation respecting test dependencies
+
+* basic documentation on installation and setup
+
+
+THESE SHOULD HAPPEN WITHIN TWO RELEASE ITERATIONS
+-------------------------------------------------
+
+* improved logging framework via log4sh
+
+* remote operation
+
+
+THESE ARE FOR FUTURE RELEASES
+-----------------------------
+
+* add multiproject single-install support
+
+* add self-installation support (e.g. sudo ./corredor install)
+
+* web interface for benchmark results
+
+* modules for system characteristics (cpu, architecture, OS, versions,
+  memory, disks, network, etc)
+
+* modules for various command tools (posix or otherwise)
+
+* ability to step through scripts one statement at a time for
+  debugging and testing support
+
+* shell script compiler written in shell
+
+
+---
+See the project task tracker for more to do items and future planning
+efforts.  http://sf.net/pm/?group_id=102847
+
+TODO items should be formated to column 70 (M-q in emacs), no tabs
+


Property changes on: corredor/trunk/TODO
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.