Changeset 25594 in osm for applications/editors/josm/plugins

Timestamp:

2011-03-14T11:13:50+01:00 (14 years ago)

Author:

bastik

Message:

make build file more readable

Location:

applications/editors/josm/plugins/namemanager

Files:

• build.xml (modified) (5 diffs, 1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/NameManagerMain.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/NameManagerPlugin.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/countryData/Country.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/countryData/CountryDataMemory.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/dialog/NameManagerDialog.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/listeners/NameManagerAction.java (modified) (1 prop)
• src/org/openstreetmap/josm/plugins/namemanager/utils/NameManagerUtils.java (modified) (1 prop)

applications/editors/josm/plugins/namemanager/build.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+** This is a template build file for a JOSM  plugin.
+**
+** Maintaining versions
+** ====================
+** see README.template
+**
+** Usage
+** =====
+** To build it run
+**
+**    > ant  dist
+**
+** To install the generated plugin locally (in you default plugin directory) run
+**
+**    > ant  install
+**
+** The generated plugin jar is not automatically available in JOSMs plugin configuration
+** dialog. You have to check it in first.
+**
+** Use the ant target 'publish' to check in the plugin and make it available to other
+** JOSM users:
+**    set the properties commit.message and plugin.main.version
+** and run
+**    > ant  publish
+**
+**
+-->
 <project name="namemanager" default="dist" basedir=".">
+
+        <!-- enter the SVN commit message -->
+        <property name="commit.message" value="..." />
+        <!-- enter the *lowest* JOSM version this plugin is currently compatible with -->
         <property name="plugin.main.version" value="3966" />
-        <property name="josm" location="../JOSM/dist/josm-custom.jar" />
-        <property name="plugin.dist.dir" value="../JOSM/dist" />
-        <property name="plugin.build.dir" value="build" />
-        <property name="plugin.jar" value="${plugin.dist.dir}/${ant.project.name}.jar" />
-        <property name="ant.build.javac.target" value="1.5" />
+
+
+        <!--
+      ************************************************
+      ** should not be necessary to change the following properties
+     -->
+        <property name="josm"                   location="../../core/dist/josm-custom.jar"/>
+        <property name="plugin.build.dir"       value="build"/>
+        <property name="plugin.src.dir"         value="src"/>
+        <!-- this is the directory where the plugin jar is copied to -->
+        <property name="plugin.dist.dir"        value="../../dist"/>
+        <property name="ant.build.javac.target" value="1.5"/>
+        <property name="plugin.dist.dir"        value="../../dist"/>
+        <property name="plugin.jar"             value="${plugin.dist.dir}/${ant.project.name}.jar"/>
+
+        <!--
+    **********************************************************
+    ** init - initializes the build
+    **********************************************************
+    -->
         <target name="init">
-                <mkdir dir="${plugin.build.dir}" />
-        </target>
+                <mkdir dir="${plugin.build.dir}"/>
+        </target>
+
+        <!--
+    **********************************************************
+    ** compile - complies the source tree
+    **********************************************************
+    -->
         <target name="compile" depends="init">
-                <echo message="compiling sources for  ${plugin.jar} ... " />
+                <echo message="compiling sources for  ${plugin.jar} ... "/>
                 <javac srcdir="src" classpath="${josm}" debug="true" destdir="${plugin.build.dir}">
-                        <compilerarg value="-Xlint:deprecation" />
-                        <compilerarg value="-Xlint:unchecked" />
+                        <compilerarg value="-Xlint:deprecation"/>
+                        <compilerarg value="-Xlint:unchecked"/>
                 </javac>
         </target>
+
+        <!--
+    **********************************************************
+    ** dist - creates the plugin jar
+    **********************************************************
+    -->
         <target name="dist" depends="compile,revision">
-                <echo message="creating ${plugin.jar.name} ... " />
+                <echo message="creating ${ant.project.name}.jar ... "/>
                 <copy todir="${plugin.build.dir}/resources">
                         <fileset dir="resources" />
                 </copy>
                 <copy todir="${plugin.build.dir}/images">
-                        <fileset dir="images" />
+                        <fileset dir="images"/>
                 </copy>
                 <copy todir="${plugin.build.dir}">
@@ -32 +91 @@
                 </copy>
                 <jar destfile="${plugin.jar}" basedir="${plugin.build.dir}">
+                        <!--
+        ************************************************
+        ** configure these properties. Most of them will be copied to the plugins
+        ** manifest file. Property values will also show up in the list available
+        ** plugins: http://josm.openstreetmap.de/wiki/Plugins.
+        **
+        ************************************************
+    -->
                         <manifest>
-                                <attribute name="Author" value="Rafal Jachowicz: rjachow@gmail.com" />
+                                <attribute name="Author" value="Rafal Jachowicz: rjachow@gmail.com"/>
                                 <attribute name="Main-Class" value="org.openstreetmap.josm.plugins.namemanager.NameManagerMain" />
                                 <attribute name="Plugin-Class" value="org.openstreetmap.josm.plugins.namemanager.NameManagerPlugin" />
-                                <attribute name="Plugin-Date" value="12-03-2011" />
+                                <attribute name="Plugin-Date" value="${version.entry.commit.date}"/>
                                 <attribute name="Plugin-Description" value="Allows to attribute tags to all objects in any selected area at once" />
                                 <attribute name="pl_Plugin-Description" value="Pozwala na dodawanie, edycję i usuwanie tagów znajdujących się we wskazanym obszarze na raz" />
-                                <attribute name="Plugin-Mainversion" value="3966" />
-                                <attribute name="Plugin-Version" value="1.1" />
+<!--                            <attribute name="Plugin-Icon" value="..."/>-->
+<!--                            <attribute name="Plugin-Link" value="..."/>-->
+                                <attribute name="Plugin-Mainversion" value="${plugin.main.version}"/>
+                                <attribute name="Plugin-Version" value="${version.entry.commit.revision}"/>
                         </manifest>
                 </jar>
         </target>
+
+        <!--
+    **********************************************************
+    ** revision - extracts the current revision number for the
+    **    file build.number and stores it in the XML property
+    **    version.*
+    **********************************************************
+    -->
         <target name="revision">
 
                 <exec append="false" output="REVISION" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="info" />
-                        <arg value="--xml" />
-                        <arg value="." />
-                </exec>
-                <xmlproperty file="REVISION" prefix="version" keepRoot="false" collapseAttributes="true" />
-                <delete file="REVISION" />
-        </target>
+                        <env key="LANG" value="C"/>
+                        <arg value="info"/>
+                        <arg value="--xml"/>
+                        <arg value="."/>
+                </exec>
+                <xmlproperty file="REVISION" prefix="version" keepRoot="false" collapseAttributes="true"/>
+                <delete file="REVISION"/>
+        </target>
+
+        <!--
+    **********************************************************
+    ** clean - clean up the build environment
+    **********************************************************
+    -->
         <target name="clean">
-                <delete dir="${plugin.build.dir}" />
-                <delete file="${plugin.jar}" />
-        </target>
+                <delete dir="${plugin.build.dir}"/>
+                <delete file="${plugin.jar}"/>
+        </target>
+
+        <!--
+    **********************************************************
+    ** install - install the plugin in your local JOSM installation
+    **********************************************************
+    -->
         <target name="install" depends="dist">
-                <property environment="env" />
+                <property environment="env"/>
                 <condition property="josm.plugins.dir" value="${env.APPDATA}/JOSM/plugins" else="${user.home}/.josm/plugins">
                         <and>
-                                <os family="windows" />
+                                <os family="windows"/>
                         </and>
                 </condition>
-                <copy file="${plugin.jar}" todir="${josm.plugins.dir}" />
-        </target>
+                <copy file="${plugin.jar}" todir="${josm.plugins.dir}"/>
+        </target>
+
+
+        <!--
+        ************************** Publishing the plugin *********************************** 
+        -->
+        <!--
+                ** extracts the JOSM release for the JOSM version in ../core and saves it in the 
+                ** property ${coreversion.info.entry.revision}
+                **
+                -->
         <target name="core-info">
                 <exec append="false" output="core.info.xml" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="info" />
-                        <arg value="--xml" />
-                        <arg value="../../core" />
-                </exec>
-                <xmlproperty file="core.info.xml" prefix="coreversion" keepRoot="true" collapseAttributes="true" />
+                        <env key="LANG" value="C"/>
+                        <arg value="info"/>
+                        <arg value="--xml"/>
+                        <arg value="../../core"/>
+                </exec>
+                <xmlproperty file="core.info.xml" prefix="coreversion" keepRoot="true" collapseAttributes="true"/>
                 <echo>Building against core revision ${coreversion.info.entry.revision}.</echo>
                 <echo>Plugin-Mainversion is set to ${plugin.main.version}.</echo>
                 <delete file="core.info.xml" />
         </target>
+
+        <!--
+                ** commits the source tree for this plugin
+                -->
         <target name="commit-current">
                 <echo>Commiting the plugin source with message '${commit.message}' ...</echo>
                 <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="commit" />
-                        <arg value="-m '${commit.message}'" />
-                        <arg value="." />
-                </exec>
-        </target>
+                        <env key="LANG" value="C"/>
+                        <arg value="commit"/>
+                        <arg value="-m '${commit.message}'"/>
+                        <arg value="."/>
+                </exec>
+        </target>
+
+        <!--
+                ** updates (svn up) the source tree for this plugin
+                -->
         <target name="update-current">
                 <echo>Updating plugin source ...</echo>
                 <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="up" />
-                        <arg value="." />
+                        <env key="LANG" value="C"/>
+                        <arg value="up"/>
+                        <arg value="."/>
                 </exec>
                 <echo>Updating ${plugin.jar} ...</echo>
                 <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="up" />
-                        <arg value="../dist/${plugin.jar}" />
-                </exec>
-        </target>
+                        <env key="LANG" value="C"/>
+                        <arg value="up"/>
+                        <arg value="../dist/${plugin.jar}"/>
+                </exec>
+        </target>
+
+        <!--
+                ** commits the plugin.jar 
+                -->
         <target name="commit-dist">
                 <echo>
@@ -115 +226 @@
         </echo>
                 <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false">
-                        <env key="LANG" value="C" />
-                        <arg value="-m '${commit.message}'" />
-                        <arg value="commit" />
-                        <arg value="${plugin.jar}" />
-                </exec>
-        </target>
+                        <env key="LANG" value="C"/>
+                        <arg value="-m '${commit.message}'"/>
+                        <arg value="commit"/>
+                        <arg value="${plugin.jar}"/>
+                </exec>
+        </target>
+
+        <!-- ** make sure svn is present as a command line tool ** -->
         <target name="ensure-svn-present">
                 <exec append="true" output="svn.log" executable="svn" failifexecutionfails="false" failonerror="false" resultproperty="svn.exit.code">
@@ -127 +240 @@
                 </exec>
                 <fail message="Fatal: command 'svn --version' failed. Please make sure svn is installed on your system.">
+                        <!-- return code not set at all? Most likely svn isn't installed -->
                         <condition>
                                 <not>
@@ -134 +248 @@
                 </fail>
                 <fail message="Fatal: command 'svn --version' failed. Please make sure a working copy of svn is installed on your system.">
+                        <!-- error code from SVN? Most likely svn is not what we are looking on this system -->
                         <condition>
                                 <isfailure code="${svn.exit.code}" />