You are viewing a plain text version of this content. The canonical link for it is here.
Posted to woden-dev@ws.apache.org by "John Kaputin (gmail)" <ja...@gmail.com> on 2008/08/04 16:48:56 UTC
'about-this-package' files in refactored directory tree (WODEN-211)
The text files called 'about-this-package' were created initially to explain
the purpose of each package and were located in the actual java package
directory, along with the java source files. In the new source code
structure some of these files are still within the /java package directory
and some have been moved to the /resources directories. I think it would
reduce the overall size of the directory tree if all of these files were
kept within the package directories (under /java, not /resources) because in
most cases there is nothing else under the /resource directory - just the
'about-this-package' file.
'about-this-package' files that appear under the /java directory:
/woden211/woden-api/src/main/java/org/apache/woden/about-this-package
/woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
'about-this-package' files that appear under the /resources directory:
/woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
/woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
/woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
/woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
/woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
/woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
Note, we never created these files consistently for all packages anyway, so
perhaps now they should either be deleted or replaced with consistent use of
package.html javadoc files. Thoughts?
regards,
John
Re: 'about-this-package' files in refactored directory tree (WODEN-211)
Posted by "John Kaputin (gmail)" <ja...@gmail.com>.
OK then, if there's no objection, I suggest we remove the about-this-package
files from the new source tree and later on, after it has been committed, we
can create some new package.html files.
regards,
John.
On Tue, Aug 5, 2008 at 2:48 PM, Jeff MAURY <je...@jeffmaury.com> wrote:
>
>
> On Tue, Aug 5, 2008 at 2:16 AM, John Kaputin (gmail) <ja...@gmail.com>wrote:
>
>> Jeff,
>> two questions...
>>
>> 1. What happens if non-java files like these are placed in the java
>> folder? Does it break the Maven build?
>>
> They will be stored in the resulting JAR file unless you explicitly exclude
> them.
>
>
>>
>> 2. If we replace these with package.html files, where would those files be
>> placed? Under the resources folder?
>>
> According to the Maven Javadoc plugin (
> http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html),
> under src/main/javadoc.
>
> Regards
> Jeff MAURY
>
>>
>>
>> thanks,
>> John
>>
>>
>> On Mon, Aug 4, 2008 at 11:15 PM, Jeff MAURY <je...@jeffmaury.com>wrote:
>>
>>> From the Maven point of view, all resources files MUST be kept in the
>>> resources folder. Iy you don't follow this Maven convention, then you must
>>> declare your java folders as resources folder but this will have an impact
>>> on the JAR plugin: you must then tell this plugin not to use .java files
>>> from the resources folders.
>>> So I would not encourage such a use.
>>> So we should remove these files and switch to the Javadoc kind of use.
>>>
>>> Regards
>>> Jeff MAURY
>>>
>>>
>>> On 8/4/08, John Kaputin (gmail) <ja...@gmail.com> wrote:
>>>>
>>>> The text files called 'about-this-package' were created initially to
>>>> explain the purpose of each package and were located in the actual java
>>>> package directory, along with the java source files. In the new source code
>>>> structure some of these files are still within the /java package directory
>>>> and some have been moved to the /resources directories. I think it would
>>>> reduce the overall size of the directory tree if all of these files were
>>>> kept within the package directories (under /java, not /resources) because in
>>>> most cases there is nothing else under the /resource directory - just the
>>>> 'about-this-package' file.
>>>>
>>>> 'about-this-package' files that appear under the /java directory:
>>>>
>>>> /woden211/woden-api/src/main/java/org/apache/woden/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
>>>>
>>>> 'about-this-package' files that appear under the /resources directory:
>>>>
>>>>
>>>> /woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
>>>>
>>>> /woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
>>>>
>>>> Note, we never created these files consistently for all packages anyway,
>>>> so perhaps now they should either be deleted or replaced with consistent use
>>>> of package.html javadoc files. Thoughts?
>>>>
>>>> regards,
>>>> John
>>>>
>>>>
>>>
>>>
>>>
>>> --
>>> La mélancolie c'est communiste
>>> Tout le monde y a droit de temps en temps
>>> La mélancolie n'est pas capitaliste
>>> C'est même gratuit pour les perdants
>>> La mélancolie c'est pacifiste
>>> On ne lui rentre jamais dedans
>>> La mélancolie oh tu sais ça existe
>>> Elle se prend même avec des gants
>>> La mélancolie c'est pour les syndicalistes
>>> Il faut juste sa carte de permanent
>>>
>>> Miossec (2006)
>>>
>>> http://www.jeffmaury.com
>>> http://riadiscuss.jeffmaury.com
>>> http://www.lastfm.fr/listen/user/jeffmaury/personal
>>> Mes CDs à récupérer:
>>> http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
>>
>>
>>
>
>
> --
> La mélancolie c'est communiste
> Tout le monde y a droit de temps en temps
> La mélancolie n'est pas capitaliste
> C'est même gratuit pour les perdants
> La mélancolie c'est pacifiste
> On ne lui rentre jamais dedans
> La mélancolie oh tu sais ça existe
> Elle se prend même avec des gants
> La mélancolie c'est pour les syndicalistes
> Il faut juste sa carte de permanent
>
> Miossec (2006)
>
> http://www.jeffmaury.com
> http://riadiscuss.jeffmaury.com
> http://www.lastfm.fr/listen/user/jeffmaury/personal
> Mes CDs à récupérer:
> http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
>
Re: 'about-this-package' files in refactored directory tree (WODEN-211)
Posted by Jeff MAURY <je...@jeffmaury.com>.
On Tue, Aug 5, 2008 at 2:16 AM, John Kaputin (gmail) <ja...@gmail.com>wrote:
> Jeff,
> two questions...
>
> 1. What happens if non-java files like these are placed in the java folder?
> Does it break the Maven build?
>
They will be stored in the resulting JAR file unless you explicitly exclude
them.
>
> 2. If we replace these with package.html files, where would those files be
> placed? Under the resources folder?
>
According to the Maven Javadoc plugin (
http://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html),
under src/main/javadoc.
Regards
Jeff MAURY
>
>
> thanks,
> John
>
>
> On Mon, Aug 4, 2008 at 11:15 PM, Jeff MAURY <je...@jeffmaury.com>wrote:
>
>> From the Maven point of view, all resources files MUST be kept in the
>> resources folder. Iy you don't follow this Maven convention, then you must
>> declare your java folders as resources folder but this will have an impact
>> on the JAR plugin: you must then tell this plugin not to use .java files
>> from the resources folders.
>> So I would not encourage such a use.
>> So we should remove these files and switch to the Javadoc kind of use.
>>
>> Regards
>> Jeff MAURY
>>
>>
>> On 8/4/08, John Kaputin (gmail) <ja...@gmail.com> wrote:
>>>
>>> The text files called 'about-this-package' were created initially to
>>> explain the purpose of each package and were located in the actual java
>>> package directory, along with the java source files. In the new source code
>>> structure some of these files are still within the /java package directory
>>> and some have been moved to the /resources directories. I think it would
>>> reduce the overall size of the directory tree if all of these files were
>>> kept within the package directories (under /java, not /resources) because in
>>> most cases there is nothing else under the /resource directory - just the
>>> 'about-this-package' file.
>>>
>>> 'about-this-package' files that appear under the /java directory:
>>>
>>> /woden211/woden-api/src/main/java/org/apache/woden/about-this-package
>>>
>>> /woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
>>>
>>> 'about-this-package' files that appear under the /resources directory:
>>>
>>>
>>> /woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
>>>
>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
>>>
>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
>>>
>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
>>>
>>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
>>>
>>> /woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
>>>
>>> Note, we never created these files consistently for all packages anyway,
>>> so perhaps now they should either be deleted or replaced with consistent use
>>> of package.html javadoc files. Thoughts?
>>>
>>> regards,
>>> John
>>>
>>>
>>
>>
>>
>> --
>> La mélancolie c'est communiste
>> Tout le monde y a droit de temps en temps
>> La mélancolie n'est pas capitaliste
>> C'est même gratuit pour les perdants
>> La mélancolie c'est pacifiste
>> On ne lui rentre jamais dedans
>> La mélancolie oh tu sais ça existe
>> Elle se prend même avec des gants
>> La mélancolie c'est pour les syndicalistes
>> Il faut juste sa carte de permanent
>>
>> Miossec (2006)
>>
>> http://www.jeffmaury.com
>> http://riadiscuss.jeffmaury.com
>> http://www.lastfm.fr/listen/user/jeffmaury/personal
>> Mes CDs à récupérer:
>> http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
>
>
>
--
La mélancolie c'est communiste
Tout le monde y a droit de temps en temps
La mélancolie n'est pas capitaliste
C'est même gratuit pour les perdants
La mélancolie c'est pacifiste
On ne lui rentre jamais dedans
La mélancolie oh tu sais ça existe
Elle se prend même avec des gants
La mélancolie c'est pour les syndicalistes
Il faut juste sa carte de permanent
Miossec (2006)
http://www.jeffmaury.com
http://riadiscuss.jeffmaury.com
http://www.lastfm.fr/listen/user/jeffmaury/personal
Mes CDs à récupérer:
http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
Re: 'about-this-package' files in refactored directory tree (WODEN-211)
Posted by "John Kaputin (gmail)" <ja...@gmail.com>.
Jeff,
two questions...
1. What happens if non-java files like these are placed in the java folder?
Does it break the Maven build?
2. If we replace these with package.html files, where would those files be
placed? Under the resources folder?
thanks,
John
On Mon, Aug 4, 2008 at 11:15 PM, Jeff MAURY <je...@jeffmaury.com> wrote:
> From the Maven point of view, all resources files MUST be kept in the
> resources folder. Iy you don't follow this Maven convention, then you must
> declare your java folders as resources folder but this will have an impact
> on the JAR plugin: you must then tell this plugin not to use .java files
> from the resources folders.
> So I would not encourage such a use.
> So we should remove these files and switch to the Javadoc kind of use.
>
> Regards
> Jeff MAURY
>
>
> On 8/4/08, John Kaputin (gmail) <ja...@gmail.com> wrote:
>>
>> The text files called 'about-this-package' were created initially to
>> explain the purpose of each package and were located in the actual java
>> package directory, along with the java source files. In the new source code
>> structure some of these files are still within the /java package directory
>> and some have been moved to the /resources directories. I think it would
>> reduce the overall size of the directory tree if all of these files were
>> kept within the package directories (under /java, not /resources) because in
>> most cases there is nothing else under the /resource directory - just the
>> 'about-this-package' file.
>>
>> 'about-this-package' files that appear under the /java directory:
>>
>> /woden211/woden-api/src/main/java/org/apache/woden/about-this-package
>>
>> /woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
>>
>> 'about-this-package' files that appear under the /resources directory:
>>
>>
>> /woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
>>
>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
>>
>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
>>
>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
>>
>> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
>> /woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
>>
>> Note, we never created these files consistently for all packages anyway,
>> so perhaps now they should either be deleted or replaced with consistent use
>> of package.html javadoc files. Thoughts?
>>
>> regards,
>> John
>>
>>
>
>
>
> --
> La mélancolie c'est communiste
> Tout le monde y a droit de temps en temps
> La mélancolie n'est pas capitaliste
> C'est même gratuit pour les perdants
> La mélancolie c'est pacifiste
> On ne lui rentre jamais dedans
> La mélancolie oh tu sais ça existe
> Elle se prend même avec des gants
> La mélancolie c'est pour les syndicalistes
> Il faut juste sa carte de permanent
>
> Miossec (2006)
>
> http://www.jeffmaury.com
> http://riadiscuss.jeffmaury.com
> http://www.lastfm.fr/listen/user/jeffmaury/personal
> Mes CDs à récupérer:
> http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
Re: 'about-this-package' files in refactored directory tree (WODEN-211)
Posted by Jeff MAURY <je...@jeffmaury.com>.
>From the Maven point of view, all resources files MUST be kept in the
resources folder. Iy you don't follow this Maven convention, then you must
declare your java folders as resources folder but this will have an impact
on the JAR plugin: you must then tell this plugin not to use .java files
from the resources folders.
So I would not encourage such a use.
So we should remove these files and switch to the Javadoc kind of use.
Regards
Jeff MAURY
On 8/4/08, John Kaputin (gmail) <ja...@gmail.com> wrote:
>
> The text files called 'about-this-package' were created initially to
> explain the purpose of each package and were located in the actual java
> package directory, along with the java source files. In the new source code
> structure some of these files are still within the /java package directory
> and some have been moved to the /resources directories. I think it would
> reduce the overall size of the directory tree if all of these files were
> kept within the package directories (under /java, not /resources) because in
> most cases there is nothing else under the /resource directory - just the
> 'about-this-package' file.
>
> 'about-this-package' files that appear under the /java directory:
>
> /woden211/woden-api/src/main/java/org/apache/woden/about-this-package
>
> /woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
>
> 'about-this-package' files that appear under the /resources directory:
>
>
> /woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
>
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
>
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
>
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
>
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
>
> Note, we never created these files consistently for all packages anyway, so
> perhaps now they should either be deleted or replaced with consistent use of
> package.html javadoc files. Thoughts?
>
> regards,
> John
>
>
--
La mélancolie c'est communiste
Tout le monde y a droit de temps en temps
La mélancolie n'est pas capitaliste
C'est même gratuit pour les perdants
La mélancolie c'est pacifiste
On ne lui rentre jamais dedans
La mélancolie oh tu sais ça existe
Elle se prend même avec des gants
La mélancolie c'est pour les syndicalistes
Il faut juste sa carte de permanent
Miossec (2006)
http://www.jeffmaury.com
http://riadiscuss.jeffmaury.com
http://www.lastfm.fr/listen/user/jeffmaury/personal
Mes CDs à récupérer:
http://spreadsheets.google.com/ccc?key=pNeg4Doa_oCsh7CepKPaPTA&hl=en
Re: 'about-this-package' files in refactored directory tree (WODEN-211)
Posted by Arthur Ryman <ar...@gmail.com>.
John,
+1 for consistent use of package.html since that gets picked up by javadoc. [1]
[1] http://java.sun.com/j2se/javadoc/writingdoccomments/#packagecomments
-- Arthur
On Mon, Aug 4, 2008 at 8:18 PM, John Kaputin (gmail)
<ja...@gmail.com> wrote:
> The text files called 'about-this-package' were created initially to explain
> the purpose of each package and were located in the actual java package
> directory, along with the java source files. In the new source code
> structure some of these files are still within the /java package directory
> and some have been moved to the /resources directories. I think it would
> reduce the overall size of the directory tree if all of these files were
> kept within the package directories (under /java, not /resources) because in
> most cases there is nothing else under the /resource directory - just the
> 'about-this-package' file.
>
> 'about-this-package' files that appear under the /java directory:
>
> /woden211/woden-api/src/main/java/org/apache/woden/about-this-package
> /woden211/woden-api/src/main/java/org/apache/woden/wsdl20/extensions/about-this-package
>
> 'about-this-package' files that appear under the /resources directory:
>
> /woden211/woden-ant/src/main/resources/org/apache/woden/ant/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/extensions/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/fragids/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/xml/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/wsdl20/about-this-package
> /woden211/woden-api/src/main/resources/org/apache/woden/about-this-package
>
> Note, we never created these files consistently for all packages anyway, so
> perhaps now they should either be deleted or replaced with consistent use of
> package.html javadoc files. Thoughts?
>
> regards,
> John
>
---------------------------------------------------------------------
To unsubscribe, e-mail: woden-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: woden-dev-help@ws.apache.org