Author: fanningpj
Date: Tue Jun 25 12:48:14 2024
New Revision: 1918590
URL: http://svn.apache.org/viewvc?rev=1918590&view=rev
Log:
update docs
Modified:
poi/site/src/documentation/RELEASE-NOTES.txt
poi/site/src/documentation/content/xdocs/devel/index.xml
poi/site/src/documentation/content/xdocs/help/faq.xml
poi/site/src/documentation/release-guide.txt
Modified: poi/site/src/documentation/RELEASE-NOTES.txt
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/RELEASE-NOTES.txt?rev=1918590&r1=1918589&r2=1918590&view=diff
==============================================================================
--- poi/site/src/documentation/RELEASE-NOTES.txt (original)
+++ poi/site/src/documentation/RELEASE-NOTES.txt Tue Jun 25 12:48:14 2024
@@ -21,7 +21,7 @@ This release comes in source form:
- source archive you can build POI from (poi-src-@VERSION@-@DSTAMP@.zip or
poi-src-@VERSION@-@dst...@.tar.gz)
Unpack the archive and use the following command to build all POI components
with JDK 1.8 or higher:
- gradlew jar
+ gradle jar
Pre-built versions of all POI components are also available in the central
Maven repository
under Group ID "org.apache.poi" and Version "@VERSION@"
Modified: poi/site/src/documentation/content/xdocs/devel/index.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/devel/index.xml?rev=1918590&r1=1918589&r2=1918590&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/devel/index.xml (original)
+++ poi/site/src/documentation/content/xdocs/devel/index.xml Tue Jun 25
12:48:14 2024
@@ -67,6 +67,10 @@
Gradlew checks if you the right version of Gradle installed
and will install it if you don't.
</p>
<p>
+ Note that our source releases no longer contain gradlew or
gradlew.bat. You can install the Gradle tool
+ yourself and use it to build POI.
+ </p>
+ <p>
The main targets of interest to our users are:
</p>
<table>
Modified: poi/site/src/documentation/content/xdocs/help/faq.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/help/faq.xml?rev=1918590&r1=1918589&r2=1918590&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/help/faq.xml (original)
+++ poi/site/src/documentation/content/xdocs/help/faq.xml Tue Jun 25 12:48:14
2024
@@ -602,12 +602,12 @@ and
</faq>
<faq id="faq-N102B0">
<question>
- Can Apache POI be compiled/used with Java 11 and 17?
+ Can Apache POI be compiled/used with Java 11, 17 and 21?
</question>
<answer>
<p>
POI is successfully tested with many different versions of Java.
It is
- recommended that you use Java versions that have Long Term
Support (Java 11 and 17).
+ recommended that you use Java versions that have Long Term
Support (Java 11, 17 and 21).
</p>
<p>Including the existing binaries as normal jar-files
should work when using recent versions of Apache POI. You may
see
@@ -630,9 +630,8 @@ and
or a recent trunk checkout until then.
</p>
<p>
- If you are building POI yourself from source files, use an up to
date version of Gradle
- (ideally via the gradlew scripts that we bundle). If you use
Ant, again check the Ant version
- supports the version of Java you are using.
+ If you are building POI yourself from source files, use an up to
date version of Gradle.
+ If you use Ant, again check the Ant version supports the version
of Java you are using.
</p>
</answer>
</faq>
@@ -643,7 +642,7 @@ and
<answer>
<p>Apache POI does not actively support Java 9 or Java 10 any
longer as those versions were
obsoleted by Oracle already. See the previous FAQ entry for
information about support for
- Java 11 and 17.
+ Java LTS versions.
</p>
</answer>
</faq>
Modified: poi/site/src/documentation/release-guide.txt
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/release-guide.txt?rev=1918590&r1=1918589&r2=1918590&view=diff
==============================================================================
--- poi/site/src/documentation/release-guide.txt (original)
+++ poi/site/src/documentation/release-guide.txt Tue Jun 25 12:48:14 2024
@@ -107,8 +107,8 @@ svn update --set-depth infinity dist/rel
https://ci-builds.apache.org/job/POI/job/POI-DSL-1.8/lastSuccessfulBuild/artifact/
3. To produce the source distributions, run
- - ./gradlew distSrcZip
- - ./gradlew distSrcTar
+ - ./gradlew srcDistZip
+ - ./gradlew srcDistTar
4. Copy the build/dist files to your svn checkout of dist.apache.org
(dist/dev/poi/src)
@@ -146,14 +146,32 @@ find . -name "*.asc" -exec gpg --no-secm
-
https://ci-builds.apache.org/job/POI/job/POI-DSL-1.8/lastSuccessfulBuild/artifact/
2. Set up a `poi-prep` directory and copy all the jars other than the `test`
jars into it.
+ - The artifacts in the archive.zip that you can download (see 1 above)
are grouped in different dirs
+ - you can unzip the archive.zip and use the sample script from the
`poi-prep` dir
+This is an example script:
+{code:sh}
+export DOWNLOADED_JARS_DIR=/path/to/unzipped/archive
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-excelant/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-examples/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-ooxml/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-ooxml-full/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-ooxml-lite/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-scratchpad/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-javadoc/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-examples-javadoc/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-excelant-javadoc/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-ooxml-javadoc/*.jar .
+mv $DOWNLOADED_JARS_DIR/build/dist/maven/poi-scratchpad-javadoc/*.jar .
+{code:sh}
3. We need to create pom files. Copy the ones from the last release into the
directory with the jars.
- ensure the pom file names match the jar names (same version)
This is an example script:
{code:sh}
-export POI_RELEASE=5.2.5
-export POI_LAST_RELEASE=5.2.4
+export POI_RELEASE=5.3.0
+export POI_LAST_RELEASE=5.2.5
curl
https://repo1.maven.org/maven2/org/apache/poi/poi/$POI_LAST_RELEASE/poi-$POI_LAST_RELEASE.pom
--output poi-$POI_RELEASE.pom
curl
https://repo1.maven.org/maven2/org/apache/poi/poi-scratchpad/$POI_LAST_RELEASE/poi-scratchpad-$POI_LAST_RELEASE.pom
--output poi-scratchpad-$POI_RELEASE.pom
curl
https://repo1.maven.org/maven2/org/apache/poi/poi-ooxml/$POI_LAST_RELEASE/poi-ooxml-$POI_LAST_RELEASE.pom
--output poi-ooxml-$POI_RELEASE.pom
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org
For additional commands, e-mail: commits-h...@poi.apache.org
