[jira] Created: (FOR-823) forrest.build.xml uses "init" target which causes errors when using it from an ANT build

["Ben Litchfield (JIRA)" <ji...@apache.org>]

forrest.build.xml uses "init" target which causes errors when using it from an ANT build
----------------------------------------------------------------------------------------

         Key: FOR-823
         URL: http://issues.apache.org/jira/browse/FOR-823
     Project: Forrest
        Type: Bug
  Components: Compile  
    Versions: 0.8-dev    
    Reporter: Ben Litchfield


I recently upgraded from 0.6 to 0.8-dev, I build my site using ANT as described here http://forrest.apache.org/docs_0_80/your-project.html#invoking_from_ant

Running 'forrest site' worked correctly, but my ANT integration failed.

I determined the cause to be that in my project's build.xml I had defined an "init" target to initialize properties, so when I imported the forrest.build.xml, my init took precedence and the forrest version did not get called, so many required forrest properties did not get initialized, which led to all sorts of weird and misleading errors.

My workaround was to change the name of the target in my build.xml from init to pdfbox.init, and it works now, but this took me a while to figure out.  I did a quick look at other build.xml's from various Java projects I have locally and many have a init target already defined, which means that if they were to import the forrest.build.xml it would not work for them either and it would not be obvious why.

As it is a documented feature for the forrest.build.xml to be imported it would be nice if we could rename forrest's init to forrest.init or something similar so it works the first time in more cases.

Hmmm, what about other forrest targets, should we change those?  I propose that because init is such a common target among build files we change forrest's init to forrest.init, and leave the others alone for now.  I also propose that we add a quick statement in the invoking_from_ant section that warns about the possibility for collision.



-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira

[jira] Commented: (FOR-823) forrest.build.xml uses "init" target which causes errors when using it from an ANT build

["Ross Gardler (JIRA)" <ji...@apache.org>]

    [ http://issues.apache.org/jira/browse/FOR-823?page=comments#action_12369269 ] 

Ross Gardler commented on FOR-823:
----------------------------------

I think we have an issue already for adding a prefix to Forrest targets. That is all targets would have something like a "for-" prefix. So the init target would become "for-init". I can't find the issue right now (if it exists, it may be in my head).

The only ones that shouldn't really change are the ones intended to be called from the command line.

We'd welcome a patch for this.

> forrest.build.xml uses "init" target which causes errors when using it from an ANT build
> ----------------------------------------------------------------------------------------
>
>          Key: FOR-823
>          URL: http://issues.apache.org/jira/browse/FOR-823
>      Project: Forrest
>         Type: Bug
>   Components: Compile
>     Versions: 0.8-dev
>     Reporter: Ben Litchfield

>
> I recently upgraded from 0.6 to 0.8-dev, I build my site using ANT as described here http://forrest.apache.org/docs_0_80/your-project.html#invoking_from_ant
> Running 'forrest site' worked correctly, but my ANT integration failed.
> I determined the cause to be that in my project's build.xml I had defined an "init" target to initialize properties, so when I imported the forrest.build.xml, my init took precedence and the forrest version did not get called, so many required forrest properties did not get initialized, which led to all sorts of weird and misleading errors.
> My workaround was to change the name of the target in my build.xml from init to pdfbox.init, and it works now, but this took me a while to figure out.  I did a quick look at other build.xml's from various Java projects I have locally and many have a init target already defined, which means that if they were to import the forrest.build.xml it would not work for them either and it would not be obvious why.
> As it is a documented feature for the forrest.build.xml to be imported it would be nice if we could rename forrest's init to forrest.init or something similar so it works the first time in more cases.
> Hmmm, what about other forrest targets, should we change those?  I propose that because init is such a common target among build files we change forrest's init to forrest.init, and leave the others alone for now.  I also propose that we add a quick statement in the invoking_from_ant section that warns about the possibility for collision.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira