From 46777e5300f162b7612a2f224f8daf7af3e2904c Mon Sep 17 00:00:00 2001 From: aheritier Date: Sat, 26 Feb 2005 23:00:28 +0000 Subject: [PATCH] Ant user can set proxy settings. New property maven.ant.compatibility if you want a script compatible with ant 1.5 (actually for proxy settings). Update copyrights Update documentations git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@155597 13f79535-47bb-0310-9956-ffa450edef68 --- ant/maven.xml | 23 ++++ ant/plugin.jelly | 7 +- ant/plugin.properties | 5 +- ant/project.properties | 7 +- ant/project.xml | 2 +- .../plugin-resources/templates/build.jelly | 70 ++++++++-- ant/src/plugin-test/maven.xml | 4 +- ant/src/plugin-test/project.xml | 2 +- ant/src/plugin-test/src/main/AClass.java | 4 +- ant/src/plugin-test/src/test/AClassTest.java | 2 +- ant/xdocs/ant-settings.xml | 128 ++++++++++++++++++ ant/xdocs/changes.xml | 8 +- ant/xdocs/goals.xml | 63 +++++---- ant/xdocs/images/asf_logo_wide_clear.gif | Bin 0 -> 6614 bytes ant/xdocs/images/maven.gif | Bin 0 -> 2578 bytes ant/xdocs/index.xml | 58 +------- ant/xdocs/navigation.xml | 17 +-- ant/xdocs/properties.xml | 47 +++---- 18 files changed, 301 insertions(+), 146 deletions(-) create mode 100644 ant/maven.xml create mode 100644 ant/xdocs/ant-settings.xml create mode 100644 ant/xdocs/images/asf_logo_wide_clear.gif create mode 100644 ant/xdocs/images/maven.gif diff --git a/ant/maven.xml b/ant/maven.xml new file mode 100644 index 00000000..aff34951 --- /dev/null +++ b/ant/maven.xml @@ -0,0 +1,23 @@ + + + + + + + \ No newline at end of file diff --git a/ant/plugin.jelly b/ant/plugin.jelly index 0444f6fe..a1956cd7 100644 --- a/ant/plugin.jelly +++ b/ant/plugin.jelly @@ -1,7 +1,7 @@ diff --git a/ant/src/plugin-test/maven.xml b/ant/src/plugin-test/maven.xml index 90cede90..0d045905 100644 --- a/ant/src/plugin-test/maven.xml +++ b/ant/src/plugin-test/maven.xml @@ -1,6 +1,6 @@ - diff --git a/ant/src/plugin-test/project.xml b/ant/src/plugin-test/project.xml index 821a3d04..fa09f455 100644 --- a/ant/src/plugin-test/project.xml +++ b/ant/src/plugin-test/project.xml @@ -1,7 +1,7 @@ + + + Ant Settings + Arnaud Heritier + + +
+ +

When you generate the build file with maven, if the property + "maven.ant.use.properties" + is setted to true (default behaviour), the build file will load successively the properties stored in files "build.properties" located in :

+
    +
  1. the project's root directory,
    2. +
  2. the user's home directory.
    3. +
+

If this property is setted to false the generated build file doesn't load this properties, so it will help you to avoid conflicts.

+

The following properties are defined in the build files and thus can be overridden in the files described previously :

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property nameDescriptionDefault value
defaulttargetdirThe directory where the generated files are stored${basedir}/target
libdirThe directory where are downloaded dependencies${basedir}/target/lib
classesdirThe directory where compiled classes are stored${basedir}/target/classes
testclassesdirThe directory where compiled classes for unit tests are stored (only if there are unit tests classes in your project)${basedir}/target/test-classes
testreportdirThe directory where tests reports are stored (only if there are unit tests classes in your project)${basedir}/target/test-reports
distdirThe directory where the distribution is created${basedir}/dist
javadocdirThe directory where is stored the javadoc${basedir}/dist/docs/api
final.nameThe name used for the generated jar${maven.final.name}
${dep.artifactId}.jarA property is created for each project's dependency (for example : activation.jar). This property can be used to override the default url used to download the dependency (for example : activation.jar=http://myhost/repository/sun/jars/activation-1.0.2.jar)
proxy.hostThe proxy host used to download dependencies.${maven.proxy.host}
proxy.portThe proxy port.${maven.proxy.port}
proxy.usernameThe username used to connect on proxy. (only if the ant file was generated with a 1.6 compatibility)${maven.proxy.username}
proxy.passwordThe password used to connect on proxy. (only if the ant file was generated with a 1.6 compatibility)${maven.proxy.password}
+ + +

