You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by "Vincent Siveton (JIRA)" <ji...@apache.org> on 2009/01/09 14:19:59 UTC

[jira] Created: (SHINDIG-828) Move all resources in a resources directory

Move all resources in a resources directory
-------------------------------------------

                 Key: SHINDIG-828
                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
             Project: Shindig
          Issue Type: Improvement
          Components: Gadget Rendering Server (Java), RESTful API (Java)
    Affects Versions: trunk
            Reporter: Vincent Siveton
             Fix For: trunk


Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Henning Schmiedehausen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662811#action_12662811 ] 

Henning Schmiedehausen commented on SHINDIG-828:
------------------------------------------------

Yes, but still: Why? What is the advantage over not having them in their respective source packages? 

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662605#action_12662605 ] 

Vincent Siveton commented on SHINDIG-828:
-----------------------------------------

bq: why do you remove the package.html files? 

Not remove of course! just move all javadoc resources into a javadoc dir. The patch misses some informations due to some Tortoise limitations, it is why I attached a zip file .

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Henning Schmiedehausen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662597#action_12662597 ] 

Henning Schmiedehausen commented on SHINDIG-828:
------------------------------------------------

why do you remove the package.html files?

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (SHINDIG-828) Move all resources in a resources directory

Posted by "Paul Lindner (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Paul Lindner resolved SHINDIG-828.
----------------------------------

    Resolution: Fixed

convert all package.html to package-info.java


> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Java
>    Affects Versions: 1.1-BETA1
>            Reporter: Vincent Siveton
>             Fix For: 1.1-BETA4
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662829#action_12662829 ] 

Vincent Siveton commented on SHINDIG-828:
-----------------------------------------

Using a javadoc dir instead of the java src dir is just to follow the Maven convention. This approach has pros/cons, but the team needs to decide where putting these files and update  [1] 
Also, as you probably know, with Javadoc 5.0, package.html becomes package-info.java (normally in /src/main/java) and is preferred over package.html.

[1] http://cwiki.apache.org/SHINDIGxSITE/java-style.html

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Henning Schmiedehausen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662849#action_12662849 ] 

Henning Schmiedehausen commented on SHINDIG-828:
------------------------------------------------

To be honest, for me it has mainly cons, which has exactly to do with the package-info.java convention (where would those go BTW, into "javadoc" or "java"?). The package-info.java file can contain annotations for the package itself which needs to be picked up by the compiler so you can't move these files out (which is also the reason why it was renamed in 1.5 from package.html to package-info.java; so that it can be treated as a java file, not an HTML file).

The maven guys sometime went a bit overboard in their quest of imposing conventions on arbitrary java code bases. :-) This is one of these things. In a nutshell, my recommendation is: "Don't do it".  



> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Henning Schmiedehausen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662850#action_12662850 ] 

Henning Schmiedehausen commented on SHINDIG-828:
------------------------------------------------

... and I assume that by "team" you mean "the Apache Shindig community". 

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662529#action_12662529 ] 

Vincent Siveton commented on SHINDIG-828:
-----------------------------------------

also remove this dir http://svn.apache.org/repos/asf/incubator/shindig/trunk/java/gadgets/src/test/jresources

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (SHINDIG-828) Move all resources in a resources directory

Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vincent Siveton updated SHINDIG-828:
------------------------------------

    Attachment: java.zip
                SHINDIG-828.diff

This patch moves all javadoc resources in the src/main/javadoc and some resources in a resources directory

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (SHINDIG-828) Move all resources in a resources directory

Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/SHINDIG-828?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12662361#action_12662361 ] 

Vincent Siveton commented on SHINDIG-828:
-----------------------------------------

Also, I think you could rename the dir java/common/src/main/bundle to resources, since it doesn't include any bundles.

> Move all resources in a resources directory
> -------------------------------------------
>
>                 Key: SHINDIG-828
>                 URL: https://issues.apache.org/jira/browse/SHINDIG-828
>             Project: Shindig
>          Issue Type: Improvement
>          Components: Gadget Rendering Server (Java), RESTful API (Java)
>    Affects Versions: trunk
>            Reporter: Vincent Siveton
>             Fix For: trunk
>
>         Attachments: java.zip, SHINDIG-828.diff
>
>
> Some Javadoc resources are in the src/main/java, should be in src/main/javadoc

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.