From 15ebfccec93165bf030f46d16ed10ea2dcf51b33 Mon Sep 17 00:00:00 2001 From: Erik Hatcher Date: Tue, 4 Feb 2003 15:45:21 +0000 Subject: [PATCH] adding category to Perforce tasks git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@273975 13f79535-47bb-0310-9956-ffa450edef68 --- .../tools/ant/taskdefs/optional/perforce/P4Add.java | 8 +++++--- .../tools/ant/taskdefs/optional/perforce/P4Base.java | 6 +++--- .../tools/ant/taskdefs/optional/perforce/P4Change.java | 5 +++-- .../ant/taskdefs/optional/perforce/P4Counter.java | 6 ++++-- .../tools/ant/taskdefs/optional/perforce/P4Delete.java | 4 +++- .../tools/ant/taskdefs/optional/perforce/P4Edit.java | 10 ++++++---- .../tools/ant/taskdefs/optional/perforce/P4Have.java | 2 ++ .../tools/ant/taskdefs/optional/perforce/P4Label.java | 8 +++++--- .../tools/ant/taskdefs/optional/perforce/P4Reopen.java | 4 +++- .../tools/ant/taskdefs/optional/perforce/P4Revert.java | 2 ++ .../tools/ant/taskdefs/optional/perforce/P4Submit.java | 1 + .../tools/ant/taskdefs/optional/perforce/P4Sync.java | 2 ++ 12 files changed, 39 insertions(+), 19 deletions(-) diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.java index 77e1c8d0a..22d00d0dc 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.java @@ -51,7 +51,7 @@ * information on the Apache Software Foundation, please see * . */ -/* +/* * Portions of this software are based upon public domain software * originally written at the National Center for Supercomputing Applications, * University of Illinois, Urbana-Champaign. @@ -79,6 +79,8 @@ import org.apache.tools.ant.types.FileSet; * * @author Les Hughes * @author Anli Shundi + * + * @ant.task category="scm" */ public class P4Add extends P4Base { @@ -89,11 +91,11 @@ public class P4Add extends P4Base { /** * positive integer specifying the maximum length - * of the commandline when calling Perforce to add the files. + * of the commandline when calling Perforce to add the files. * Defaults to 450, higher values mean faster execution, * but also possible failures. */ - + public void setCommandlength(int len) throws BuildException { if (len <= 0) { throw new BuildException("P4Add: Commandlength should be a positive number"); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java index 30a51b841..8ee58fe1f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.java @@ -108,7 +108,7 @@ public abstract class P4Base extends org.apache.tools.ant.Task { protected String P4CmdOpts = ""; //Setters called by Ant - + /** * The p4d server and port to connect to; * optional, default "perforce:1666" @@ -152,13 +152,13 @@ public abstract class P4Base extends org.apache.tools.ant.Task { /** * Set extra command options; only used on some * of the Perforce tasks. - */ + */ public void setCmdopts(String P4CmdOpts) { this.P4CmdOpts = P4CmdOpts; } /** - * whether to stop the build (true, default) + * whether to stop the build (true, default) * or keep going if an error is returned from the p4 command */ public void setFailonerror(boolean fail) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java index 485223841..a77f17adc 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.java @@ -62,17 +62,18 @@ package org.apache.tools.ant.taskdefs.optional.perforce; import org.apache.tools.ant.BuildException; import org.apache.tools.ant.Project; -/** +/** * Requests a new changelist from the Perforce server. * P4Change creates a new changelist in perforce. P4Change sets the property * ${p4.change} with the new changelist number. This should then be passed into * p4edit and p4submit. - * + * * * @see P4Edit * @see P4Submit * @author Les Hughes * + * @ant.task category="scm" */ public class P4Change extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java index 5f21ddbd5..b320dd242 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.java @@ -62,7 +62,7 @@ package org.apache.tools.ant.taskdefs.optional.perforce; import org.apache.tools.ant.BuildException; import org.apache.tools.ant.Project; -/** +/** * Obtains or sets the value of a counter. * *

When used in its base form @@ -77,10 +77,12 @@ import org.apache.tools.ant.Project; * The user performing this task must have Perforce "review" permissions * as defined by Perforce protections in order for this task to succeed.

- + * Example Usage:
* <p4counter name="${p4.counter}" property=${p4.change}"/> * @author Kirk Wylie + * + * @ant.task category="scm" */ public class P4Counter extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java index 47366de0d..fea6d697f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.java @@ -66,6 +66,8 @@ import org.apache.tools.ant.BuildException; * (See also {@link P4Edit P4Edit})?
* * @author Mike Roberts, Les Hughes + * + * @ant.task category="scm" */ public class P4Delete extends P4Base { @@ -74,7 +76,7 @@ public class P4Delete extends P4Base { /** * An existing changelist number for the deletion; optional * but strongly recommended. - */ + */ public void setChange(String change) { this.change = change; } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java index d2434b56d..62e97dd0c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.java @@ -61,17 +61,19 @@ package org.apache.tools.ant.taskdefs.optional.perforce; import org.apache.tools.ant.BuildException; -/** - * Open file(s) for edit. +/** + * Open file(s) for edit. * P4Change should be used to obtain a new changelist for P4Edit as, - * although P4Edit can open files to the default change, + * although P4Edit can open files to the default change, * P4Submit cannot yet submit to it. * Example Usage:
* <p4edit change="${p4.change}" view="//depot/project/foo.txt" /> - * + * * @author Les Hughes * * @todo Should call reopen if file is already open in one of our changelists perhaps? + * + * @ant.task category="scm" */ public class P4Edit extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.java index 98b547819..252a446e5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.java @@ -67,6 +67,8 @@ import org.apache.tools.ant.BuildException; * P4Have simply dumps the current file version info into * the Ant log (or stdout). * @author Les Hughes + * + * @ant.task category="scm" */ public class P4Have extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java index 7c095b043..511287b35 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.java @@ -77,6 +77,8 @@ import org.apache.tools.ant.util.StringUtils; * * * @author Les Hughes + * + * @ant.task category="scm" */ public class P4Label extends P4Base { @@ -120,7 +122,7 @@ public class P4Label extends P4Base { } if (desc == null || desc.length() < 1) { - log("Label Description not set, assuming 'AntLabel'", + log("Label Description not set, assuming 'AntLabel'", Project.MSG_WARN); desc = "AntLabel"; } @@ -130,7 +132,7 @@ public class P4Label extends P4Base { } if (name == null || name.length() < 1) { - SimpleDateFormat formatter + SimpleDateFormat formatter = new SimpleDateFormat("yyyy.MM.dd-hh:mm"); Date now = new Date(); name = "AntLabel-" + formatter.format(now); @@ -162,7 +164,7 @@ public class P4Label extends P4Base { }); - log("Created Label " + name + " (" + desc + ") with view:\n" + P4View, + log("Created Label " + name + " (" + desc + ") with view:\n" + P4View, Project.MSG_INFO); //Now lock if required diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.java index c3b8b811b..0f948c618 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.java @@ -61,10 +61,12 @@ package org.apache.tools.ant.taskdefs.optional.perforce; import org.apache.tools.ant.BuildException; -/* +/** * Reopen Perforce checkout files between changelists. * * @author Les Hughes + * + * @ant.task category="scm" */ public class P4Reopen extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.java index 1d6c8eb3a..37f597a2e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.java @@ -65,6 +65,8 @@ import org.apache.tools.ant.BuildException; * Revert Perforce open files or files in a changelist * * @author Les Hughes + * + * @ant.task category="scm" */ public class P4Revert extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java index e18938817..495eb1bd0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.java @@ -74,6 +74,7 @@ import java.util.Vector; * * @author Les Hughes * + * @ant.task category="scm" */ public class P4Submit extends P4Base { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java index daf99b5b1..72b8aaddf 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.java @@ -79,6 +79,8 @@ import org.apache.tools.ant.Project; * @todo Add decent label error handling for non-exsitant labels * * @author Les Hughes + * + * @ant.task category="scm" */ public class P4Sync extends P4Base {