The main targets defined in the generated ant's buildfile are :

+
    +
  • + clean : to delete generated directories (${defaulttargetdir} and ${distdir}).
    • +
  • + compile : to compile the code.
    • +
  • + test : to run the test cases.
    • +
  • + jar : to create the jar.
    • +
  • + javadoc : to generate the project's javadoc.
    • +
  • + dist : to create the distribution. It contains the jar, the javadoc, licenses(LICENCE.*) and readme (README.*).
    • +
+ +
+ + diff --git a/ant/xdocs/changes.xml b/ant/xdocs/changes.xml index b463c02f..c2bc3318 100644 --- a/ant/xdocs/changes.xml +++ b/ant/xdocs/changes.xml @@ -1,7 +1,7 @@ - - - Maven Ant Plug-in Goals + Goals dIon Gillard + Arnaud Heritier - - - - ant - - This is the default goal of the plugin and simply attains - the ant:generate-build goal. - - - - ant:generate-build - - Generates an ant - build.xml in the current directory which has targets to +
+ + + + + + + + + + + + + + + + +
GoalAvailableDescription
antsince 1.0This is the default goal of the plugin and simply attains the ant:generate-build goal. +
ant:generate-buildsince 1.0Generates an ant build file in the current directory which has targets to
    -
  • Compile the java source code
    • -
  • Create a jar from the compiled java code
    • -
  • Create a distribution
    • -
  • Run unit tests
    • -
  • Generate JavaDoc
    • -
  • Download all required jar files
    • -
  • Download and install Maven
    • -
