From 39e5ac2906e27d849c9dd043dc5baa9d0313ccce Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Tue, 8 Jul 2025 02:55:11 +0100 Subject: [PATCH] replace svn refs --- README.rst | 4 +- src/documentation/RELEASE-NOTES.txt | 2 +- .../xdocs/components/diagram/index.xml | 8 +- .../xdocs/components/document/index.xml | 8 +- .../components/document/quick-guide-xwpf.xml | 4 +- .../xdocs/components/document/quick-guide.xml | 4 +- .../content/xdocs/components/hmef/index.xml | 6 +- .../xdocs/components/hpbf/file-format.xml | 2 +- .../content/xdocs/components/hpbf/index.xml | 4 +- .../content/xdocs/components/hsmf/index.xml | 6 +- .../content/xdocs/components/index.xml | 6 +- .../xdocs/components/poi-jvm-languages.xml | 4 +- .../content/xdocs/components/poi-ruby.xml | 4 +- .../content/xdocs/components/poifs/how-to.xml | 2 +- .../xdocs/components/slideshow/index.xml | 4 +- .../slideshow/ppt-wmf-emf-renderer.xml | 2 +- .../components/slideshow/xslf-cookbook.xml | 4 +- .../xdocs/components/spreadsheet/examples.xml | 170 +++++++++--------- .../xdocs/components/spreadsheet/excelant.xml | 2 +- .../xdocs/components/spreadsheet/how-to.xml | 10 +- .../components/spreadsheet/limitations.xml | 2 +- .../components/spreadsheet/quick-guide.xml | 2 +- .../spreadsheet/user-defined-functions.xml | 2 +- .../content/xdocs/devel/guidelines.xml | 2 +- .../content/xdocs/devel/index.xml | 2 +- .../content/xdocs/devel/subversion.xml | 170 +----------------- .../content/xdocs/encryption.xml | 4 +- src/documentation/content/xdocs/help/faq.xml | 14 +- src/documentation/publish-poi-site.txt | 12 +- src/documentation/release-guide.txt | 4 +- 30 files changed, 158 insertions(+), 312 deletions(-) diff --git a/README.rst b/README.rst index 4545b9ce78..8578fbdaac 100644 --- a/README.rst +++ b/README.rst @@ -60,9 +60,9 @@ Requires Java 1.8 or later. Contributing ------------------ -* Download and install svn or git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle +* Download and install git, Java JDK 1.8+, and Apache Ant 1.8+ or Gradle -* Check out the code from svn or git +* Check out the code from git * Import the project into Eclipse or your favorite IDE diff --git a/src/documentation/RELEASE-NOTES.txt b/src/documentation/RELEASE-NOTES.txt index 53f99f52b5..c394295b0a 100644 --- a/src/documentation/RELEASE-NOTES.txt +++ b/src/documentation/RELEASE-NOTES.txt @@ -29,7 +29,7 @@ This release comes in source form: All release artifacts are accompanied by SHA checksums and PGP signatures that you can use to verify the authenticity of your download. The public key used for the PGP signature can be found at -https://svn.apache.org/repos/asf/poi/tags/@RELEASE_TAG@/KEYS +https://downloads.apache.org/poi/KEYS About Apache POI ----------------------- diff --git a/src/documentation/content/xdocs/components/diagram/index.xml b/src/documentation/content/xdocs/components/diagram/index.xml index b14c8fcf56..5f060e8318 100644 --- a/src/documentation/content/xdocs/components/diagram/index.xml +++ b/src/documentation/content/xdocs/components/diagram/index.xml @@ -38,7 +38,7 @@

Currently, HDGF provides a low-level, read-only api for accessing Visio documents. It also provides a - way + way to extract the textual content from a file.

At this time, there is no usermodel api or similar, @@ -50,7 +50,7 @@ to get a feel for how Visio files are structured.

To get a feel for the contents of a file, and to track down where data of interest is stored, HDGF comes with - VSDDumper + VSDDumper to print out the contents of the file. Users should also make use of vsdump @@ -58,8 +58,8 @@ This code currently lives the - scratchpad area - of the POI SVN repository. To use this component, ensure + scratchpad area + of the POI Git repository. To use this component, ensure you have the Scratchpad Jar on your classpath, or a dependency defined on the poi-scratchpad artifact - the main POI jar is not enough! See the diff --git a/src/documentation/content/xdocs/components/document/index.xml b/src/documentation/content/xdocs/components/document/index.xml index cf0e682d48..f5dd91c61c 100644 --- a/src/documentation/content/xdocs/components/document/index.xml +++ b/src/documentation/content/xdocs/components/document/index.xml @@ -96,15 +96,15 @@

