Documentation and build script improvements.

James Moger

2011-07-20 230632f582e7f1647cf15bc3ebd6148cb9af43c0

 build.xml

@@ -2,7 +2,8 @@
<project name="gitblit" default="compile" basedir=".">



   <!-- Google Code upload task -->

   <taskdef classname="net.bluecow.googlecode.ant.GoogleCodeUploadTask" classpath="${basedir}/tools/ant-googlecode-0.0.3.jar" name="gcupload"/>

   <taskdef classname="net.bluecow.googlecode.ant.GoogleCodeUploadTask" 
      classpath="${basedir}/tools/ant-googlecode-0.0.3.jar" name="gcupload"/>



   <!-- Project Properties -->

   <property name="project.jar" value="gitblit.jar" />

@@ -23,10 +24,6 @@
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   -->

   <target name="buildinfo">

      <!-- build date -->

      <tstamp>

         <format property="gb.buildDate" pattern="yyyy-MM-dd" />

      </tstamp>

   

      <!-- extract Gitblit version number from source code -->

      <loadfile property="gb.version" srcfile="${basedir}/src/com/gitblit/Constants.java">

@@ -42,7 +39,22 @@
            </tokenfilter>

         </filterchain>

      </loadfile>

	


      <!-- extract Gitblit version date from source code -->

      <loadfile property="gb.versionDate" srcfile="${basedir}/src/com/gitblit/Constants.java">

         <filterchain>

            <linecontains>

               <contains value="public static final String VERSION_DATE = " />

            </linecontains>

            <striplinebreaks />

            <tokenfilter>

               <replacestring from="public static final String VERSION_DATE = &quot;" to="" />

               <replacestring from="&quot;;" to="" />

               <trim />

            </tokenfilter>

         </filterchain>

      </loadfile>

					
      <!-- extract JGit version number from source code -->

      <loadfile property="jgit.version" srcfile="${basedir}/src/com/gitblit/Constants.java">

         <filterchain>

@@ -83,11 +95,11 @@
      <delete dir="${project.build.dir}" />

      <mkdir dir="${project.build.dir}" />

      <javac srcdir="${basedir}/src" destdir="${project.build.dir}">

         <include name="com/gitblit/Build.java" />			
         <include name="com/gitblit/build/Build.java" />			
         <include name="com/gitblit/Constants.java" />

         <include name="com/gitblit/utils/StringUtils.java" />         

      </javac>

      <java classpath="${project.build.dir}" classname="com.gitblit.Build" />

      <java classpath="${project.build.dir}" classname="com.gitblit.build.Build" />



      <!-- Compile Project -->

      <path id="master-classpath">

@@ -122,6 +134,10 @@
      <copy todir="${project.deploy.dir}">

         <fileset dir="${basedir}/distrib">

            <include name="**/*" />

         </fileset>

         <fileset dir="${basedir}">

            <include name="LICENSE" />

            <include name="NOTICE" />

         </fileset>

      </copy>



@@ -193,7 +209,7 @@
         </copy>



         <!-- Build deployment doc pages -->

         <java classpath="${project.build.dir}" classname="com.gitblit.BuildSite">

         <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildSite">

            <classpath refid="master-classpath" />

            <arg value="--sourceFolder" />

            <arg value="${basedir}/docs" />

@@ -229,14 +245,22 @@
            <arg value="%WAR%=${distribution.warfile}" />



            <arg value="--substitute" />

            <arg value="%BUILDDATE%=${gb.buildDate}" />

            <arg value="%BUILDDATE%=${gb.versionDate}" />



            <arg value="--substitute" />

            <arg value="%JGIT%=${jgit.version}" />



            <arg value="--load" />

            <arg value="--properties" />

            <arg value="%PROPERTIES%=${basedir}/distrib/gitblit.properties" />



            <arg value="--nomarkdown" />

            <arg value="%BEGINCODE%:%ENDCODE%" />



            <arg value="--substitute" />

            <arg value="&quot;%BEGINCODE%=&lt;pre class='prettyprint lang-java'&gt;&quot;" />



            <arg value="--substitute" />

            <arg value="%ENDCODE%=&lt;/pre&gt;" />

         </java>

   </target>

   

