Subclipse.unkrig.de: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
Line 13: Line 13:
= Task Descriptions =
= Task Descriptions =


== Task <de.unkrig.subclipse.svn> ==
== Task <span style="font-size:14pt"><code>'''<de.unkrig.subclipse.svn>'''</code></span> ==


Executes a series of SVN commands
Executes a series of SVN commands.


=== Attributes ===
=== Attributes ===
Line 23: Line 23:
=== Subelements ===
=== Subelements ===


==== <addDirectory> ====
The subelements of this task represent SVN subcommands which are executed sequentially:
(Not yet implemented.)


==== <addFile> ====
;<code><copy></code>
(Not yet implemented.)
:Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.copy.html svn copy] subcommand.


==== <addKeywords> ====
:;Attributes
(Not yet implemented.)


==== <annotate> ====
::;<code>url="''url''"</code> ''or'' <code>file="''path''"</code> ''or'' <code>dir="''path''"</code>
(Not yet implemented.)
:::File or directory to copy (resource collection subelements are an alternative to specify multiple source files; see below).


==== <checkout> ====
::;<code>toUrl="''url''"</code> ''or'' <code>toFile="''path''"</code> ''or'' <code>toDir="''path''"</code>
(Not yet implemented.)
:::Where to copy the file(s) (must be an existing directory iff multiple source files are specified).


==== <commit> ====
::;<code>message="''text''"</code>
(Not yet implemented.)
::;<code>revision="''rev''"</code>
::;<code>pegRevision="''rev''"</code>
::;<code>copyAsChild="''boolean''"</code>
::;<code>makeParents="''boolean''"</code>
:::See the SVN documentation of the [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.copy.html svn copy] subcommand.


==== <copy> ====
:;Subelements
Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.copy.html svn copy] subcommand.


===== Attributes =====
::;Resource collections (e.g. <code><fileset></code>, <code><dirset></code>, ...)
;srcUrl, srcPath:  File to copy (resource collection subelements are an alternative to specify multiple source files; see below)
:::An alternative to the <code>srcUrl="''url''"</code> and <code>srcPath="''path''"</code> attributes to specify ''multiple'' source files.
;destUrl, destPath: Where to copy the file(s) (must be an existing directory iff multiple source files are specified)
;message
;revision
;pegRevision
;copyAsChild
;makeParents


===== Subelements =====
;<code><export></code>
;Resource collection (<fileset>, <dirset>, ...): An alternative to the 'srcPath' and 'srcUrl' attributes to specify ''multiple'' source files.
:Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.export.html svn export] subcommand.


==== <createPatch> ====
:;Attributes
(Not yet implemented.)


==== <createRepository> ====
::;<code>url="''url''"</code> ''or'' <code>file="''path''"</code> ''or'' <code>dir="''path''"</code>
(Not yet implemented.)
:::File or directory to export.


==== <diff> ====
::;<code>toFile="''path''"</code> ''or'' <code>toDir="''path''"</code>
(Not yet implemented.)
:::Where to export the file or directory to.


==== <diffSummarize> ====
::;<code>revision="''rev''"</code>
(Not yet implemented.)
:::See the documentation of the [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.export.html svn export] subcommand.


==== <export> ====
::;<code>force="''boolean''"</code>
Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.export.html svn export] subcommand.
:::Whether to overwrite existing files.


===== Attributes =====
;<code><import></code>
;srcUrl, srcPath: File or directory to export
:Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.import.html svn import] subcommand.
;destPath:       Where to copy the file or directory
;revision
;force:           Whether to overwrite existing files


==== <import> ====
:;Attributes
Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.import.html svn import] subcommand.


===== Attributes =====
::;<code>file="''path''"</code> ''or'' <code>dir="''path''"</code>
;path:     File or directory to import
:::File or directory to import.
;url:      Destination repository location
;message
;recurse


==== <getProperties> ====
::;<code>url="''url''"</code>
(Not yet implemented.)
:::Destination repository location.


==== <getRevProperties> ====
::;<code>message="''text''"</code>
(Not yet implemented.)
::;<code>recurse="''boolean''"</code>
:::See the documentation of the [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.import.html svn import] subcommand.


==== <lock> ====
;<code><mkdir></code>
(Not yet implemented.)
:Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.mkdir.html svn mkdir] subcommand.


==== <merge> ====
:;Attributes
(Not yet implemented.)


==== <mkdir> ====
::;<code>url="''url''"</code>
Representation of an [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.mkdir.html svn mkdir] subcommand.
::;<code>message="''text''"</code>
===== Attributes =====
::;<code>makeParents="''boolean''"</code>
;url
:::See the documentation of the [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.mkdir.html svn mkdir] subcommand.
;message


==== <move> ====
;Other SVN subcommands
(Not yet implemented.)


==== <relocate> ====
<code>
(Not yet implemented.)
:;<addDirectory>
:;<addFile>
:;<addKeywords>
:;<annotate>
:;<checkout>
:;<commit>
:;<createPatch>
:;<createRepository>
:;<diff>
:;<diffSummarize>
:;<getProperties>
:;<getRevProperties>
:;<lock>
:;<merge>
:;<move>
:;<relocate>
:;<remove>
:;<revert>
:;<unlock>
:;<update>
</code>


