ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r1187304 - in /ant/antlibs/compress/trunk: changes.xml docs/index.html docs/pack200normalize.html
Date Fri, 21 Oct 2011 11:33:56 GMT
Author: bodewig
Date: Fri Oct 21 11:33:56 2011
New Revision: 1187304

URL: http://svn.apache.org/viewvc?rev=1187304&view=rev
Log:
document pack200normalize

Added:
    ant/antlibs/compress/trunk/docs/pack200normalize.html   (with props)
Modified:
    ant/antlibs/compress/trunk/changes.xml
    ant/antlibs/compress/trunk/docs/index.html

Modified: ant/antlibs/compress/trunk/changes.xml
URL: http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/changes.xml?rev=1187304&r1=1187303&r2=1187304&view=diff
==============================================================================
--- ant/antlibs/compress/trunk/changes.xml (original)
+++ ant/antlibs/compress/trunk/changes.xml Fri Oct 21 11:33:56 2011
@@ -48,6 +48,12 @@
         Support for pack200 compression has been added.
       </action>
       <action type="add">
+        The new pack200normalize task allows you to prepare JAR
+        archives so they can be signed and compressed with pack200 and
+        the signature will still be valid after uncompressing them
+        again.
+      </action>
+      <action type="add">
         Read-only support for the Unix dump format has been added in
         the form of an &lt;undump&gt; task and corresponding
         &lt;dumpentry&gt; and &lt;dumpfileset&gt; resources.

Modified: ant/antlibs/compress/trunk/docs/index.html
URL: http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/docs/index.html?rev=1187304&r1=1187303&r2=1187304&view=diff
==============================================================================
--- ant/antlibs/compress/trunk/docs/index.html (original)
+++ ant/antlibs/compress/trunk/docs/index.html Fri Oct 21 11:33:56 2011
@@ -50,6 +50,7 @@
       <li><a href="unpack.html#gunzip">gunzip</a></li>
       <li><a href="pack.html#gzip">gzip</a></li>
       <li><a href="pack.html#pack200">pack200</a></li>
+      <li><a href="pack200normalize.html">pack200normalize</a></li>
       <li><a href="archive.html#tar">tar</a></li>
       <li><a href="expand.html#unar">unar</a></li>
       <li><a href="expand.html#uncpio">uncpio</a></li>

Added: ant/antlibs/compress/trunk/docs/pack200normalize.html
URL: http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/docs/pack200normalize.html?rev=1187304&view=auto
==============================================================================
--- ant/antlibs/compress/trunk/docs/pack200normalize.html (added)
+++ ant/antlibs/compress/trunk/docs/pack200normalize.html Fri Oct 21 11:33:56 2011
@@ -0,0 +1,124 @@
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<html>
+
+<head>
+  <meta http-equiv="Content-Language" content="en-us">
+  <link rel="stylesheet" type="text/css" href="style.css">
+  <title>Pack200Normalize</title>
+</head>
+
+<body>
+
+  <h2><a name="pack200normalize">Pack200Normalize</a></h2>
+  <h3>Description</h3>
+
+  <p>In general packing and unpacking a JAR changes its binary
+    representation which breaks any signature that has been used to
+    sign the initial JAR.  It is possible to "normalize" a JAR by
+    packing and unpacking it again so that any signature applied to
+    the "normalized" JAR will stay valid during another pack/unpack
+    cycle.
+    See <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/jar/Pack200.Packer.html">Pack200.Packer's
+    javadocs</a> for more details.</p>
+
+  <p>This task can be used to normalize a JAR in-place or to create a
+    new normalized JAR separate from the original JAR.  The later
+    allows you to run <code>&lt;jar&gt;</code>
+    and <code>&lt;pack200normalize&gt;</code> in succession and the
+    "normalization" step wouldn't do anything unless the original jar
+    changed.</p>
+
+  <p>If you want to normalize the JAR in-place, you must set the force
+    attribute to true as any file will always be up-to-date when
+    compared to itself.</p>
+
+  <h3>Parameters</h3>
+  <table border="1" cellpadding="2" cellspacing="0">
+    <tr>
+      <td valign="top"><b>Attribute</b></td>
+      <td valign="top"><b>Description</b></td>
+      <td align="center" valign="top"><b>Required</b></td>
+    </tr>
+    <tr>
+      <td valign="top">srcfile</td>
+      <td valign="top">the file to normalize.</td>
+      <td align="center" valign="top">Yes.</td>
+    </tr>
+    <tr>
+      <td valign="top">destfile</td>
+      <td valign="top">the normalized archive.</td>
+      <td align="center" valign="top">No, defaults to the
+        srcfile.</td>
+    </tr>
+    <tr>
+      <td valign="top">force</td>
+      <td valign="top">Whether to normalize the archive even if the
+        destfile seems up-to-date.</td>
+      <td align="center" valign="top">No, defaults to <em>false</em></td>
+    </tr>
+  </table>
+
+  <h3>Parameters specified as nested elements</h3>
+
+  <h4>property</h4>
+
+  <p>Sets a property for the packer (see the Pack200 javadocs for
+    details).</p>
+
+  <p>Note this task implicitly sets the segment limit to -1.</p>
+
+  <table border="1" cellpadding="2" cellspacing="0">
+    <tr>
+      <td valign="top"><b>Attribute</b></td>
+      <td valign="top"><b>Description</b></td>
+      <td align="center" valign="top"><b>Required</b></td>
+    </tr>
+    <tr>
+      <td valign="top">key</td>
+      <td valign="top">Name of the property.</td>
+      <td align="center" valign="top">Yes.</td>
+    </tr>
+    <tr>
+      <td valign="top">value</td>
+      <td valign="top">Value of the property.</td>
+      <td align="center" valign="top">Yes.</td>
+    </tr>
+  </table>
+
+  <h3>Examples</h3>
+
+  <pre>
+    &lt;cmp:pack200normalize destfile="foo-normalized.jar"
+                 xmlns:cmp="antlib:org.apache.ant.compress"
+                 srcfile="foo.jar"&gt;
+      &lt;property key="pack.effort" value="9"/&gt;
+    &lt;/cmp:pack200normalize&gt;
+  </pre>
+  <p>Normalizes <i>foo.jar</i> where <i>foo-normalized.jar</i>
is the
+    normalized archive.  As both the normalization step and the actual
+    packing must use the same parameters the normalization prepares
+    for better compression results by using above than normal
+    effort.</p>
+
+  <pre>
+    &lt;cmp:pack200normalize force="true"
+                 xmlns:cmp="antlib:org.apache.ant.compress"
+                 srcfile="foo.jar"/&gt;
+  </pre>
+  <p>Normalizes <i>foo.jar</i> in-place.</p>
+</body>

Propchange: ant/antlibs/compress/trunk/docs/pack200normalize.html
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message