@@ -260,6 +284,10 @@
         <fileset dir="${basedir}/src/WEB-INF">

             <include name="web.xml" />

         </fileset>

         <fileset dir="${basedir}">

            <include name="LICENSE" />

            <include name="NOTICE" />

         </fileset>

      </copy>

      

      <!-- Build the docs for the WAR build -->

@@ -268,7 +296,7 @@
      </antcall>

      

      <!-- Build the WAR web.xml from the prototype web.xml and gitblit.properties --> 

      <java classpath="${project.build.dir}" classname="com.gitblit.BuildWebXml">

      <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildWebXml">

         <classpath refid="master-classpath" />

         

         <arg value="--sourceFile" />

@@ -307,7 +335,7 @@
         <fileset dir="${project.build.dir}">

            <exclude name="WEB-INF/web.xml" />

            <exclude name="com/gitblit/tests/" />

            <exclude name="com/gitblit/Build*.class" />

            <exclude name="com/gitblit/build/**" />

            <exclude name="com/gitblit/GitBlitServer*.class" />

            <exclude name="com/gitblit/Launcher*.class" />

            <exclude name="com/gitblit/MakeCertificate*.class" />            

@@ -372,7 +400,7 @@
      </copy>



      <!-- Generate thumbnails of screenshots -->

      <java classpath="${project.build.dir}" classname="com.gitblit.BuildThumbnails">

      <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildThumbnails">

         <classpath refid="master-classpath" />

            

         <arg value="--sourceFolder" />

@@ -394,7 +422,7 @@
      </copy>



      <!-- Build site pages -->

      <java classpath="${project.build.dir}" classname="com.gitblit.BuildSite">

      <java classpath="${project.build.dir}" classname="com.gitblit.build.BuildSite">

         <classpath refid="master-classpath" />

         <arg value="--sourceFolder" />

         <arg value="${basedir}/docs" />

@@ -404,9 +432,15 @@


         <arg value="--pageHeader" />

         <arg value="${basedir}/docs/site_header.html" />



			
         <arg value="--pageFooter" />

         <arg value="${basedir}/docs/site_footer.html" />



         <arg value="--analyticsSnippet" />

         <arg value="${basedir}/docs/site_analytics.html" />

				
         <arg value="--adSnippet" />

         <arg value="${basedir}/docs/site_ads.html" />



         <arg value="--alias" />

         <arg value="index=overview" />

@@ -424,15 +458,24 @@
         <arg value="%WAR%=${distribution.warfile}" />



         <arg value="--substitute" />

         <arg value="%BUILDDATE%=${gb.buildDate}" />

         <arg value="%BUILDDATE%=${gb.versionDate}" />



         <arg value="--substitute" />

         <arg value="%JGIT%=${jgit.version}" />



         <arg value="--load" />

         <arg value="--properties" />

         <arg value="%PROPERTIES%=${basedir}/distrib/gitblit.properties" />

			
         <arg value="--nomarkdown" />

         <arg value="%BEGINCODE%:%ENDCODE%" />



      </java>

         <arg value="--substitute" />

         <arg value="&quot;%BEGINCODE%=&lt;pre class='prettyprint lang-java'&gt;&quot;" />



         <arg value="--substitute" />

         <arg value="%ENDCODE%=&lt;/pre&gt;" />



      </java>	
   </target>

      



@@ -465,7 +508,7 @@
          projectname="gitblit" 

          filename="${distribution.zipfile}" 

          targetfilename="gitblit-${gb.version}.zip"

          summary="Standalone, integrated Gitblit server v${gb.version}"

          summary="Gitblit GO v${gb.version} (standalone, integrated Gitblit server)"

          labels="Featured, Type-Package, OpSys-All" />

         

      <!-- Upload WAR file -->

@@ -475,7 +518,7 @@
           projectname="gitblit" 

           filename="${distribution.warfile}" 

           targetfilename="gitblit-${gb.version}.war"

           summary="Gitblit WAR v${gb.version} for your servlet container"

           summary="Gitblit WAR v${gb.version} (standard WAR webapp for servlet containers)"

           labels="Featured, Type-Package, OpSys-All" />

   </target>