Added reference-manual, release-notes, and release script.

ChangeLog

+--------------------------------------------------------
+Newest log first
+--------------------------------------------------------
+2011-05-06: (GH) Added reference-manual, release-notes, and release script.
+--------------------------------------------------------
 2011-04-25: (GH) Revised tests
 Added .info files for test documentation.
 RunTests now uses JastAdd2.jar instead of class files.

Makefile

@@ -28,18 +28,33 @@ jrag/AST/Jrag.jj : jrag/Jrag.jjt
 jar : all
 	jar -cmf manifest jastadd2.jar LICENSE ast/*.class ast/AST/*.class jastadd/*.class jrag/*.class jrag/AST/*.class org/aspectj/lang/*.class org/aspectj/runtime/*.class org/aspectj/runtime/internal/*.class org/aspectj/runtime/reflect/*.class
 
-source-jar: all
-	jar -cmf manifest jastadd2-src.jar LICENSE manifest ast/*.ast ast/*.jjt ast/*.jrag ast/*.java jrag/*.jrag jrag/*.java jrag/*.jjt jrag/AST/SimpleNode.java jastadd/*.java jastadd/*.jrag Makefile newrelease org/aspectj/lang/*.class org/aspectj/runtime/*.class org/aspectj/runtime/internal/*.class org/aspectj/runtime/reflect/*.class tools/*.jar jrag/AST/Token.java
+#source-jar: all
+#	jar -cmf manifest jastadd2-src.jar LICENSE manifest ast/*.ast ast/*.jjt ast/*.jrag ast/*.java jrag/*.jrag jrag/*.java jrag/*.jjt jrag/AST/SimpleNode.java jastadd/*.java jastadd/*.jrag Makefile newrelease org/aspectj/lang/*.class org/aspectj/runtime/*.class org/aspectj/runtime/internal/*.class org/aspectj/runtime/reflect/*.class tools/*.jar jrag/AST/Token.java doc/reference-manual.html doc/release-notes.html
+#	mkdir jastadd2-src
+#	cd jastadd2-src && jar -xf ../jastadd2-src.jar && cd ..
+#	jar -cmf manifest jastadd2-src.jar jastadd2-src
+#	rm -rf jastadd2-src
+
+source-zip: all
+	jar -cmf manifest jastadd2-src-temp.jar LICENSE manifest ast/*.ast ast/*.jjt ast/*.jrag ast/*.java jrag/*.jrag jrag/*.java jrag/*.jjt jrag/AST/SimpleNode.java jastadd/*.java jastadd/*.jrag Makefile newrelease org/aspectj/lang/*.class org/aspectj/runtime/*.class org/aspectj/runtime/internal/*.class org/aspectj/runtime/reflect/*.class tools/*.jar jrag/AST/Token.java doc/reference-manual.html doc/release-notes.html
 	mkdir jastadd2-src
-	cd jastadd2-src && jar -xf ../jastadd2-src.jar && cd ..
-	jar -cmf manifest jastadd2-src.jar jastadd2-src
+	cd jastadd2-src && jar -xf ../jastadd2-src-temp.jar && cd ..
+	rm jastadd2-src-temp.jar
+	zip -r jastadd2-src jastadd2-src
 	rm -rf jastadd2-src
 
+bin-zip: jar
+	mkdir jastadd2-bin
+	cp -p jastadd2.jar jastadd2-bin
+	cp -p doc/reference-manual.html doc/release-notes.html jastadd2-bin
+	zip -r jastadd2-bin jastadd2-bin
+	rm -rf jastadd2-bin
+
 bootstrap : jar
 	cp -f jastadd2.jar tools/
 
-release: jar source-jar
-	@echo "new release compiled into jastadd2.jar and jastadd2-src.jar"
+release: jar source-zip
+	@echo "new release compiled into jastadd2.jar and jastadd2-src.zip"
 
 clean :
 	/bin/rm -f jastadd/*.class ast/AST/* jrag/*.class jrag/AST/*.class jrag/AST/AST* jrag/AST/Jrag.jj jrag/AST/JragParser* jrag/AST/JJT* jrag/AST/Node.* jrag/AST/JavaCharStream* jrag/AST/ParseException*

README

@@ -19,10 +19,10 @@ Build is done by a makefile:
 - Create a new jar file (jastadd2.jar)
   > make jar
 
-- Create a new source jar file (jastadd2-src.jar)
-  > make source-jar
+- Create a new source zip file (jastadd2-src.zip)
+  > make source-zip
 
-- Make a new release (both a jar and a source jar file):
+- Make a new release (both a jar and a source zip file):
   > make release
 
 - Clean away generated files
@@ -72,7 +72,7 @@ TYPICAL BUGFIX PROCESS
   5. Run the regression test suite. An additional test now passes.
   6. Update the shouldpass file, to reflect what tests currently pass.
   7. Run the regression test suite. Exactly the tests in shouldpass should pass.
-  8. Update the ChangeLog file
+  8. Update the ChangeLog file, and the reference-manual if needed.
   9. > make clean
  10. Commit
 --------------------------------------------------------
@@ -86,18 +86,22 @@ ADD A TEST CASE
 Possibly, the test suites for JastAdd2 and JastAdd3 could be merged at some point. Niklas is looking into this.
 For the time being, we keep them as separate suites, but with the same numbers for the same tests.
 --------------------------------------------------------
-UPLOAD A NEW VERSION at JastAdd.org
-  1. Make sure the ChangeLog file contains appropriate content.
-  2. Create a new jar file (unless you are sure the jar file is up to date with the source):
+MAKE A NEW RELEASE at JastAdd.org
+  1. Make sure the ChangeLog, reference manual, and the release-notes.html contains appropriate content.
+  2. Create a new jar file:
       > make jar
-  3. Create a source jar file
-      > make source-jar
-  4. Login to the jastadd.org site
-     a. Update the Download page with the jar file(s), the ChangeLog, and with appropriate explanatory text.
-     b. Add a note on the home page under Latest news.
-     c. Test by downloading the jar files and do some exploratory testing.
-  5. Manually remove the jastadd2-src.jar file from the directory.
-  6. If needed: make clean and commit.
+  3. Run all test cases.
+  4. Make clean and commit.
+  5. Run the release script which will show you commands for doing the release.
+     > ./release
+     This will involve:
+     - Creating a new tagged version R20110506 (or other appropriate date)
+     - Creating a zip file jastadd2-src.zip for the source distribution
+     - Creating a zip file jastadd2-bin.zip for the binary distribution.
+     - Upload the zip files and appropriate documentation to jastadd.org
+     - Cleaning up
+  6. Browse to jastadd.org/releases/jastadd2/R20110506 and check the content.
+  7. Update the web pages to reflect the new release on the download and news pages. 
 --------------------------------------------------------
 DIRECTORIES, FILES, TOOLS
 --------
@@ -124,6 +128,11 @@ File types:
 --------  
 Directories and files:
   README      This file.
+  doc         Documentation html files.
+    reference-manual.html   The reference manual
+    release-notes.html      The release nodes
+    index.html              For download from the web
+    *.php                   Helper files for browsing uploaded files on the web
   ast         The AST structure and the specifications for .ast files.
     AST           Generated Java files (not present on checkout)
     Ast.ast       The abstract grammar for the AST

doc/index.html

+<h1>JastAdd2 Release R20110506
+</h1>
+
+<h2> Binary distribution </h2>
+<ul>
+  <li> The tool: <a href="jastadd2.jar">jastadd2.jar</a>
+  <br> Do "java -jar jastadd2.jar --help" for information on how to run the tool from the command line. </li>
+  <li> <a href="reference-manual.php">Reference manual</a> </li>
+  <li> <a href="release-notes.php">Release notes</a> <br></li><br>
+  <li> All three files zipped together: <a href="jastadd2-bin.zip">jastadd2-bin.zip</a> <br>
+  Unpack by the command "unzip jastadd2-bin.zip"</li>
+</ul>
+
+<h2> Source distribution </h2>
+<ul>
+  <li> The source: <a href="jastadd2-src.zip">jastadd2-src.zip</a>
+  <br> Unpack by the command "unzip jastadd2-src.zip" </li>
+</ul>

doc/index.php

+<?php
+include("../../../web/include/functions.php");
+printHtmlContentFile("index.html");
+?>

doc/reference-manual.php

+<?php
+include("../../../web/include/functions.php");
+printHtmlContentFile("reference-manual.html");
+?>

doc/release-notes.html

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>JastAdd2 Release Notes</title>
+</head>
+
+<body>
+<h1>JastAdd2 Release Notes
+</h1>
+<h2>
+R20110506
+</h2>
+</body>
+</html>

doc/release-notes.php

+<?php
+include("../../../web/include/functions.php");
+printHtmlContentFile("release-notes.html");
+?>

jastadd/JastAdd.java

@@ -12,7 +12,7 @@ import jrag.*;
 
 public class JastAdd {
   
-    public static final String VERSION = "JastAdd II (http://jastadd.org) version R20110419";
+    public static final String VERSION = "JastAdd II (http://jastadd.org) version R20110506";
     public static final String VERSIONINFO = "\n// Generated with " + VERSION + "\n\n";
 
     protected java.util.List files;

manifest

 Main-Class: jastadd.JastAdd
 Implementation-Title: JastAdd II
-Implementation-Version: R20110419
+Implementation-Version: R20110506
 Implementation-Vendor: The JastAdd Team
 Implementation-URL: http://jastadd.org
 

release.sh

+#!/bin/sh
+VERSION=R`date +%Y%m%d`
+echo Do the following commands to create and upload jastadd2 version ${VERSION}
+
+# Create a zip file jastadd2-src.zip for the source distribution
+echo make source-zip
+#make source-zip
+
+# Create a zip file jastadd2-bin.zip for the binary distribution.
+echo make bin-zip
+#make bin-zip
+
+# Create a new dir at jastadd.org
+echo ssh login.cs.lth.se \"cd /cs/jastadd/releases/jastadd2 \&\& mkdir ${VERSION}\"
+#ssh login.cs.lth.se "cd /cs/jastadd/releases/jastadd2 && mkdir ${VERSION}"
+
+# Upload the zip files and appropriate documentation to jastadd.org
+echo scp jastadd2-src.jar jastadd2-bin.zip doc/*.html doc/*.php login.cs.lth.se:/cs/jastadd/releases/jastadd2/${VERSION}
+#scp jastadd2-src.jar jastadd2-bin.zip doc/*.html doc/*.php login.cs.lth.se:/cs/jastadd/releases/jastadd2/${VERSION}
+
+# Cleaning up
+echo rm -f jastadd2-bin.zip jastadd2-src.zip
+#rm -f jastadd2-bin.zip jastadd2-src.zip