- - - - +
  • Compile the java source code
    • +
  • Create a jar from the compiled java code
    • +
  • Create a distribution
    • +
  • Run unit tests
    • +
  • Generate JavaDoc
    • +
  • Download all required jar files
    • +
  • Download and install Maven
    • + +
    +
    +     diff --git a/ant/xdocs/images/asf_logo_wide_clear.gif b/ant/xdocs/images/asf_logo_wide_clear.gif new file mode 100644 index 0000000000000000000000000000000000000000..aab499c7440371c53be0178556153b4e9a6bb206 GIT binary patch literal 6614 zcmeHK={M95-2HxMF?M6$8M{&TbrNR8nCyEfjD5`(A<>L=BwJ;t5JG6|vi-&yQ6VHt z5fzdsAuaRt{0qP0r(WFdl*sb>Ij9c6L5nvAYQJ2_8UHjf{+% z@0+-=#eZMEw9#pMH9Gn!BR+XHqLl zJUcNt8OIu2z~V-&PUz|BIhN6(P$)qbGMWe+RY_&CsxFF@lBJ|jTG!Mce`AA11Zw#} z5+k?5r7>#7P#RLow3N_XIg%lu9=JT#{NQOe>fB!)iI%GIJMwn*m&RMFCkj-=-H@EE zHP1_Qu52%ltNUfa0O_W#y&+ioJ;EIY*Jo{YuWk!pKQ82)t;pb$O{hXOgTV8L#G#v_ zW*w(Z8AYp3P(VdRIxe9N$u2{&0TM0+go=%k{*=Q=qPkkz7QdVuJ>QC0 zL<;C%m;2hTF#UpHPQ<6N@mn!&vh}H*d%w_XWqIvV^V64eX3X?^O(m&ZgUJR78 zL|+^AWV>TSHDpt)Qb}r+uE@bL+&W{8%hLT@_%55n`q_Qv6IB|S8MTpTR|`F#UT!aZ ziMGoDm}^7NdDZ7_a}=yCk;!a>JvaoDiU}6sC{}gJQ!^5|nB>2ofppPCE#sOPi>7>V z0O8XLmVc*YfmLqfBs4bp3#Qsd9m!YZ4KuD;f-C%Dq0(UDRf689IbhAhJaUoyhN9{S zwGnL=7}f)}a(ysDv&-Ll=sADzEB7U6t11;cU4pRo0a*AT3OOG7)u+?e17(>1$_KsJ8(dMCydX=$JZ$C1((?ot{lSFz@e z3=VzuhRxv9sY}kGiUvt*esueohgvc)z|cP9Q>}Kxe)yD`%y09f>u{OU71!rCSMPf!jD|qoUUeOhpTS!VK9bZ=-GAARR4o z5+SiZ5spWU4JWU znzn;Z2xK&IU2b zab>e&^GJIA9I7qim6N)Om=^f}(Kj*Y56xd}>d!L!h`wdZuQpe?qjJZ#`3vuZlUGft zCK=EzSNI(a=E0v+){^Ef+;6t0%iSCl9Ss{}#cxZt6rht3tZx|ZYMDEAxlukRm5 zNik3xf)u}YLR5~IZtx%kgvzDSees^db+gL zmT+=iN-;anbaI!w%w?HTd;dRvE^W@S#|(Tgal;x37`2gteuq&~V-(v0S$`XRO^2wE z5vAg(^;ib-ItK#3N{0JmpxX02=NtJ}2zrk!*AHq+YF*8v+lj2o?Nw?0uE7`N zmUlxaEJmnA9v!m;^_+K1i@u~|H>Z9F2238<^I3^w-UW=z%=*SCEX8TbAQdyv^3xw} zfjNY;Sg*1H_F<;J3yesFF;L_w4>uSX|B z`JI%Dmm$EP6WUX#!50uIsuo`PJ~uGwCR6#@sKNat;%vcDrKzL3NIxSda;hL1&FP+meD@uE?R!w+|IYX2|VTC&}*(|kyw4V>SS3<-1 z9Qy28up1IBd=?cyGc@bYk8E#E2lDHK4S|FSAzmKDI)jxI#t( z!jA=y4S6A)Wp}yCppH%?e;>MryEqNkb{L*gK-#5%@OpRObj7SeQuZfps7r96Bs6%| zeKw$gJ&&TY2a)io5Gt-R?XKbq2OV&r`f7!NHDvT^$vH{sMjKES3GJxK+IEWh@uX7Z zAiU4nJ#HxI=lAsmF zsmi7G(^9xtX2g~oa^##r9Jv#?31lf<8=aZ@8v-W5hw5n$!OBNtx3~< zHE12on)5)Ht7`5Ez=8zL)p8ycH!gNJvPRVr&*@FrXGM!?NV@jf2$|m?K z5Mcmg5GX{&ij&*ea9x&#cf~902)t2k@OA--_TEYx?|pCWoc7|^fP6U`ruB#+r9`(y zTmM@FWF!mX(4bJ<5y;}c&)b0F2ee(BU^-wplW-!1!gc&O>IuL%)p>oQhtmZ}oZw9D zK@J5;QhFX{UPR)zx&*-|p)I{$9?ja((1{N6$RTOyV*|aq&u<$zxsta*U$DA+#@!?E ze%(?f%d>9cc)r267z_lfmWGxhg4m@VTu)E@Qm4=qXTVx~eyb}?LNq8>pvwo7-rNNv zYQC~DWtx7-ywA<-p{mDic8Ak!3*z-3RK~(f14h&5*)bF5mggGKh26eOS^LlDSY_$J z(}6{>}TmLCLLV-(2uHOPy4B%;?f`tUEEjHh^ z6;CP5Pm>uz{CINHv#C06WZS7_<6{5EM;(uP3{=7lAl0qOP>9)1=kcS__zVDflS&I} zBIhi+taQ z(tkVTv0h4BMjmJhR6}n?{uT*P9lrlcql_nry!rIM zI7LAql1S1sx-E)X!XR|UQz;B8Lj~R~0`UjUo_L+$*z$;<+APQJl)Q$JYk8pu9SNKG z!>I04EOqFN{?r%~|KF_vlRa?ai=RuKh|l1!xVH8fhoVUx+mtSSYuwF^@eJXpj$5h) z*OBN3JIq=Az(PLUzTf2m4CDUGe5ur@6Ud5#XCmdvdf?dq^e+O~rBOaA@aa0hvI;J^NCX+vG`bu|{}tEd z8TMRf>YZMxY5^o#^sIgRZiLMYPQuSSCwN7&k&9Q6Rio{$tgl`#PdqXgjp7}(d$p-< z&BYu0Ua;XqZ$H1`KC9gMqCq*fkU&?#$3>Fogy-~sL10=CRW=A&oqUIY&AUK>y2PgO zmiuh=U3(xud2-)m#R~SL`lz*h<`}u+i9O(D6$L5YPmQ6X^WiXK}r|2c;=Ns(?!{0FHN(ep0+~{+>c^QdxMycB_ zti77LZ4nr2Yxu1ZqvbQ7^(TF*%)WB+R9u9W5YVPf71u*9b0N#1R5DXmE#`Ry2c@J* z6Ao0^mQJ-1~sPl-3o zeU8)&Tc~VL;NZqpN`~ z(WD7Efm06P@=`I!oNP#%65hfqaWgjCKCjdZ|2~6BOnbS0$TEMsZ}Bd<^d($EKyO_M z{=km5xuCh4K=7Wgcv0m!>!wSUX6yl`nIH};_Z&<={j@>9U!-sl)+#>d$18P1Mm~}C z6+Pymn)UhVV+J={fP|8{kjb8(X8++X{&x_!%***1u_nml8Ck&1gFo`T41&$6)4rLg zuB`d`hz|}QifnCos~@blHtnSyKGXD3&!Jg! z$hT@gU9%64_FinR*kwmviHIFBz28@MjdJGp=2!NwxTQ_o=be1SYe!1!Y^4bUCSrjL zw_q)=1z*}xPKieB2v*qauv8?AtV1!OM^aI5PT$B3oL^-+>g)I<7hm$Wt8vA z2)Bd=ug8e}SH!(QoWq+dJ=-m8#`Ib(J^7v^b5p=SUk|(er^*{g%BP zFm?Rrtrzcjg{FxS^ismYea^d=?T}x8-oG*22|CLV{|!En{X_7t3W!tLDr_E_H4?0r z`9+ikT44L?V0!qDPBu`HID{4Cy`~~S!!l49*nAEIkkima2p_vhZOlF?1umpPB>^Cf zfV~&rgf#U*FDl66blg-wthPq zV83l&uZxyvD{=@T020whXn@8>JoUPX^SX(=O(l(y0=>4Gms9vz?nRS%u|5g(wZktL4Uc!+^yk=qe0ulv@$JFCf4alJvZGcNH-gCTZwFU&>d$jblhQ7tdQD%M#x*Uav5`)u!@vRCk}75TtbQ|F_$6? zL$SF;j`LEp=9W!N(&cnnggQ7HZQkH_oi=n#v=a=CnVcJ|AcFMt2jKLYT>K#ILK;R3Du^B2lM-J@W(eb69LO@-3HJt);h@w#@Z$@(0f031 z-xb3YYRu6NFL4vz*2n6Vd=3+k6vNc1R0rFtqd*({>owHJiM!LtSR-m?cxT_7u(|xc z!wl)CX+T$*8^~tHovKs4@=A#s`sS2mVAS-8AKmSvP>o>fm`8M5`{3KV*>bj3&ZfMA z>5@QA_Qj|ruW40heS2fUP#WillCUGlu~U zQ?f)DI`atqy({HqEJ9FH0%01~Le5o~P>!;+P1eI9jC5x-Oxvb5It_3ky$eS~H5A5- zlEEp4dSGx+lz!P~0z^A-q8M&wNH|81AX4xrR9xfhZu#1rc^2=zX~5-R`7CT9$AQ4e z0uJRXX%g&YjP#cg zEJqJe{g%uwxo_%xoE|U623I0I*v(9gM5!N8HO868W4hfeVf-7rcpdt8qNlI1T*|?; zGf>~c9khK+U%m|Du(RQ$o>;~W2MU3Y(@h18fZoB^Z*O!?<9}jg|Y$UW*;B zf0YwAx{IaJrs3^mgt8x%X|rAQlCH0~tWOT|>~u!jdzOD5+fwRZJhHoNh*R`?Vy_$# zrnCBKH~~dkBR`QVV#tW#li+45p(i(VA7Uy6EOdMIwK?x-#!XJ&{GJ!VGl0yWZflfq5jBOYQw`NS_pFz+y z#+A%0(qG3!2(+(2$l~1@IMwujZBX;QeI6`WkJ+t+O>J6@?@+}=r6RS$lvQZ`mv-4@ zC=Q`VEv>-H1hwo<0p!DAG=Qj3ieFOAw3vy41jban=5egXlyXn^xqQ3wBs0*%LNq}> zouyMq`z?paQ84py6z!kYP(j5L#>|ib+8Zd8_;B6ePn_mVb%I(Bgwzn_=xLclRxY4` z@05AgM%M^%+`g%x`iI!~$me~?TGy7Y5o!suG2%Urexgioovlc2!vl)O4hK{Smh3DB zqfm{p`D#__P8S|Kzg(!p-v)^;acwv5;$GOHTT;3XvLTgHkTgb){5pERtnIo+ujby4(z}Ow z@kg*G^-4~c_g~5xN{L*lB-QFYPOJvYo}9^nZQU?zb3AiHZ-C{qtb3?f>oon?Zi!y$ zTiW8&l?w~a=+Rrjk`Zne7x$4tPWK+`vU6mV7pq1l zURO!PO&X&8K+1vNEk)b&)|M+RZlcpPd_h^EMZ>>ESAhV!FuOYtSEs}CjV3(KW#6dv zZyUH5vHTp|ShHPZ-*SVF8l%L+KrPe|S(TR}IL6I7!wbREi;B<3dve2-=Z#@3ux zVZqH3Nr=Pdtq;Ay7;Pt8j<$4UhZ7F2z+Q2O5LE{h0b^N%o02#Kh{rpKUE1DKv9V&6~5W^y>r}t?hgjzeF?rSvc zgZqDbD%g{3{m6xsn`zN?OUi?btots%w8C9C*0b4LmwPo`tv~eH#zu!^5J`9J$-2Vp&`wBV$ literal 0 HcmV?d00001 diff --git a/ant/xdocs/index.xml b/ant/xdocs/index.xml index 01cb76b9..f0db8db7 100644 --- a/ant/xdocs/index.xml +++ b/ant/xdocs/index.xml @@ -1,7 +1,7 @@ - Maven Ant Plug-in + Home Jason van Zyl Arnaud Heritier @@ -38,56 +38,10 @@ by this plugin, please see the properties document.

    - -
    - -

    When you generate the build file with maven, if the property - "maven.ant.use.properties" - is setted to true (default behaviour), the build file will load successively the properties stored in files "build.properties" located in :

    -
      -
    1. the project's root directory,
      2. -
    2. the user's home directory.
      3. -
    -

    If this property is setted to false the generated build file doesn't load this properties, so it will help you to avoid conflicts.

    -

    The following properties are defined in the build files and thus can be overridden in the files described previously :

    -
      -
    • - defaulttargetdir : the directory where the generated files are stored (default = ${project.home}/target).
      • -
    • - libdir : the directory where are downloaded dependencies (default = ${project.home}/target/lib).
      • -
    • - classesdir : the directory where compiled classes are stored (default = ${project.home}/target/classes).
      • -
    • - testclassesdir (only if there are unit tests classes in your project) : the directory where compiled classes for unit tests are stored (default = ${project.home}/target/test-classes).
      • -
    • - testreportdir (only if there are unit tests classes in your project) : the directory where tests reports are stored (default = ${project.home}/target/test-reports).
      • -
    • - distdir : the directory where the distribution is created (default = ${project.home}/dist).
      • -
    • - javadocdir : the directory where is stored the javadoc (default = ${project.home}/dist/docs/api).
      • -
    • - final.name : the name used for the generated jar (default = ${maven.final.name}.
      • -
    • - ${dep.artifactId}.jar : a property is created for each project's dependency (for example : activation.jar). This property can be used to override the default url used to download the dependency (for example : activation.jar=http://myhost/repository/sun/jars/activation-1.0.2.jar).
      • -
    -     - -

    The main targets defined in the generated ant's buildfile are :

    -
      -
    • - clean : to delete generated directories (${defaulttargetdir} and ${distdir}).
      • -
    • - compile : to compile the code.
      • -
    • - test : to run the test cases.
      • -
    • - jar : to create the jar.
      • -
    • - javadoc : to generate the project's javadoc.
      • -
    • - dist : to create the distribution. It contains the jar, the javadoc, licenses(LICENCE.*) and readme (README.*).
      • -
    -     +

    + For more information on the ant script generated, please see + the ant script settings document. +

    diff --git a/ant/xdocs/navigation.xml b/ant/xdocs/navigation.xml index d9049748..084a3fb6 100644 --- a/ant/xdocs/navigation.xml +++ b/ant/xdocs/navigation.xml @@ -1,7 +1,7 @@ - - Maven Ant Plugin - - - + + + - - + + + + + diff --git a/ant/xdocs/properties.xml b/ant/xdocs/properties.xml index eef48dda..948ca4a9 100644 --- a/ant/xdocs/properties.xml +++ b/ant/xdocs/properties.xml @@ -1,7 +1,7 @@ - Maven Ant Plugin Properties + Properties dIon Gillard + Arnaud Heritier
    - + + + + + - + - + + - + - + + +
    Property nameOptional? DescriptionAvailableOptional?Default value
    maven.ant.excludeTestsHolds a comma separated list of source file patterns that will be excluded in the generated Ant build, e.g.since 1.2 Yes - Holds a comma separated list of source file patterns that - will be excluded in the generated Ant build, e.g. -
    - -maven.ant.excludeTests=**/*Test.java,**/*Suite.java - + + maven.ant.excludeTests=**/*Test.java,**/*Suite.java
    maven.ant.generatebuild.fileSets the name of the ant buildfile to create.since 1.0 Yes - Sets the name of the ant buildfile to create. - Defaults to "build.xml". This is used by the "ant:generate-build" - goal. - ${basedir}/build.xml
    maven.ant.use.propertiesYes - Starting with version 1.9 of the Maven ant plugin two lines are - added at the top of the generated buildfile: - 
    -  <property file="build.properties"/>
-  <property file="${user.home}/build.properties"/>
    - If you experience that your own properties are clashing with the - ones used in the generated buildfile you can set this property to - "false" to remove these 2 lines from the generated buildfile. - Valid values are "true" or "false". Defaults to "true". +

    The maven plugin for ant adds two lines at the top of the generated buildfile :

    + <property file="build.properties"/> +<property file="${user.home}/build.properties"/> +

    If you experience that your own properties are clashing with the ones used in the generated buildfile you can set this property to "false" to remove these 2 lines from the generated buildfile. Valid values are "true" or "false".

    		since 1.9Yestrue