Currently, there are only a handful of example programs using HWPF and XWPF available. They can be found in svn in the examples section, under - HWPF + HWPF and - XWPF. + XWPF. Both HWPF and XWPF have fairly high levels of unit test coverage, which provides examples of using the various areas of functionality of both modules. These can be found in svn, under - HWPF + HWPF and - XWPF. + XWPF. Contributions of more examples, whether inspired by the unit tests or not, would be most welcomed!

diff --git a/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml b/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml index 208f524504..a321821957 100644 --- a/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml +++ b/src/documentation/content/xdocs/components/document/quick-guide-xwpf.xml @@ -79,9 +79,9 @@ document.

Further Examples

For now, there are a limited number of XWPF examples in the - Examples Package. + Examples Package. Beyond those, the best source of additional examples is in the unit - tests. + tests. Browse the XWPF unit tests.

diff --git a/src/documentation/content/xdocs/components/document/quick-guide.xml b/src/documentation/content/xdocs/components/document/quick-guide.xml index 5bcd203f39..a15f2009a5 100644 --- a/src/documentation/content/xdocs/components/document/quick-guide.xml +++ b/src/documentation/content/xdocs/components/document/quick-guide.xml @@ -30,7 +30,7 @@

HWPF is still in early development. It is in the + href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/"> scratchpad section of the SVN. You will need to ensure you either have a recent SVN checkout, or a recent SVN nightly build (including the scratchpad jar!)

@@ -80,7 +80,7 @@ do end up with macros in them.

Further Examples

For now, the best source of additional examples is in the unit tests. + href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/src/test/java/org/apache/poi/hwpf/"> Browse the HWPF unit tests.

