Author: bodewig
Date: Fri Oct 11 14:27:59 2013
New Revision: 1531308
URL: http://svn.apache.org/r1531308
Log:
update documentation
Added:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html
(with props)
Modified:
commons/proper/compress/trunk/src/changes/changes.xml
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
commons/proper/compress/trunk/src/site/xdoc/examples.xml
commons/proper/compress/trunk/src/site/xdoc/index.xml
Modified: commons/proper/compress/trunk/src/changes/changes.xml
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/changes/changes.xml?rev=1531308&r1=1531307&r2=1531308&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/changes/changes.xml (original)
+++ commons/proper/compress/trunk/src/changes/changes.xml Fri Oct 11 14:27:59
2013
@@ -52,7 +52,8 @@ The <action> type attribute can be add,u
<action type="add" date="2013-05-07" issue="COMPRESS-54"
due-to="Damjan Jovanovic">
Added support for 7z archives. Most compression algorithms
- can be read, but only uncompressed archives can be written.
+ can be read and written, LZMA and encryption are only
+ supported when reading.
</action>
<action type="add" date="2013-05-19" issue="COMPRESS-226"
due-to="Damjan Jovanovic">
@@ -109,7 +110,7 @@ The <action> type attribute can be add,u
<action type="fix" date="2013-10-04" issue="COMPRESS-239">
The auto-detecting create*InputStream methods of Archive and
CompressorStreamFactory could fail to detect the format of
- blocking input stream.
+ blocking input streams.
</action>
</release>
<release version="1.5" date="2013-03-14"
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java?rev=1531308&r1=1531307&r2=1531308&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
Fri Oct 11 14:27:59 2013
@@ -54,7 +54,12 @@ public class SevenZOutputFile {
}
/**
- * Sets the compression method to use for entry contents.
+ * Sets the compression method to use for entry contents - the
+ * default is LZMA2.
+ *
+ * <p>Currently only {@link SevenZMethod.COPY}, {@link
+ * SevenZMethod.LZMA2}, {@link SevenZMethod.BZIP2} and {@link
+ * SevenZMethod.DEFLATE} are supported.</p>
*/
public void setContentCompression(SevenZMethod method) {
this.contentCompression = method;
Added:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html?rev=1531308&view=auto
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html
(added)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html
Fri Oct 11 14:27:59 2013
@@ -0,0 +1,33 @@
+<html>
+<!--
+
+ 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.
+
+-->
+ <body>
+ <p>Provides a stream class decompressing streams using the
+ "stand-alone" LZMA algorithm.</p>
+
+ <p>The class in this package is a wrapper around {@link
+ org.tukaani.xz.LZMAInputStream org.tukaani.xz.LZMAInputStream}
+ and provided by the public
+ domain <a href="http://tukaani.org/xz/java.html";>XZ for Java</a>
+ library.</p>
+
+ <p>In general you should prefer the more modern and robust XZ
+ format over stand-alone LZMA compression.</p>
+ </body>
+</html>
Propchange:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/lzma/package.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: commons/proper/compress/trunk/src/site/xdoc/examples.xml
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/examples.xml?rev=1531308&r1=1531307&r2=1531308&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Fri Oct 11
14:27:59 2013
@@ -39,8 +39,8 @@
<p>We currently only provide read support for lzma, arj and
dump. arj can only read uncompressed archives, 7z can read
archives with many compression and encryption algorithms
- supported by 7z but can only write uncompressed and
- unencrypted archives.</p>
+ supported by 7z but doesn't support encryption when writing
+ archives.</p>
</subsection>
<subsection name="Common Notes">
@@ -462,9 +462,9 @@ lzmaIn.close();
<p>Note that Commons Compress currently only supports
a subset of compression and encryption algorithms used for 7z
- archives. For reading only uncompressed entries or LZMA,
- LZMA2, BZIP2, Deflate and AES-256/SHA-256 are supported. Only
- uncompressed and unencrypted archives can be written.</p>
+ archives. For writing only uncompressed entries,
+ LZMA2, BZIP2 and Deflate are supported - reading also supports
+ LZMA and AES-256/SHA-256.</p>
<p>Adding an entry to a 7z archive:</p>
<source><