Changeset 114

Timestamp:

02/18/11 18:31:57 (15 months ago)

Author:

mgalloy

Message:

Improving docs, reporting version.

Location:

trunk

Files:

• Makefile (modified) (5 diffs)
• mgunit_build_docs.pro (modified) (1 diff)
• mgunit_build_userdocs.pro (modified) (1 diff)
• overview.txt (modified) (1 diff)
• RELEASE (modified) (1 diff)
• src/mgunit.pro (modified) (2 diffs)
• src/mgunit_version.pro (added)

trunk/Makefile

@@ -1 @@
-VERSION=1.2dev
+VERSION=1.2alpha
 REVISION=r`svn info | sed -n 's/Revision: \(.*\)/\1/p'`
 RELEASE="$(VERSION)-$(REVISION)"
 IDL=idl
 
-.PHONY: all doc userdoc webdoc clean dist srcdist
+.PHONY: all doc userdoc webdoc clean dist srcdist version
  
 all:
@@ -23 +23 @@
         cd src; make clean
 
+version:
+        sed "s/version = '.*'/version = '$(VERSION)'/" < src/mgunit_version.pro | sed "s/revision = '.*'/revision = '$(REVISION)'/" > mgunit_version.pro
+        mv mgunit_version.pro src/
+
 # need to: blow away old dist, blow away api-docs, generate api-docs
 dist:
         rm -rf mgunit-$(RELEASE)
-        rm -rf api-docs/
+        rm -rf api-userdocs/
 
-        $(IDL) -e mgunit_build_docs
-        
+        make version
+
+        $(IDL) -e mgunit_build_userdocs
+
         $(IDL) -IDL_STARTUP "" mgunit_build
 
@@ -35 +41 @@
 
         mv mgunit.sav mgunit-$(RELEASE)/
+
+        cd docs; make
         svn export docs mgunit-$(RELEASE)/docs/
-        cp -r api-docs mgunit-$(RELEASE)/
+        cp docs/using-mgunit.pdf mgunit-$(RELEASE)/docs/
+        cp docs/using-mgunit.html mgunit-$(RELEASE)/docs/
+        rm mgunit-$(RELEASE)/docs/Makefile
+
+        cp -r api-userdocs mgunit-$(RELEASE)/
         cp src/error_is_fail.pro mgunit-$(RELEASE)/
         cp src/error_is_pass.pro mgunit-$(RELEASE)/
@@ -43 +55 @@
         cp COPYING mgunit-$(RELEASE)/
         cp RELEASE mgunit-$(RELEASE)/   
-        
+
         zip -r mgunit-$(RELEASE).zip mgunit-$(RELEASE)/*
         rm -rf mgunit-$(RELEASE)
@@ -68 +80 @@
         cp COPYING mgunit-src-$(RELEASE)/
         cp RELEASE mgunit-src-$(RELEASE)/       
-        
+
         zip -r mgunit-src-$(RELEASE).zip mgunit-src-$(RELEASE)/*
         rm -rf mgunit-src-$(RELEASE)
-        

trunk/mgunit_build_docs.pro

@@ -13 +13 @@
           overview='overview.txt', $
           /nosource, $
-          title='MGunit documentation', subtitle='Unit testing for IDL', $
+          title=string(mgunit_version(), format='(%"mgunit %s API documentation")'), $
+          subtitle='Unit testing framework for IDL', $
           /embed, format_style='rst', markup_style='rst'
 end

trunk/mgunit_build_userdocs.pro

@@ -13 +13 @@
           overview='overview.txt', $
           /nosource, $
-          title='MGunit documentation', subtitle='Unit testing for IDL', $
+          title=string(mgunit_version(), format='(%"mgunit %s API documentation")'), $
+          subtitle='Unit testing framework for IDL', $
           /embed, /user, format_style='rst', markup_style='rst'
 end

trunk/overview.txt

@@ -1 +1 @@
 `mgunit` is a unit testing framework modeled on other `xUnit testing frameworks <http://en.wikipedia.org/wiki/XUnit>`. The goal is to allow easy creation and reporting of results of tests, while still allowing for many different testing situations. Simple naming conventions replace formal creation of hierarchies and specification of tests. This allows test suites to be created with a minimum of code beyond the actual code of the tests themselves.
+
+The basic structure of `mgunit` is that tests are created by subclassing `MGutTestCase`, tests can be grouped together into suites for convenience by subclassing `MGutTestSuite`, and tests are run my calling `mgunit`. The `assert` routine is useful inside a test for making an assertion during the test. The `error_is_pass.pro` batch file is useful to include in a test when the test is supposed to crash. 
 
 See "Using mgunit" in the `docs` directory for more details about using `mgunit`.
 
-The basic structure of `mgunit` is that tests are created by subclassing `MGutTestCase`, tests can be grouped together into suites for convenience by subclassing `MGutTestSuite`, and tests are run my calling `mgunit`. The `assert` routine is useful inside a test for making an assertion during the test. The `error_is_pass.pro` batch file is useful to include in a test when the test is supposed to crash. 
 
 :Author:

trunk/RELEASE

@@ -7 +7 @@
 
 * Added FAILURES_ONLY keyword to display only failured tests.
+
+* Simplified and improved user-level API documentation.
+
+* Added `VERSION` keyword to report mgunit version.
 
 

trunk/src/mgunit.pro

@@ -32 +32 @@
 ;       IDL> mgunit, ['test1_ut', 'test2_ut']
 ;
-;    Or one could be run individually like::
+;    Or one test could be run individually like::
 ;
 ;       IDL> mgunit, 'test1_ut'
@@ -64 +64 @@
 ;    failures_only : in, optional, type=boolean
 ;       report only failed tests
+;    version : in, optional, type=boolean
+;       set to report version and exit
 ;-
 pro mgunit, tests, filename=filename, html=html, xml=xml, gui=gui, junit=junit, $
             color=color, $
             npass=npass, nfail=nfail, nskip=nskip, ntests=ntests, $
-            failures_only=failuresOnly
+            failures_only=failuresOnly, version=version
   compile_opt strictarr
+
+  if (keyword_set(version)) then begin
+    print, string(mgunit_version(/full), format='(%"mgunit %s")')
+    return
+  endif
 
   case 1 of