diff --git a/src/documentation/content/xdocs/components/hmef/index.xml b/src/documentation/content/xdocs/components/hmef/index.xml index e82d74958b..168ba65408 100644 --- a/src/documentation/content/xdocs/components/hmef/index.xml +++ b/src/documentation/content/xdocs/components/hmef/index.xml @@ -51,8 +51,8 @@ This code currently lives the - scratchpad area - of the POI SVN repository. To use this component, ensure + scratchpad area + of the POI Git repository. To use this component, ensure you have the Scratchpad Jar on your classpath, or a dependency defined on the poi-scratchpad artifact - the main POI jar is not enough! See the @@ -190,7 +190,7 @@ for(Attachment attach : msg.getAttachments()) {

To get a feel for the contents of a file, and to track down where data of interest is stored, HMEF comes with - HMEFDumper + HMEFDumper to print out the contents of the file.

diff --git a/src/documentation/content/xdocs/components/hpbf/file-format.xml b/src/documentation/content/xdocs/components/hpbf/file-format.xml index eb092444cd..e23df62cc2 100644 --- a/src/documentation/content/xdocs/components/hpbf/file-format.xml +++ b/src/documentation/content/xdocs/components/hpbf/file-format.xml @@ -189,7 +189,7 @@ PL 62 1a 00 00 48 00 00 00 // PL from: 1a62 (6754), len: 48 (72)

Type 8 has 7 2 byte unsigned ints, then a pair of 4 byte unsigned ints for each entry.

Type 12 holds hyperlinks, and is very much more complex. - See org.apache.poi.hpbf.model.qcbits.QCPLCBit + See org.apache.poi.hpbf.model.qcbits.QCPLCBit for our best guess as to how the contents match up.

diff --git a/src/documentation/content/xdocs/components/hpbf/index.xml b/src/documentation/content/xdocs/components/hpbf/index.xml index 75cd4af215..92e4693d3e 100644 --- a/src/documentation/content/xdocs/components/hpbf/index.xml +++ b/src/documentation/content/xdocs/components/hpbf/index.xml @@ -64,8 +64,8 @@ This code currently lives the - scratchpad area - of the POI SVN repository. To use this component, ensure + scratchpad area + of the POI Git repository. To use this component, ensure you have the Scratchpad Jar on your classpath, or a dependency defined on the poi-scratchpad artifact - the main POI jar is not enough! See the diff --git a/src/documentation/content/xdocs/components/hsmf/index.xml b/src/documentation/content/xdocs/components/hsmf/index.xml index 74d5671994..a678b0bd06 100644 --- a/src/documentation/content/xdocs/components/hsmf/index.xml +++ b/src/documentation/content/xdocs/components/hsmf/index.xml @@ -40,13 +40,13 @@

There is an example MSG textual renderer, which shows how to access the common parts such as sender, subject, message body and examples. This is in the - HSMF examples area + HSMF examples area of SVN. You may also wish to look at the unit tests for more use guides.

This code currently lives the - scratchpad area - of the POI SVN repository. To use this component, ensure + scratchpad area + of the POI Git repository. To use this component, ensure you have the Scratchpad Jar on your classpath, or a dependency defined on the poi-scratchpad artifact - the main POI jar is not enough! See the diff --git a/src/documentation/content/xdocs/components/index.xml b/src/documentation/content/xdocs/components/index.xml index e357117773..8c7ae0a2d9 100644 --- a/src/documentation/content/xdocs/components/index.xml +++ b/src/documentation/content/xdocs/components/index.xml @@ -385,8 +385,8 @@
Examples

Small sample programs using the POI API are available in the - src/examples - (viewvc) directory of the source distribution. + src/examples + (viewvc) directory of the source distribution.

All of the examples are included in POI distributions as a poi-examples artifact. @@ -408,7 +408,7 @@

See POI Ruby Bindings and other code in the poi-contrib module + href="https://github.com/apache/poi/tree/trunk/src/contrib/">poi-contrib module

diff --git a/src/documentation/content/xdocs/components/poi-jvm-languages.xml b/src/documentation/content/xdocs/components/poi-jvm-languages.xml index b01c0a3deb..26ab85094d 100644 --- a/src/documentation/content/xdocs/components/poi-jvm-languages.xml +++ b/src/documentation/content/xdocs/components/poi-jvm-languages.xml @@ -118,7 +118,7 @@ from org.apache.poi.ss.usermodel import WorkbookFactory, DataFormatter # Read the contents of the workbook - wb = WorkbookFactory.create(File('SampleSS.xlsx')) + wb = WorkbookFactory.create(File('SampleSS.xlsx')) formatter = DataFormatter() for i, sheet in enumerate(wb, start=1): print('Sheet %d of %d: %s'.format(i, wb.numberOfSheets, sheet.sheetName)) @@ -168,7 +168,7 @@ import scala.collection.JavaConversions._ // Read the contents of the workbook - val workbook = WorkbookFactory.create(new File("SampleSS.xlsx")) + val workbook = WorkbookFactory.create(new File("SampleSS.xlsx")) val formatter = new DataFormatter() for { // Iterate and print the sheets diff --git a/src/documentation/content/xdocs/components/poi-ruby.xml b/src/documentation/content/xdocs/components/poi-ruby.xml index da4201dca6..59cefde764 100644 --- a/src/documentation/content/xdocs/components/poi-ruby.xml +++ b/src/documentation/content/xdocs/components/poi-ruby.xml @@ -51,8 +51,8 @@
Subversion

- The POI-Ruby module sits under the POI Subversion - (viewvc). Running make + The POI-Ruby module sits under the POI Subversion + (viewvc). Running make inside that directory will create a loadable ruby extension poi4r.so in the release subdirectory. Tests are in the tests/ subdirectory, and should be run from the poi-ruby directory. Please read the tests to figure out the usage.

diff --git a/src/documentation/content/xdocs/components/poifs/how-to.xml b/src/documentation/content/xdocs/components/poifs/how-to.xml index 8899994806..234838608e 100644 --- a/src/documentation/content/xdocs/components/poifs/how-to.xml +++ b/src/documentation/content/xdocs/components/poifs/how-to.xml @@ -619,7 +619,7 @@ } ]]>

For an example of an in-place change to one stream within a file, you can see the example - + org/apache/poi/hpsf/examples/ModifyDocumentSummaryInformation.java

