Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mylyn-docs-dev] naming convention on "core" bundles
Jeremie,

Your description below exactly captures what I had planned.  We can tackle the Java 9 constraint on "internal" package names as a separate effort.

I have some good news - I've figured out how to support Eclipse PDE with the core Java projects.  Running the maven build once from the command-line generates OSGi manifests in the location expected by PDE, at which point the corresponding projects are recognized as bundles by PDE.  This seems to work well for me - I get all of the awesome refactoring and debugging facilities that we've come to expect from Eclipse.

I've now merged much of this renaming, and the first of the Maven artifacts have been deployed to the snapshot site: https://repo.eclipse.org/content/repositories/mylyn-snapshots/org/eclipse/mylyn/docs/

I'm still working out a couple of quirks in the build - it seems that the review verification build occasionally fails, but succeeds again after wiping out the Hudson build job workspace.  I'm still investigating the cause.

David

On Tue, Jan 31, 2017 at 10:29 PM Jeremie Bresson <dev@xxxxxxxx> wrote:

Hi,

What is your idea? Let the "core" artifacts in a core folder but remove the suffix from there name?

\---wikitext
    |
    +---core
    |   +---org.eclipse.mylyn.wikitext.asciidoc
    |   +---org.eclipse.mylyn.wikitext.commonmark
    |   +---org.eclipse.mylyn.wikitext
    |   \---....
    |
    \---ui
        +---org.eclipse.mylyn.wikitext.asciidoc.ui
        +---org.eclipse.mylyn.wikitext.commonmark.ui
        \---....

Or have you an other proposition for "core" folder.

Have you checked if this idea works with the Java 9 constraint on package names?
Someday I guess that our bundles will become Java 9 modules. Each package name needs to be unique across the modules.


Le 01.02.2017 01:19, David Green a écrit :

All,

We currently have a naming convention with a "core" suffix on all bundles and Maven artifacts that are not UI contributions to Eclipse.  For example:
 
org.eclipse.mylyn.wikitext.core
org.eclipse.mylyn.wikitext.ui
org.eclipse.mylyn.wikitext.textile.core
org.eclipse.mylyn.wikitext.textile.ui
 
This sticks out as like a sore thumb when looking at dependencies and other artifacts in a regular Maven build.
 
With the recent build changes, we've changed the major version number of WikiText from 2.x to 3.x.  This gives us a rare opportunity to make other breaking changes, such as renaming bundles.
 
I'd like to propose a naming change where we drop the "core" suffix, for example:
 
org.eclipse.mylyn.wikitext
org.eclipse.mylyn.wikitext.ui
org.eclipse.mylyn.wikitext.textile
org.eclipse.mylyn.wikitext.textile.ui
 
As part of this bundle renaming, we should also consider renaming java packages in those core bundles to drop the "core" suffix as well.
 
While the ".core" suffix naming naming convention could be seen as a cosmetic change, and therefore with little benefit or reason to change, I see it as being a potential source of confusion for consumers.  From a consumer perspective, what does "core" mean anyways, unless you're familiar with the convention?
 
What do you think?  
 
David
--

blocked.gif

David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev


_______________________________________________
mylyn-docs-dev mailing list
mylyn-docs-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/mylyn-docs-dev
--


David Green | VP of Architecture | Tasktop

email: david.green@xxxxxxxxxxx

Back to the top