You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by Ross Gardler <rg...@apache.org> on 2006/06/07 12:27:18 UTC

Re: svn commit: r412354 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml

cdupoirieux@apache.org wrote:
> Author: cdupoirieux
> Date: Wed Jun  7 03:13:27 2006
> New Revision: 412354
> 
> URL: http://svn.apache.org/viewvc?rev=412354&view=rev
> Log:
> Some documentation about the changes of the plugin management. Cf. FOR-343, FOR-388 and FOR-741.
> 
> 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=412354&r1=412353&r2=412354&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 03:13:27 2006
> @@ -124,13 +124,21 @@
>        </section>
>      <section id="local-deploy">
>        <title>Editing plugins sources to enhance functionality</title>
> -      <p>
> -        Until issue
> -        <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
> -        is fixed to enable the use of plugins in-place, any changes to
> -        sources need to be locally deployed.
> -        See <a href="#more">Further reading</a> for "How to build a Plugin".
> -      </p>

I am still not convinced that the above issue should be closed. The 
issue is about using pluins "in place", i.e in the src directory. 
Currently they are deployed from the source directory to the build 
directory. This means that if a plugin is edited we still need to 
locally deploy it, or restart Forrest.

Should we really be deleting the warning about this?

Should the issue really be closed? (see [1])

> +      <p>If you need to enhance an existing plugin functionality, you should not edit a standard plugin sources.</p>
> +      <p>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.</p>

I'm not sure we want to encourage users working in this way. We want 
them to enhance Forrest code and provide patches. This comment 
encourages them to fork the code doesn't it?

Ross

[1] http://marc.theaimsgroup.com/?l=forrest-dev&m=114736128231075&w=2

Re: svn commit: r412354 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml

Posted by Ross Gardler <rg...@apache.org>.
Cyriaque Dupoirieux wrote:
> le 07/06/2006 12:27 Ross Gardler a écrit :

>>> -        <a 
>>> href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>

...

>> Should we really be deleting the warning about this?
> 
> I think so, or at least we need to change it  may be something like :
> "Until issue <a 
> href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a> is fixed 
> to enable the use of plugins in-place, any change to sources needs to 
> restart forrest"

OK, I'm doing that now, with a minor modification of adding the 
local-deploy option.

>> Should the issue really be closed? (see [1])
>>
> No, we should reopen it. I didn't understand the "in place" ;-) . I 
> believed it was "instead of" the remote version...

That makes sense. I've reopened the issue but moved its fixed version to 
0.9. Your work on this is worthy of the 0.8 release. I've also clarified 
what is meant by "in place".

> 
>>> +      <p>If you need to enhance an existing plugin functionality, 
>>> you should not edit a standard plugin sources.</p>
>>> +      <p>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.</p>
>>
>>
>> I'm not sure we want to encourage users working in this way. We want 
>> them to enhance Forrest code and provide patches. This comment 
>> encourages them to fork the code doesn't it?
> 
> You are right, Maybe (please correct my bad english...) :

I'll make the edits you suggest with some minor mods (not for bad 
English though ;-)

Thanks,
Ross


Re: svn commit: r412354 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml

Posted by Cyriaque Dupoirieux <Cy...@pcotech.fr>.
le 07/06/2006 12:27 Ross Gardler a écrit :
> cdupoirieux@apache.org wrote:
>> Author: cdupoirieux
>> Date: Wed Jun  7 03:13:27 2006
>> New Revision: 412354
>>
>> URL: http://svn.apache.org/viewvc?rev=412354&view=rev
>> Log:
>> Some documentation about the changes of the plugin management. Cf. 
>> FOR-343, FOR-388 and FOR-741.
>>
>> 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=412354&r1=412353&r2=412354&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 03:13:27 2006
>> @@ -124,13 +124,21 @@
>>        </section>
>>      <section id="local-deploy">
>>        <title>Editing plugins sources to enhance functionality</title>
>> -      <p>
>> -        Until issue
>> -        <a 
>> href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
>> -        is fixed to enable the use of plugins in-place, any changes to
>> -        sources need to be locally deployed.
>> -        See <a href="#more">Further reading</a> for "How to build a 
>> Plugin".
>> -      </p>
>
> I am still not convinced that the above issue should be closed. The 
> issue is about using pluins "in place", i.e in the src directory. 
> Currently they are deployed from the source directory to the build 
> directory. This means that if a plugin is edited we still need to 
> locally deploy it, or restart Forrest.
Ok, that's fine,
>
> Should we really be deleting the warning about this?
I think so, or at least we need to change it  may be something like :
"Until issue <a 
href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a> is fixed 
to enable the use of plugins in-place, any change to sources needs to 
restart forrest"
>
> Should the issue really be closed? (see [1])
>
No, we should reopen it. I didn't understand the "in place" ;-) . I 
believed it was "instead of" the remote version...

>> +      <p>If you need to enhance an existing plugin functionality, 
>> you should not edit a standard plugin sources.</p>
>> +      <p>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.</p>
>
> I'm not sure we want to encourage users working in this way. We want 
> them to enhance Forrest code and provide patches. This comment 
> encourages them to fork the code doesn't it?
You are right, Maybe (please correct my bad english...) :

If you need to add specific behaviour to 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.

Of course, if you think this new feature is an enhancement of the 
standard which the community can benefit, you should create an issue in 
Jira and send us a patch that we will be pleased to integrate in the 
standard.

Salutations,
Cyriaque,
>
> Ross
>
> [1] http://marc.theaimsgroup.com/?l=forrest-dev&m=114736128231075&w=2
>
>