diff --git a/src/documentation/content/xdocs/components/slideshow/index.xml b/src/documentation/content/xdocs/components/slideshow/index.xml index 6c2b1c5d39..b963d928a7 100644 --- a/src/documentation/content/xdocs/components/slideshow/index.xml +++ b/src/documentation/content/xdocs/components/slideshow/index.xml @@ -43,8 +43,8 @@ This code currently lives the - scratchpad area - of the POI SVN repository. To use this component, ensure + scratchpad area + of the POI Git repository. To use this component, ensure you have the Scratchpad Jar on your classpath, or a dependency defined on the poi-scratchpad artifact - the main POI jar is not enough! See the diff --git a/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml b/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml index 9ff550d943..d0d4812062 100644 --- a/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml +++ b/src/documentation/content/xdocs/components/slideshow/ppt-wmf-emf-renderer.xml @@ -31,7 +31,7 @@ Rendering slideshows, WMF, EMF and EMF+

For rendering slideshow (HSLF/XSLF), WMF, EMF and EMF+ pictures, POI provides an utility class - + PPTX2PNG:

diff --git a/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml b/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml index 8bde9a2697..4f72295b5f 100644 --- a/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml +++ b/src/documentation/content/xdocs/components/slideshow/xslf-cookbook.xml @@ -30,8 +30,8 @@
XSLF Cookbook

This page offers a short introduction into the XSLF API. More examples can be found in the - XSLF Examples - in the POI SVN repository. + XSLF Examples + in the POI Git repository.

Please note that XSLF is still in early development and is a subject to incompatible changes in a future release. diff --git a/src/documentation/content/xdocs/components/spreadsheet/examples.xml b/src/documentation/content/xdocs/components/spreadsheet/examples.xml index b09384dac1..87feff0b59 100644 --- a/src/documentation/content/xdocs/components/spreadsheet/examples.xml +++ b/src/documentation/content/xdocs/components/spreadsheet/examples.xml @@ -39,7 +39,7 @@ or BusinessPlan -xlsx -

All sample source is available in SVN

+

All sample source is available in SVN

In addition, there are a handful of HSSF only and XSSF only examples as well. @@ -73,7 +73,7 @@

Business Plan -

The BusinessPlan +

The BusinessPlan application creates a sample business plan with three phases, weekly iterations and time highlighting. Demonstrates advanced cell formatting (number and date formats, alignments, fills, borders) and various settings for organizing data in a sheet (freezed panes, grouped rows).

@@ -82,7 +82,7 @@
Calendar -

The Calendar +

The Calendar demo creates a multi sheet calendar. Each month is on a separate sheet.

@@ -90,7 +90,7 @@
Loan Calculator -

The LoanCalculator +

The LoanCalculator demo creates a simple loan calculator. Demonstrates advance usage of cell formulas and named ranges.

@@ -98,7 +98,7 @@
Timesheet -

The Timesheet +

The Timesheet demo creates a weekly timesheet with automatic calculation of total hours. Demonstrates advance usage of cell formulas.

@@ -106,7 +106,7 @@
Conditional Formats -

The ConditionalFormats +

The ConditionalFormats demo is a collection of short examples showing what you can do with Excel conditional formatting in POI:

