Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 5108 invoked from network); 7 Jun 2006 11:24:14 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 7 Jun 2006 11:24:14 -0000 Received: (qmail 32065 invoked by uid 500); 7 Jun 2006 11:24:13 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 32022 invoked by uid 500); 7 Jun 2006 11:24:13 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Forrest Developers List" List-Id: Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 32006 invoked by uid 99); 7 Jun 2006 11:24:13 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jun 2006 04:24:13 -0700 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received-SPF: pass (asf.osuosl.org: local policy) Received: from [140.211.166.113] (HELO eris.apache.org) (140.211.166.113) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 07 Jun 2006 04:24:12 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 1152E1A983A; Wed, 7 Jun 2006 04:23:52 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r412368 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Date: Wed, 07 Jun 2006 11:23:51 -0000 To: svn@forrest.apache.org From: rgardler@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20060607112352.1152E1A983A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: rgardler Date: Wed Jun 7 04:23:51 2006 New Revision: 412368 URL: http://svn.apache.org/viewvc?rev=412368&view=rev Log: put back warning about the need to restart forrest or locally deploy edited plugins and encourage people to contribute back rather than fork our code. Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml?rev=412368&r1=412367&r2=412368&view=diff ============================================================================== --- forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml (original) +++ forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Wed Jun 7 04:23:51 2006 @@ -124,22 +124,29 @@
Editing plugins sources to enhance functionality -

If you need to enhance an existing plugin functionality, you should not edit a standard plugin sources.

-

First, copy the whole plugin directory either in a plugins directory in your project tree or, if the plugin is used by several projects, - in a different location outside any project directory.

-

Then declare the new location to make Forrest search in it. There is two cases :

-
    -
  • If your plugin is specific to a project, you should edit the corresponding forrest.properties to declare the new location in - the project.required.plugins.src property
    • -
  • If your plugin is shared with several project, you should edit your ${user.home}/forrest.properties
    • -
- The order of the directories list in the property is important, if you keep the plugin name, you should add the new location - at the beginning of the list to be sure Forrest will use your version and not the standard one. - We still need to describe the declaration of another remote site to store the specific plugins, with a new - plugins descriptor file... -

Finally, you can then edit your copy !

-

See Further reading for "How to build a Plugin".

-
+ + Until issue FOR-388 is fixed to + enable the use of plugins in-place, any change to sources requires you to either + restart forrest or to manually deploy the plugin locally with "ant local-deploy". + See Further reading for "How to build a Plugin". It is worth noting that if your + changes are to Java files you will always have to restart Forrest to ensure the + class loader loads your new classes. + +

If you need to add specific behaviour to an existing plugin, you should first consider + whether your changes will be of use to all users of the plugin or not. If they are of + general use then you can edit the plugin source files in their original location (i.e. + not in the build directory). Once you have completed your changes please + prepare a patch + and submit it for inclusion in code base.

+ +

If your changes are specific to your own use of the plugin you can create a local + copy of the plugin for this. However, we strongly advise against this + since you will need to manually update your plugin each time a new release of the original + is made. In the vast majority of cases local enhancements to a plugin wil be of use + to the wider communtiy. Please donate back to the project and help keep it vibrant and + useful.

+ +
Upgrading from a Version of Forrest Without Plugins

The plugin functionality was introduced in version 0.7 of Forrest.