[ 
https://issues.apache.org/jira/browse/MSHARED-1451?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Elliotte Rusty Harold updated MSHARED-1451:
-------------------------------------------
    Description: 
The introduction page says, "The Maven Archiver is mainly used by plugins to 
handle packaging." but i doesn't seem to ever say what the format of an archive 
*is*. Is it a JAR? a zip? .tar.gz? something else? Any of the above dependiing 
on parameters? 


We should say something like, "Plugins use the Maven archiver to package 
compiled .class files into a JAR file." Of course, that language might not be 
correct since I don't know what format we use. Or maybe, "The maven-archiver is 
a library (not a Mojo or plugin) used by plugins to..."

  was:
The introduction page says, "The Maven Archiver is mainly used by plugins to 
handle packaging." but i doesn't seem to ever say what the format of an archive 
*is*. Is it a JAR? a zip? .tar.gz? something else? Any of the above dependiing 
on parameters? 


We should say something like, "Plugins use the Maven archiver to package 
compiled .class files into a JAR file." Of course, that language might not be 
correct since I don't know what format we use. 


> Describe archive format in active voice
> ---------------------------------------
>
>                 Key: MSHARED-1451
>                 URL: https://issues.apache.org/jira/browse/MSHARED-1451
>             Project: Maven Shared Components
>          Issue Type: Improvement
>          Components: maven-archiver
>            Reporter: Elliotte Rusty Harold
>            Priority: Major
>              Labels: documentation
>
> The introduction page says, "The Maven Archiver is mainly used by plugins to 
> handle packaging." but i doesn't seem to ever say what the format of an 
> archive *is*. Is it a JAR? a zip? .tar.gz? something else? Any of the above 
> dependiing on parameters? 
> We should say something like, "Plugins use the Maven archiver to package 
> compiled .class files into a JAR file." Of course, that language might not be 
> correct since I don't know what format we use. Or maybe, "The maven-archiver 
> is a library (not a Mojo or plugin) used by plugins to..."



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to