diff --git a/src/documentation/content/xdocs/components/spreadsheet/limitations.xml b/src/documentation/content/xdocs/components/spreadsheet/limitations.xml index e1334f9649..ce9f8afc56 100644 --- a/src/documentation/content/xdocs/components/spreadsheet/limitations.xml +++ b/src/documentation/content/xdocs/components/spreadsheet/limitations.xml @@ -55,7 +55,7 @@
  • For reading very huge files, take a look at the sample - XLSX2CSV + XLSX2CSV which shows how you can read a file in streaming fashion (again with some limitations on what information you can read out of the file, but there are ways to get at most of it if necessary).
    • diff --git a/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml b/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml index 0318eccc9a..3ef09310b7 100644 --- a/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml +++ b/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml @@ -2197,7 +2197,7 @@ the data to populate another drop down list. sheetCF.addConditionalFormatting(regions, cfRules);

    See more examples on Excel conditional formatting in - ConditionalFormats.java + ConditionalFormats.java

    diff --git a/src/documentation/content/xdocs/components/spreadsheet/user-defined-functions.xml b/src/documentation/content/xdocs/components/spreadsheet/user-defined-functions.xml index ca4ab19dd7..1d5819b88b 100644 --- a/src/documentation/content/xdocs/components/spreadsheet/user-defined-functions.xml +++ b/src/documentation/content/xdocs/components/spreadsheet/user-defined-functions.xml @@ -406,7 +406,7 @@ cell: Sheet1!B4 returns value: org.apache.poi.ss.usermodel.CellValue [790.7936267415464] ]]>

    That is it! Now you can create Java code and register it, allowing your POI based appliction to run spreadsheets that previously were inaccessible.

    -

    This example can be found in the poi-examples/src/main/java/org/apache/poi/examples/ss/formula folder in the source.

    +

    This example can be found in the poi-examples/src/main/java/org/apache/poi/examples/ss/formula folder in the source.

    diff --git a/src/documentation/content/xdocs/devel/guidelines.xml b/src/documentation/content/xdocs/devel/guidelines.xml index 9efe5416b6..5442fa1f5e 100644 --- a/src/documentation/content/xdocs/devel/guidelines.xml +++ b/src/documentation/content/xdocs/devel/guidelines.xml @@ -131,7 +131,7 @@ Ideally, patches should be submitted early and often. This is for two key reasons. Firstly, it's much easier to review smaller patches than large ones. This means that smaller patches are much more likely - to be applied to SVN in a timely fashion. Secondly, by sending in your + to be applied to Git in a timely fashion. Secondly, by sending in your patches earlier rather than later, it's much easier to get feedback on your coding and direction. If you've missed an easier way to do something, or are duplicating some (probably hidden) existing code, or taking things diff --git a/src/documentation/content/xdocs/devel/index.xml b/src/documentation/content/xdocs/devel/index.xml index 4470dd4cfc..819e7a4c44 100644 --- a/src/documentation/content/xdocs/devel/index.xml +++ b/src/documentation/content/xdocs/devel/index.xml @@ -123,7 +123,7 @@ First make sure that Java is set up properly and that you can execute the 'javac' executable in your shell.

    - Next, open Eclipse and create either a local SVN repository, or a copy of the Git repository, + Next, open Eclipse and create a copy of the Git repository, and import the project into Eclipse.

    diff --git a/src/documentation/content/xdocs/devel/subversion.xml b/src/documentation/content/xdocs/devel/subversion.xml index 66cd8e5de6..a308238902 100644 --- a/src/documentation/content/xdocs/devel/subversion.xml +++ b/src/documentation/content/xdocs/devel/subversion.xml @@ -52,21 +52,13 @@ version control page.

    -

    Apache POI uses Subversion as its version control system, - but also has a read-only git mirror -

    - -

    NOTE: When checking out a subproject using - subversion, either perform a sparse checkout or check out - the trunk or a single branch or tag to avoid filling up - your hard-disk and wasting bandwidth. +

    Apache POI uses Git as its version control system. We switch from Subversion to Git + in July 2025.

    If you are not a Committer, but you want to submit patches @@ -76,158 +68,12 @@

    Git access to POI sources

    - The master source repository for Apache POI is the Subversion - one listed above. To support those users and developers who prefer - to use the Git tooling, read-only access to the POI source tree is - also available via Git. The Git mirrors normally track SVN to - within a few minutes. + The trunk source repository for Apache POI is in gitbox.apache.org. + The GitHub mirror can be used to access the repo too (https://github.com/apache/poi). + You can create PRs and issues using GitHub, if you like.

    -

    - The official read-only Git repository for Apache POI is available - from git.apache.org/ . - The Git Clone URL is: git://git.apache.org/poi.git - and Https Clone URL: https://git.apache.org/poi.git . - Please see the Git at - Apache page for more details on the service. -

    -

    - In addition to the git.apache.org - repository, changes are also mirrored in near-realtime to GitHub. - The GitHub repository is available at - https://github.com/apache/poi . - Please note that the GitHub repository is read-only, but pull requests sent - to it will result in an email being sent to the mailing list. A Git-formatted - patch added to Bugzilla is generally preferred though, as it can be tracked - along with all the other contributions. Please see the - contribution guidelines for more - information on getting involved in the project.

    -
    Using Git via the SVN-Git bridge -
    General information -

    - Git provides a nice functionality "git-svn" which allows to read the history - of a Subversion repository and convert it into a full Git repository. This - will keep information from the SVN revisions so that the Git repository can - be updated with newer revisions from Subversion as well as allowing to push - commits from Git "upstream" into the Subversion repository. See the - - official documentation for more details. -

    -
    -
    Set up the repository -

    - The git-svn functionality is provided as a set of sub-commands to - "git svn". To start retrieving information from SVN and create the - initial Git repository run the following command: - -

    - - git svn clone https://svn.apache.org/repos/asf/poi/trunk poisvngit --revision 1732982:HEAD - -

    - Running without --revision from:HEAD will run for a long time and will retrieve the full version history of - the Subversion repository. If you need more repository history, change the from revision to an - earlier release or omit the --revision - specifier altogether. -

    -

    - When this finishes you have a Git repository whose "master" branch - mirrors the SVN "trunk". -
    - From here you can use the full power of Git, i.e. quick branching, - rebasing, merging, ... -
    - See below for some common usage hints. -

    -
    -
    Fetching newer SVN revisions -

    - In order to fetch the latest SVN revisions, you need to "rebase" onto - the SVN trunk: -

    - - git checkout master - git svn rebase - -

    - This will fetch the latest changes from Subversion and will rebase - the master-branch onto them. -

    -
    -
    Pushing Git commits to Subversion -

    - The following command will push all changes on master back to - Subversion: -

    - - git svn dcommit - -

    - Note that usually all commits on master will be sent to Subversion - in one go, so it's similar to a "push" to another Git repository. - - The dcommit may fail if there are newer revisions in Subversion, you - will need to run a git svn rebase first in this case. -

    -
    -
    General usage guidelines -

    - Although you can use the full power of Git, there are a few - things that work well and some things that will get you into - trouble: -

    -

    - You should not develop on master, rather use some branching - concept where you do work on sub-branches and only merge/cherry-pick the - changes that are ready for being sent upstream. - It seems to work better to constantly rebase changes onto the - master branch as this will keep the history clean compared to - the SVN repository and will avoid sending useless "Merge" commits to - Subversion. -

    -

    - You can keep some changes that are only useful locally by using - two branches that are rebased onto each other. E.g. - something like the following has proven to work well: -

    - - master - -> localchanges - commits that should not be sent upstream -> - -> workbranch - place for doing development work - -

    - When things are ready in the workbranch do a -

    - - git checkout master - git cherry-pick commitid ... - -

    - to get all the finished commits onto master as preparation for pushing them upstream. - - Then you can git svn dcommit to send the changes upstream - and a git svn rebase to get master updated with the newly - created SVN revisions. - - Finally do the following to update both branches onto the new SVN head -

    - - # rebase you local changes onto the latest SVN state - git checkout localchanges - git rebase master - - # also set the working branch to the latest state from SVN. - git checkout workbranch - git rebase workbranch - -

    - Sounds like too much work? Put these steps into a small script and all - this will become a simple poiupdate to get all branches - rebased onto HEAD from Subversion. -

    -
    -
    -
    Code metrics +
    Code metrics

    Code quality reports for Apache POI are available on the Apache Sonar instance. diff --git a/src/documentation/content/xdocs/encryption.xml b/src/documentation/content/xdocs/encryption.xml index 635544a2a4..4d0839c926 100644 --- a/src/documentation/content/xdocs/encryption.xml +++ b/src/documentation/content/xdocs/encryption.xml @@ -259,7 +259,7 @@ depend on supporting services and although the code is adopted, the integration is not well tested ... please support us on integration (testing) with timestamp and revocation (OCSP) services.

    -

    Further test examples can be found in the corresponding test class.

    +

    Further test examples can be found in the corresponding test class.

    If you want to use a hash algorithm with 64 bytes (currently only applies to SHA512), a base64 "feature" in xmlsec @@ -366,7 +366,7 @@ to extract an OOXML spreadsheet zipped container and write the contents to disk using AES encryption.

    -

    See SXSSFWorkbookWithCustomZipEntrySource.java +

    See SXSSFWorkbookWithCustomZipEntrySource.java and other files that are needed for this example.

    diff --git a/src/documentation/content/xdocs/help/faq.xml b/src/documentation/content/xdocs/help/faq.xml index cf28c18e87..2c083335b0 100644 --- a/src/documentation/content/xdocs/help/faq.xml +++ b/src/documentation/content/xdocs/help/faq.xml @@ -382,8 +382,8 @@ case HSSFCell.CELL_TYPE_NUMERIC:

    Apache POI ships with a few programs and a few example programs, which can be used to do some basic performance checks. For testing file generation, the class to use is in the examples package, - SSPerformanceTest - (viewvc). + SSPerformanceTest + (viewvc). Run SSPerformanceTest with arguments of the writing type (HSSF, XSSF or SXSSF), the number rows, the number of columns, and if the file should be saved. If you can't run that with 50,000 rows and 50 columns @@ -391,11 +391,11 @@ case HSSFCell.CELL_TYPE_NUMERIC: (and ideally all 3 in less than that!), then the problem is with your environment.

    Next, use the example program - ToCSV - (viewvc) + ToCSV + (viewvc) to try reading the file in with HSSF or XSSF. Related is - XLSX2CSV - (viewvc), + XLSX2CSV + (viewvc), which uses SAX parsing for .xlsx. Run this against both your problem file, and a simple one generated by SSPerformanceTest of the same size. If this is slow, then there could be an Apache POI problem with how the file is being @@ -424,7 +424,7 @@ case HSSFCell.CELL_TYPE_NUMERIC: the common parts. Use the sources off poi-ooxml-full for the lite version, which is available from Maven Central - ask your favourite Maven mirror for the poi-ooxml-full-*-sources jar. Alternately, if you download - the POI source distribution (or checkout from SVN) and build, Ant will + the POI source distribution (or checkout from Git) and build, Ant will automatically compile it for you to generate the source and binary poi-ooxml-full jars.

    diff --git a/src/documentation/publish-poi-site.txt b/src/documentation/publish-poi-site.txt index 25376fa05c..c60cd7918b 100644 --- a/src/documentation/publish-poi-site.txt +++ b/src/documentation/publish-poi-site.txt @@ -22,11 +22,11 @@ The Apache POI web site is https://poi.apache.org/ -The HTML and other files for the web site are stored in svn at https://svn.apache.org/repos/asf/poi/site +The HTML and other files for the web site are stored in git at https://github.com/apache/poi/tree/asf-site Committing files to the `publish` directory of this repo will automatically lead to the web site being updated. There may be a small delay and you might need to force a refresh in your browser. -The site is built from using the main POI svn at https://svn.apache.org/repos/asf/poi/trunk +The site is built from using the main POI git at https://github.com/apache/poi/tree/trunk Prerequisites ------------- @@ -47,15 +47,15 @@ Building and Deploying the Site It is recommended that you open a command prompt and set up Java 8 as your default. The web site build will fail if you use a very recent Java version. -In your local copy of the POI svn (https://svn.apache.org/repos/asf/poi/trunk), run: +In your local copy of the POI svn (https://github.com/apache/poi/tree/trunk), run: ant site After this completes, you can copy the files in `build/site` to the `publish` directory in your poi-site checkout -(https://svn.apache.org/repos/asf/poi/site). +(https://github.com/apache/poi/tree/asf-site). A command like this might work. -cp -r ~/svn/poi/build/site/* ~/svn/poi-site/publish/ +cp -r ~/poi/build/site/* ~/poi-site/publish/ -I would recommend that you use `svn stat` and `svn diff` before committing the changes to poi-site. +I would recommend that you use `git status` and `git diff` before committing the changes to poi-site. diff --git a/src/documentation/release-guide.txt b/src/documentation/release-guide.txt index 8012729daf..53cac95f08 100644 --- a/src/documentation/release-guide.txt +++ b/src/documentation/release-guide.txt @@ -95,7 +95,7 @@ svn update --set-depth infinity dist/release/poi/ (II) Making release artifacts - Run these commands from a clean checkout of https://svn.apache.org/repos/asf/poi/trunk + Run these commands from a clean checkout of https://github.com/apache/poi/tree/trunk 1. Update the version number in these files and commit the changes to svn. - build.xml (version.id) @@ -357,7 +357,7 @@ Note, announcements should be sent from your @apache.org e-mail address. 10. In Bugzilla, add a new version and the next "...-dev" version. Also close the n-2 -dev version to new bugs. 11. Add the version to the DOAP file too - https://svn.apache.org/repos/asf/poi/trunk/doap_POI.rdf + https://github.com/apache/poi/tree/trunk/doap_POI.rdf 12. Delete directory that held RC.