==== <remove> ====
::These subelements exist, but merely issue an "Not yet implemented" error when executed.
(Not yet implemented.)
 
==== <revert> ====
(Not yet implemented.)
 
==== <unlock> ====
(Not yet implemented.)
 
==== <update> ====
(Not yet implemented.)


= Example =
= Example =

Revision as of 14:47, 18 February 2015

Introduction

This ECLIPSE plug-in adds an additional ANT task 'de.unkrig.subclipse.svn' which is available in ANT builds which have the option 'Run in the same JRE as the workspace' set.

The ANT task uses the SVN client that is provided by the SUBCLIPSE plug-in. Thus no configuration is required, because it is re-used from SUBCLIPSE.

Download and Installation

Within ECLIPSE, download and install the feature from the update site

http://subclipse.unkrig.de/update

Task Descriptions

Task <de.unkrig.subclipse.svn>

Executes a series of SVN commands.

Attributes

(None.)

Subelements

The subelements of this task represent SVN subcommands which are executed sequentially:

<copy>
Representation of an svn copy subcommand.
Attributes
url="url" or file="path" or dir="path"
File or directory to copy (resource collection subelements are an alternative to specify multiple source files; see below).
toUrl="url" or toFile="path" or toDir="path"
Where to copy the file(s) (must be an existing directory iff multiple source files are specified).
message="text"
revision="rev"
pegRevision="rev"
copyAsChild="boolean"
makeParents="boolean"
See the SVN documentation of the svn copy subcommand.
Subelements
Resource collections (e.g. <fileset>, <dirset>, ...)
An alternative to the srcUrl="url" and srcPath="path" attributes to specify multiple source files.
<export>
Representation of an svn export subcommand.
Attributes
url="url" or file="path" or dir="path"
File or directory to export.
toFile="path" or toDir="path"
Where to export the file or directory to.
revision="rev"
See the documentation of the svn export subcommand.
force="boolean"
Whether to overwrite existing files.
<import>
Representation of an svn import subcommand.
Attributes
file="path" or dir="path"
File or directory to import.
url="url"
Destination repository location.
message="text"
recurse="boolean"
See the documentation of the svn import subcommand.
<mkdir>
Representation of an svn mkdir subcommand.
Attributes
url="url"
message="text"
makeParents="boolean"
See the documentation of the svn mkdir subcommand.
Other SVN subcommands

<addDirectory>
<addFile>
<addKeywords>
<annotate>
<checkout>
<commit>
<createPatch>
<createRepository>
<diff>
<diffSummarize>
<getProperties>
<getRevProperties>
<lock>
<merge>
<move>
<relocate>
<remove>
<revert>
<unlock>
<update>

These subelements exist, but merely issue an "Not yet implemented" error when executed.

Example

Tagging projects in SVN:

<!-- Verify that ANT is running in the same JVM as ECLIPSE. -->
<fail
    unless="eclipse.running"
    message="Please activate the ECLIPSE external tool configuration option 'Run in the same JRE as the workspace' and re-run."
/>

<!-- Verify that the 'de.unkrig.subclipse' plugin is available. -->
<fail message="Please install the 'de.unkrig.subclipse' ECLIPSE feature and re-run.">
    <condition><not><typefound name="de.unkrig.subclipse.svn" /></not></condition>
</fail>

<property name="d" value="http://svn.acme.com/svn/MyRepo/tags/${tag}"/>
<de.unkrig.subclipse.svn>
    <mkdir                          url="${d}"/>
    <copy srcpath="."           desturl="${d}"/>
    <copy srcpath="../project2" desturl="${d}"/>
</de.unkrig.subclipse.svn>

If you like loading ANT tasks in separate XML namespaces, you can alternatively write:

<some-enclosing-tag-e-g-project-or-target xmlns:unkrig="antlib:de.unkrig.subclipse">
    ...
    <fail
        unless="eclipse.running"
        message="Please activate the ECLIPSE external tool configuration option 'Run in the same JRE as the workspace' and re-run."
    />

    <fail message="Please install the 'de.unkrig.subclipse' ECLIPSE feature and re-run.">
        <condition><not><typefound uri="antlib:de.unkrig.subclipse" name="svn" /></not></condition>
    </fail>

    <unkrig:svn>...

, where "unkrig" is the (arbitrary) XML namespace prefix.

License

SUBCLIPSE.UNKRIG.DE is published under the "New BSD License".

Source Code

Source code is available via SVN on

https://svn.code.sf.net/p/loggifier/code

. From that repository, check out the projects

  • de.unkrig.checkstyle-configuration
  • de.unkrig.commons.nullanalysis
  • de.unkrig.subclipse_dist
  • de.unkrig.subclipse.ant.tasks
  • de.unkrig.subclipse.branding
  • de.unkrig.subclipse.core
  • org.apache.ant-1.8.4

, or, if you are using ECLIPSE, just import https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.subclipse_dist/projectSet.psf.

Contact

For bugs, improvements, complaints, or any other kind of feedback, send email to arno@subclipse.unkrig.de.