You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@felix.apache.org by Derek Baum <de...@paremus.com> on 2009/07/14 10:03:36 UTC

Re: [jira] Commented: (FELIX-1357) Simplify sigil directory structure - get rid of redundant information from directory names

I like this nested grouping.

If you decide to keep the structure flat, it would still be useful to prefix
the directory names with ivy-, eclipse- to indicate where they belong.

Derek

2009/7/14 David Savage (JIRA) <ji...@apache.org>

>
>    [
> https://issues.apache.org/jira/browse/FELIX-1357?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12730726#action_12730726]
>
> David Savage commented on FELIX-1357:
> -------------------------------------
>
> Suggestion to move to a nested directory structure that looks like:
>
> $felix-svn/sigil/build.xml
> $felix-svn/sigil/common/core/... (was
> $felix-svn/sigil/org.cauldron.bld.core)
> $felix-svn/sigil/ivy/plugin/... (was $felix/sigil/bld-ivy)
> $felix-svn/sigil/eclipse/core (was $felix-svn/sigil/org.cauldron.sigil.core
> $felix-svn/sigil/eclipse/ui (was $felix-svn/sigil/org.cauldron.sigil.ui
> ...
>
> This way if/when we bring in support for other tools such as netbeans,
> maven we can put the src under appropriate sub dirs? Of course could also
> apply the YAGNI principle and keep a flat top level directory structure?
>
>
> > Simplify sigil directory structure - get rid of redundant information
> from directory names
> >
> ------------------------------------------------------------------------------------------
> >
> >                 Key: FELIX-1357
> >                 URL: https://issues.apache.org/jira/browse/FELIX-1357
> >             Project: Felix
> >          Issue Type: Improvement
> >          Components: Sigil
> >            Reporter: David Savage
> >            Priority: Minor
> >
>
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>

Re: [jira] Commented: (FELIX-1357) Simplify sigil directory structure - get rid of redundant information from directory names

Posted by David Savage <da...@paremus.com>.
Ok that's basically what I was planning I'll get started on this next.

Thx for feedback.

Regards,

Dave


On 14 Jul 2009, at 14:12, "Richard S. Hall" <he...@ungoverned.org>  
wrote:

> On 7/14/09 4:03 AM, Derek Baum wrote:
>> I like this nested grouping.
>>
>> If you decide to keep the structure flat, it would still be useful  
>> to prefix
>> the directory names with ivy-, eclipse- to indicate where they  
>> belong.
>>
>
> We have typically tried to follow the package naming structure in  
> our directory names, so for example:
>
>    felix/
>        ipojo/
>            arch/
>                src/
>            composite/
>                src/
>
> So, the org.apache.felix.ipojo.arch package subtree is under the  
> arch module, while the org.apache.felix.ipojo.composite subtree is  
> under the composite module. Of course, this doesn't always work out  
> exactly, like ipojo/core/ which actually contains the  
> org.apache.felix.ipojo package.
>
> At any rate, the main scheme was to try to follow the package root  
> of each subproject/module (e.g., http.jetty is in  
> org.apache.felix.http.jetty). Most of this was a result of our  
> effort to reduce redundancy because we originally had lots of long,  
> not very useful, redundant directory names.
>
> Of course, there is no hard and fast rule; for example, we name the  
> maven plugins differently to follow maven conventions. However,  
> consistency is nice when you can achieve it.
>
> -> richard
>
>
>
>> Derek
>>
>> 2009/7/14 David Savage (JIRA)<ji...@apache.org>
>>
>>
>>>    [
>>> https://issues.apache.org/jira/browse/FELIX-1357?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12730726#action_12730726]
>>>
>>> David Savage commented on FELIX-1357:
>>> -------------------------------------
>>>
>>> Suggestion to move to a nested directory structure that looks like:
>>>
>>> $felix-svn/sigil/build.xml
>>> $felix-svn/sigil/common/core/... (was
>>> $felix-svn/sigil/org.cauldron.bld.core)
>>> $felix-svn/sigil/ivy/plugin/... (was $felix/sigil/bld-ivy)
>>> $felix-svn/sigil/eclipse/core (was $felix-svn/sigil/ 
>>> org.cauldron.sigil.core
>>> $felix-svn/sigil/eclipse/ui (was $felix-svn/sigil/ 
>>> org.cauldron.sigil.ui
>>> ...
>>>
>>> This way if/when we bring in support for other tools such as  
>>> netbeans,
>>> maven we can put the src under appropriate sub dirs? Of course  
>>> could also
>>> apply the YAGNI principle and keep a flat top level directory  
>>> structure?
>>>
>>>
>>>
>>>> Simplify sigil directory structure - get rid of redundant  
>>>> information
>>>>
>>> from directory names
>>>      
>>> --- 
>>> --- 
>>> --- 
>>> --- 
>>> --- 
>>> --- 
>>> --- 
>>> --- 
>>> ------------------------------------------------------------------
>>>
>>>>                 Key: FELIX-1357
>>>>                 URL: https://issues.apache.org/jira/browse/FELIX-1357
>>>>             Project: Felix
>>>>          Issue Type: Improvement
>>>>          Components: Sigil
>>>>            Reporter: David Savage
>>>>            Priority: Minor
>>>>
>>>>
>>> --
>>> This message is automatically generated by JIRA.
>>> -
>>> You can reply to this email to add a comment to the issue online.
>>>
>>>
>>>
>>
>>

Re: [jira] Commented: (FELIX-1357) Simplify sigil directory structure - get rid of redundant information from directory names

Posted by "Richard S. Hall" <he...@ungoverned.org>.
On 7/14/09 4:03 AM, Derek Baum wrote:
> I like this nested grouping.
>
> If you decide to keep the structure flat, it would still be useful to prefix
> the directory names with ivy-, eclipse- to indicate where they belong.
>    

We have typically tried to follow the package naming structure in our 
directory names, so for example:

     felix/
         ipojo/
             arch/
                 src/
             composite/
                 src/

So, the org.apache.felix.ipojo.arch package subtree is under the arch 
module, while the org.apache.felix.ipojo.composite subtree is under the 
composite module. Of course, this doesn't always work out exactly, like 
ipojo/core/ which actually contains the org.apache.felix.ipojo package.

At any rate, the main scheme was to try to follow the package root of 
each subproject/module (e.g., http.jetty is in 
org.apache.felix.http.jetty). Most of this was a result of our effort to 
reduce redundancy because we originally had lots of long, not very 
useful, redundant directory names.

Of course, there is no hard and fast rule; for example, we name the 
maven plugins differently to follow maven conventions. However, 
consistency is nice when you can achieve it.

-> richard



> Derek
>
> 2009/7/14 David Savage (JIRA)<ji...@apache.org>
>
>    
>>     [
>> https://issues.apache.org/jira/browse/FELIX-1357?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12730726#action_12730726]
>>
>> David Savage commented on FELIX-1357:
>> -------------------------------------
>>
>> Suggestion to move to a nested directory structure that looks like:
>>
>> $felix-svn/sigil/build.xml
>> $felix-svn/sigil/common/core/... (was
>> $felix-svn/sigil/org.cauldron.bld.core)
>> $felix-svn/sigil/ivy/plugin/... (was $felix/sigil/bld-ivy)
>> $felix-svn/sigil/eclipse/core (was $felix-svn/sigil/org.cauldron.sigil.core
>> $felix-svn/sigil/eclipse/ui (was $felix-svn/sigil/org.cauldron.sigil.ui
>> ...
>>
>> This way if/when we bring in support for other tools such as netbeans,
>> maven we can put the src under appropriate sub dirs? Of course could also
>> apply the YAGNI principle and keep a flat top level directory structure?
>>
>>
>>      
>>> Simplify sigil directory structure - get rid of redundant information
>>>        
>> from directory names
>>      
>> ------------------------------------------------------------------------------------------
>>      
>>>                  Key: FELIX-1357
>>>                  URL: https://issues.apache.org/jira/browse/FELIX-1357
>>>              Project: Felix
>>>           Issue Type: Improvement
>>>           Components: Sigil
>>>             Reporter: David Savage
>>>             Priority: Minor
>>>
>>>        
>> --
>> This message is automatically generated by JIRA.
>> -
>> You can reply to this email to add a comment to the issue online.
>>
>>
>>      
>
>