[FIXED JENKINS-17456] Add documentation for 'create build files' step.

jenkinsci · Apr 10, 2013 · 2035f3c · 2035f3c
1 parent 5441788
commit 2035f3c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/main/java/hudson/plugins/android_emulator/builder/UpdateProjectBuilder.java b/src/main/java/hudson/plugins/android_emulator/builder/UpdateProjectBuilder.java
@@ -270,7 +270,7 @@ public DescriptorImpl() {
 
         @Override
         public String getHelpFile() {
-            return Functions.getResourcePath() + "/plugin/android-emulator/help-installPrerequisites.html";
+            return Functions.getResourcePath() + "/plugin/android-emulator/help-createBuildFiles.html";
         }
 
         @Override

diff --git a/src/main/webapp/help-createBuildFiles.html b/src/main/webapp/help-createBuildFiles.html
@@ -0,0 +1,11 @@
+Creates or updates build files for the Android apps, libraries and test projects in this job's workspace.
+<p>
+This build step will search for Android projects in your workspace, ensure that the required
+platform(s) are installed, and then ensures that build files are in place by using the appropriate
+<code>android update project</code> command.
+</p>
+<p>
+Creating the build files for a test projects requires that the relative path to the respective app
+project is specified. This build step tries to do the right thing by selecting the app project which
+is nearest to the test project in the directory hierarchy.
+</p>