You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ce...@apache.org on 2021/01/23 08:59:52 UTC
svn commit: r1885840 - in /poi/site: publish/components/spreadsheet/
publish/devel/ src/documentation/content/xdocs/components/spreadsheet/
src/documentation/content/xdocs/devel/
Author: centic
Date: Sat Jan 23 08:59:52 2021
New Revision: 1885840
URL: http://svn.apache.org/viewvc?rev=1885840&view=rev
Log:
Documentation: Adjust examples, fix git command, adjust for JUnit 5
Modified:
poi/site/publish/components/spreadsheet/quick-guide.html
poi/site/publish/devel/guidelines.html
poi/site/publish/devel/subversion.html
poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml
poi/site/src/documentation/content/xdocs/devel/guidelines.xml
poi/site/src/documentation/content/xdocs/devel/subversion.xml
Modified: poi/site/publish/components/spreadsheet/quick-guide.html
URL: http://svn.apache.org/viewvc/poi/site/publish/components/spreadsheet/quick-guide.html?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/publish/components/spreadsheet/quick-guide.html (original)
+++ poi/site/publish/components/spreadsheet/quick-guide.html Sat Jan 23 08:59:52 2021
@@ -4289,7 +4289,7 @@ Examples:
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">Hyperlink link = createHelper.createHyperlink(Hyperlink.LINK_URL);</span>
+<span class="lineno"></span><span class="codebody">Hyperlink link = createHelper.createHyperlink(HyperlinkType.URL);</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">link.setAddress("https://poi.apache.org/");</span>
@@ -4313,7 +4313,7 @@ Examples:
<span class="lineno"></span><span class="codebody">cell.setCellValue("File Link");</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">link = createHelper.createHyperlink(Hyperlink.LINK_FILE);</span>
+<span class="lineno"></span><span class="codebody">link = createHelper.createHyperlink(HyperlinkType.FILE);</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">link.setAddress("link1.xls");</span>
@@ -4337,7 +4337,7 @@ Examples:
<span class="lineno"></span><span class="codebody">cell.setCellValue("Email Link");</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">link = createHelper.createHyperlink(Hyperlink.LINK_EMAIL);</span>
+<span class="lineno"></span><span class="codebody">link = createHelper.createHyperlink(HyperlinkType.EMAIL);</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">//note, if subject contains white spaces, make sure they are url-encoded</span>
@@ -4379,7 +4379,7 @@ Examples:
<span class="lineno"></span><span class="codebody">cell.setCellValue("Worksheet Link");</span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">Hyperlink link2 = createHelper.createHyperlink(Hyperlink.LINK_DOCUMENT);</span>
+<span class="lineno"></span><span class="codebody">Hyperlink link2 = createHelper.createHyperlink(HyperlinkType.DOCUMENT);</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">link2.setAddress("'Target Sheet'!A1");</span>
Modified: poi/site/publish/devel/guidelines.html
URL: http://svn.apache.org/viewvc/poi/site/publish/devel/guidelines.html?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/publish/devel/guidelines.html (original)
+++ poi/site/publish/devel/guidelines.html Sat Jan 23 08:59:52 2021
@@ -236,21 +236,21 @@ document.write("Last Published: " + docu
<a name="Disclaimer"></a>
<h3 class="boxed">Disclaimer</h3>
<p>
- Any information in here that might be perceived as legal information is
+ Any information in here that might be perceived as legal information is
informational only. We're not lawyers, so consult a legal professional
- if needed.
+ if needed.
</p>
<a name="The+Licensing"></a>
<h3 class="boxed">The Licensing</h3>
<p>
The POI project is <a href="http://www.opensource.org">OpenSource</a>
and developed/distributed under the <a href="https://www.apache.org/foundation/license-faq.html">
- Apache Software License v2</a>. Unlike some other licenses, the Apache
+ Apache Software License v2</a>. Unlike some other licenses, the Apache
license allows free open source development. Unlike some other Open Source
- licenses, it does not require you to release your source or use any
- particular license for your code which builds on top of it. (There are a
+ licenses, it does not require you to release your source or use any
+ particular license for your code which builds on top of it. (There are a
handful of restrictions, especially around attribution, notices and trademarks,
- so it's worth a read of the license - it isn't scary!). If you wish to
+ so it's worth a read of the license - it isn't scary!). If you wish to
contribute to Apache POI (which you're very welcome and encouraged to do so),
then you must agree to grant your contributions to us under the same license.
</p>
@@ -268,8 +268,8 @@ document.write("Last Published: " + docu
</div>
<script src="https://helpwanted.apache.org/widget.js" type="text/javascript"></script>
<p>Please note - only some of the areas where help is needed have been listed
- in the <a href="https://helpwanted.apache.org/">Apache "Help Wanted!" tool</a>,
- many others remain only in Bugzilla or listed as TODOs in the code. Please see
+ in the <a href="https://helpwanted.apache.org/">Apache "Help Wanted!" tool</a>,
+ many others remain only in Bugzilla or listed as TODOs in the code. Please see
the section below for more on these.</p>
</div>
@@ -318,7 +318,7 @@ document.write("Last Published: " + docu
</ul>
<p>The Apache <a href="http://www.apache.org/dev/contributors.html">Contributors Tech Guide</a> gives a good overview how to start contributing patches.</p>
-<p>The Nutch project also have a very useful guide on becoming a
+<p>The Nutch project also have a very useful guide on becoming a
new developer in their project. While it is written for their project,
a large part of it will apply to POI too. You can read it at
<a href="https://wiki.apache.org/nutch/Becoming_A_Nutch_Developer">http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</a>. The
@@ -331,12 +331,12 @@ document.write("Last Published: " + docu
<a name="Submitting+Patches"></a>
<h2 class="boxed">Submitting Patches</h2>
<div class="section">
-<p>
- Patches are submitted via the <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>.
- Create a new bug, set the subject to [PATCH] followed by a brief description.
- Explain you patch and any special instructions and submit/save it.
+<p>
+ Patches are submitted via the <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>.
+ Create a new bug, set the subject to [PATCH] followed by a brief description.
+ Explain you patch and any special instructions and submit/save it.
Next, go back to the bug, and create attachments for the patch files you
- created. Be sure to describe not only the files purpose, but its format.
+ created. Be sure to describe not only the files purpose, but its format.
(Is that ZIP or a tgz or a bz2 or what?).
</p>
<p>
@@ -355,7 +355,7 @@ document.write("Last Published: " + docu
<p>
A number of Apache projects provide far more comprehensive guides to producing
and submitting patches than we do, you may wish to review some of their
- information if you're unsure. The
+ information if you're unsure. The
<a href="https://commons.apache.org/patches.html">Apache Commons</a> one
is fairly similar as a starting point.
</p>
@@ -375,10 +375,10 @@ document.write("Last Published: " + docu
</div>
</div>
<p>
- This will create a file named <span class="codefrag">patch.tar.gz</span> that will contain a unified diff of files that have been modified
- and also include files that have been added. Review the file for completeness and correctness. This approach
- is recommended because it standardizes the way in which patch files are constructed. It also eliminates the
- chance of you missing to submit new files that constitute part of the patch.
+ This will create a file named <span class="codefrag">patch.tar.gz</span> that will contain a unified diff of files that have been modified
+ and also include files that have been added. Review the file for completeness and correctness. This approach
+ is recommended because it standardizes the way in which patch files are constructed. It also eliminates the
+ chance of you missing to submit new files that constitute part of the patch.
</p>
<p>
To apply a previously generated <span class="codefrag">patch.tar.gz</span> file to a clean subversion checkout, use the following command.
@@ -398,9 +398,9 @@ document.write("Last Published: " + docu
<a name="Approach+2+-+the+manual+way"></a>
<h3 class="boxed">Approach 2 - the manual way</h3>
<p>
- Patches to existing files should be generated with <span class="codefrag">svn diff filename</span> and save the output to a file.
- If you want to get the changes made to multiple files in a directory, just use <span class="codefrag">svn diff</span>.
- then, tar and gzip the patch file as well as any new files that you have added.
+ Patches to existing files should be generated with <span class="codefrag">svn diff filename</span> and save the output to a file.
+ If you want to get the changes made to multiple files in a directory, just use <span class="codefrag">svn diff</span>.
+ then, tar and gzip the patch file as well as any new files that you have added.
</p>
<p>If you use a unix shell, you may find the following following
sequence of commands useful for building the files to attach.</p>
@@ -519,17 +519,17 @@ document.write("Last Published: " + docu
<li>Added code compiles and runs on Java 1.8 and preferably newer versions.</li>
<li>New java files begin with the <a href="https://www.apache.org/foundation/license-faq.html">
- Apache Software License</a> statement.</li>
+ Apache Software License</a> statement.</li>
<li>The code does not depend on code that is unlicensed or
<a href="https://www.apache.org/legal/resolved.html#category-a">incompatibly licensed with ASL 2.0</a>.
- <a href="https://www.apache.org/licenses/GPL-compatibility.html">GPL</a> and LGPL code may not be used.</li>
+ <a href="https://www.apache.org/licenses/GPL-compatibility.html">GPL</a> and LGPL code may not be used.</li>
<li>The code does not include <span class="codefrag">@author</span> tags.</li>
<li>Existing test cases succeed.</li>
-<li>New test cases written and succeed (Use <span class="codefrag">@Ignore</span> from <span class="codefrag">org.junit</span> for in-progress work).</li>
+<li>New test cases written and succeed (Use <span class="codefrag">@Disabled</span> from <span class="codefrag">org.junit</span> for in-progress work).</li>
<li>Documentation page extended as appropriate.</li>
@@ -553,18 +553,18 @@ document.write("Last Published: " + docu
<a name="Code+Style"></a>
<h2 class="boxed">Code Style</h2>
<div class="section">
-<p>The long standing
- <a href="../devel/resolutions/res001.html">Minimal
+<p>The long standing
+ <a href="../devel/resolutions/res001.html">Minimal
Coding Standards</a> from 2002 still largely apply to the project.</p>
<p>When making changes to an existing file, please try to follow the
same style that that file already uses. This will keep things
looking similar, and will prevent patches becoming largely about
- whitespace. Whitespace fixing changes, if needed, should normally be
- in their own commit, so that they don't crowd out coding changes
+ whitespace. Whitespace fixing changes, if needed, should normally be
+ in their own commit, so that they don't crowd out coding changes
in review.</p>
<p>Normally, tabs should not be used to indent code. Instead, spaces
should be used. If starting on a fresh file, please use 4 spaces to
- indent your code. If working on an existing file, please use
+ indent your code. If working on an existing file, please use
whichever of 3 or 4 spaces that file already follows.</p>
<p>Normally, braces should open on the same line as the decision
statement. Braces should normally close on their own line. Brackets
@@ -584,7 +584,7 @@ document.write("Last Published: " + docu
in consistently good patches over a period of several months.</p>
<p>The requirement for "good patches" generally means patches which can be applied
to SVN with little or no changes. These patches should include unit test, and
- appropriate documentation. Whilst your first patch to POI may require quite a
+ appropriate documentation. Whilst your first patch to POI may require quite a
bit of work before it can be committed by an existing committer, with any luck
your later patches will be applied with no / minor tweaks. Please do take note
of any changes required by your earlier patches, to learn for later ones! If
@@ -592,7 +592,7 @@ document.write("Last Published: " + docu
<p>The requirement for patches over several months is to ensure that committers
remain with the project. It's very easy for a good developer to fire off half
a dozen good patches in the couple of weeks that they're working on a POI
- powered project. However, if that developer then moves away, and stops
+ powered project. However, if that developer then moves away, and stops
contributing to POI after that spurt, then they're not a good candidate for
committership. As such, we generally require people to stay around for a while,
submitting patches and helping on the mailing list before considering them
@@ -602,7 +602,7 @@ document.write("Last Published: " + docu
<p>Where possible, the existing developers will try to help and mentor new
contributors. However, everyone involved in POI is a volunteer, and it may
happen that your first few patches come in at a time when all the committers
- are very busy. Do please have patience, and remember to use the
+ are very busy. Do please have patience, and remember to use the
<a href="../help/index.html">dev mailing list</a> so that other
contributors can assist you!</p>
<p>For more information on getting started at Apache, mentoring, and local
@@ -620,7 +620,7 @@ document.write("Last Published: " + docu
<h3 class="boxed">Publicly Available Information on the file formats</h3>
<p>
In early 2008, Microsoft made a fairly complete set of documentation
- on the binary file formats freely and publicly available. These were
+ on the binary file formats freely and publicly available. These were
released under the <a href="https://msdn.microsoft.com/en-us/openspecifications/default">
Open Specification Promise</a>, which does allow us to use them for
building open source software under the <a href="https://www.apache.org/foundation/license-FAQ.html">
@@ -628,7 +628,7 @@ document.write("Last Published: " + docu
</p>
<p>
You can download the documentation on Excel, Word, PowerPoint and
- Escher (drawing) from
+ Escher (drawing) from
<a href="https://msdn.microsoft.com/en-us/library/cc313118.aspx">http://msdn.microsoft.com/en-us/library/cc313118.aspx</a>.
Documentation on a few of the supporting technologies used in these
file formats can be downloaded from
@@ -650,11 +650,11 @@ document.write("Last Published: " + docu
</p>
<p>
The newer Office Open XML (ooxml) file formats are documented as part
- of the ECMA / ISO standardisation effort for the formats. This
+ of the ECMA / ISO standardisation effort for the formats. This
documentation is quite large, but you can normally find the bit you
need without too much effort! This can be downloaded from
<a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a>,
- and is also under the
+ and is also under the
<a href="https://msdn.microsoft.com/en-us/openspecifications/default">OSP</a>.
</p>
<p>
@@ -674,24 +674,24 @@ document.write("Last Published: " + docu
in POI is done strictly by using public information. Most of this Public
Information currently comes from the documentation that Microsoft
makes freely available (see above). The rest of the public information
- includes sources from other open source projects, books that state the
- purpose intended is for allowing implementation of the file format and
- do not require any non-disclosure agreement and just hard work.
- We are intent on keeping it legal, by contributing patches you agree to
+ includes sources from other open source projects, books that state the
+ purpose intended is for allowing implementation of the file format and
+ do not require any non-disclosure agreement and just hard work.
+ We are intent on keeping it legal, by contributing patches you agree to
do the same.
</p>
-<p>
+<p>
If you've ever received information regarding the OLE 2 Compound Document
- Format under any type of exclusionary agreement from Microsoft, or
- received such information from a person bound by such an agreement, you
- cannot participate in this project. Sorry. Well, unless you can persuade
+ Format under any type of exclusionary agreement from Microsoft, or
+ received such information from a person bound by such an agreement, you
+ cannot participate in this project. Sorry. Well, unless you can persuade
Microsoft to release you from the terms of the NDA on the grounds that
most of the information is now publicly available. However, if you have
been party to a Microsoft NDA, you will need to get clearance from Microsoft
before contributing.
</p>
<p>
- Those submitting patches that show insight into the file format may be
+ Those submitting patches that show insight into the file format may be
asked to state explicitly that they have only ever read the publicly
available file format information, and not any received under an NDA
or similar, and have only made us of the public documentation.
Modified: poi/site/publish/devel/subversion.html
URL: http://svn.apache.org/viewvc/poi/site/publish/devel/subversion.html?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/publish/devel/subversion.html (original)
+++ poi/site/publish/devel/subversion.html Sat Jan 23 08:59:52 2021
@@ -426,7 +426,7 @@ document.write("Last Published: " + docu
<span class="lineno"></span><span class="codebody"></span>
</div>
<div class="codeline">
-<span class="lineno"></span><span class="codebody">git co master</span>
+<span class="lineno"></span><span class="codebody">git checkout master</span>
</div>
<div class="codeline">
<span class="lineno"></span><span class="codebody">git cherry-pick commitid ...</span>
Modified: poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml (original)
+++ poi/site/src/documentation/content/xdocs/components/spreadsheet/quick-guide.xml Sat Jan 23 08:59:52 2021
@@ -1649,7 +1649,7 @@ Examples:
cell = sheet.createRow(0).createCell(0);
cell.setCellValue("URL Link");
- Hyperlink link = createHelper.createHyperlink(Hyperlink.LINK_URL);
+ Hyperlink link = createHelper.createHyperlink(HyperlinkType.URL);
link.setAddress("https://poi.apache.org/");
cell.setHyperlink(link);
cell.setCellStyle(hlink_style);
@@ -1657,7 +1657,7 @@ Examples:
//link to a file in the current directory
cell = sheet.createRow(1).createCell(0);
cell.setCellValue("File Link");
- link = createHelper.createHyperlink(Hyperlink.LINK_FILE);
+ link = createHelper.createHyperlink(HyperlinkType.FILE);
link.setAddress("link1.xls");
cell.setHyperlink(link);
cell.setCellStyle(hlink_style);
@@ -1665,7 +1665,7 @@ Examples:
//e-mail link
cell = sheet.createRow(2).createCell(0);
cell.setCellValue("Email Link");
- link = createHelper.createHyperlink(Hyperlink.LINK_EMAIL);
+ link = createHelper.createHyperlink(HyperlinkType.EMAIL);
//note, if subject contains white spaces, make sure they are url-encoded
link.setAddress("mailto:poi@apache.org?subject=Hyperlinks");
cell.setHyperlink(link);
@@ -1679,7 +1679,7 @@ Examples:
cell = sheet.createRow(3).createCell(0);
cell.setCellValue("Worksheet Link");
- Hyperlink link2 = createHelper.createHyperlink(Hyperlink.LINK_DOCUMENT);
+ Hyperlink link2 = createHelper.createHyperlink(HyperlinkType.DOCUMENT);
link2.setAddress("'Target Sheet'!A1");
cell.setHyperlink(link2);
cell.setCellStyle(hlink_style);
Modified: poi/site/src/documentation/content/xdocs/devel/guidelines.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/devel/guidelines.xml?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/devel/guidelines.xml (original)
+++ poi/site/src/documentation/content/xdocs/devel/guidelines.xml Sat Jan 23 08:59:52 2021
@@ -23,8 +23,8 @@
<header>
<title>Apache POI - Contribution Guidelines</title>
<authors>
- <person name="Nick Burch" email="dev@poi.apache.org"/>
- <person name="David Fisher" email="dev@poi.apache.org"/>
+ <person name="Nick Burch" email="dev@poi.apache.org"/>
+ <person name="David Fisher" email="dev@poi.apache.org"/>
</authors>
</header>
@@ -47,23 +47,23 @@
<section><title>Disclaimer</title>
<p>
- Any information in here that might be perceived as legal information is
+ Any information in here that might be perceived as legal information is
informational only. We're not lawyers, so consult a legal professional
- if needed.
+ if needed.
</p>
</section>
<section><title>The Licensing</title>
<p>
The POI project is <a href="http://www.opensource.org">OpenSource</a>
- and developed/distributed under the <a
+ and developed/distributed under the <a
href="https://www.apache.org/foundation/license-faq.html">
- Apache Software License v2</a>. Unlike some other licenses, the Apache
+ Apache Software License v2</a>. Unlike some other licenses, the Apache
license allows free open source development. Unlike some other Open Source
- licenses, it does not require you to release your source or use any
- particular license for your code which builds on top of it. (There are a
+ licenses, it does not require you to release your source or use any
+ particular license for your code which builds on top of it. (There are a
handful of restrictions, especially around attribution, notices and trademarks,
- so it's worth a read of the license - it isn't scary!). If you wish to
+ so it's worth a read of the license - it isn't scary!). If you wish to
contribute to Apache POI (which you're very welcome and encouraged to do so),
then you must agree to grant your contributions to us under the same license.
</p>
@@ -74,8 +74,8 @@
<section><title>Where is help needed on the project?</title>
<p id="helpwanted"/>
<p>Please note - only some of the areas where help is needed have been listed
- in the <a href="https://helpwanted.apache.org/">Apache "Help Wanted!" tool</a>,
- many others remain only in Bugzilla or listed as TODOs in the code. Please see
+ in the <a href="https://helpwanted.apache.org/">Apache "Help Wanted!" tool</a>,
+ many others remain only in Bugzilla or listed as TODOs in the code. Please see
the section below for more on these.</p>
</section>
@@ -104,9 +104,9 @@
<li>Add in new features, see <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug database</a> for suggestions.</li>
</ul>
- <p>The Apache <a href="http://www.apache.org/dev/contributors.html">Contributors Tech Guide</a> gives a good overview how to start contributing patches.</p>
+ <p>The Apache <a href="http://www.apache.org/dev/contributors.html">Contributors Tech Guide</a> gives a good overview how to start contributing patches.</p>
- <p>The Nutch project also have a very useful guide on becoming a
+ <p>The Nutch project also have a very useful guide on becoming a
new developer in their project. While it is written for their project,
a large part of it will apply to POI too. You can read it at
<a href="https://wiki.apache.org/nutch/Becoming_A_Nutch_Developer">http://wiki.apache.org/nutch/Becoming_A_Nutch_Developer</a>. The
@@ -116,12 +116,12 @@
<anchor id="SubmittingPatches"/>
<section><title>Submitting Patches</title>
- <p>
- Patches are submitted via the <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>.
- Create a new bug, set the subject to [PATCH] followed by a brief description.
- Explain you patch and any special instructions and submit/save it.
+ <p>
+ Patches are submitted via the <a href="https://issues.apache.org/bugzilla/buglist.cgi?product=POI">Bug Database</a>.
+ Create a new bug, set the subject to [PATCH] followed by a brief description.
+ Explain you patch and any special instructions and submit/save it.
Next, go back to the bug, and create attachments for the patch files you
- created. Be sure to describe not only the files purpose, but its format.
+ created. Be sure to describe not only the files purpose, but its format.
(Is that ZIP or a tgz or a bz2 or what?).
</p>
<p>
@@ -140,7 +140,7 @@
<p>
A number of Apache projects provide far more comprehensive guides to producing
and submitting patches than we do, you may wish to review some of their
- information if you're unsure. The
+ information if you're unsure. The
<a href="https://commons.apache.org/patches.html">Apache Commons</a> one
is fairly similar as a starting point.
</p>
@@ -151,10 +151,10 @@
ant -f patch.xml
</source>
<p>
- This will create a file named <code>patch.tar.gz</code> that will contain a unified diff of files that have been modified
- and also include files that have been added. Review the file for completeness and correctness. This approach
- is recommended because it standardizes the way in which patch files are constructed. It also eliminates the
- chance of you missing to submit new files that constitute part of the patch.
+ This will create a file named <code>patch.tar.gz</code> that will contain a unified diff of files that have been modified
+ and also include files that have been added. Review the file for completeness and correctness. This approach
+ is recommended because it standardizes the way in which patch files are constructed. It also eliminates the
+ chance of you missing to submit new files that constitute part of the patch.
</p>
<p>
To apply a previously generated <code>patch.tar.gz</code> file to a clean subversion checkout, use the following command.
@@ -166,9 +166,9 @@
</section>
<section><title>Approach 2 - the manual way</title>
<p>
- Patches to existing files should be generated with <code>svn diff filename</code> and save the output to a file.
- If you want to get the changes made to multiple files in a directory, just use <code>svn diff</code>.
- then, tar and gzip the patch file as well as any new files that you have added.
+ Patches to existing files should be generated with <code>svn diff filename</code> and save the output to a file.
+ If you want to get the changes made to multiple files in a directory, just use <code>svn diff</code>.
+ then, tar and gzip the patch file as well as any new files that you have added.
</p>
<p>If you use a unix shell, you may find the following following
sequence of commands useful for building the files to attach.</p>
@@ -232,13 +232,13 @@
<li>Added code complies with <a href="#CodeStyle">coding standards</a>.</li>
<li>Added code compiles and runs on Java 1.8 and preferably newer versions.</li>
<li>New java files begin with the <a href="https://www.apache.org/foundation/license-faq.html">
- Apache Software License</a> statement.</li>
+ Apache Software License</a> statement.</li>
<li>The code does not depend on code that is unlicensed or
<a href="https://www.apache.org/legal/resolved.html#category-a">incompatibly licensed with ASL 2.0</a>.
- <a href="https://www.apache.org/licenses/GPL-compatibility.html">GPL</a> and LGPL code may not be used.</li>
+ <a href="https://www.apache.org/licenses/GPL-compatibility.html">GPL</a> and LGPL code may not be used.</li>
<li>The code does not include <code>@author</code> tags.</li>
<li>Existing test cases succeed.</li>
- <li>New test cases written and succeed (Use <code>@Ignore</code> from <code>org.junit</code> for in-progress work).</li>
+ <li>New test cases written and succeed (Use <code>@Disabled</code> from <code>org.junit</code> for in-progress work).</li>
<li>Documentation page extended as appropriate.</li>
<li>Examples updated or added as appropriate.</li>
<li>Diff files generated using <code>svn diff</code>.</li>
@@ -246,24 +246,24 @@
<li>The <a href="https://bz.apache.org/bugzilla/describecomponents.cgi?product=POI">bugzilla</a> subject dev contains [PATCH], task name and patch reason in subject.</li>
<li>The bugzilla description contains a rationale for the patch.</li>
<li>Attachment to the bugzilla entry contains the patch file.</li>
- </ul>
+ </ul>
</section>
</section>
<anchor id="CodeStyle"/>
<section><title>Code Style</title>
- <p>The long standing
- <a href="site:res001">Minimal
+ <p>The long standing
+ <a href="site:res001">Minimal
Coding Standards</a> from 2002 still largely apply to the project.</p>
<p>When making changes to an existing file, please try to follow the
same style that that file already uses. This will keep things
looking similar, and will prevent patches becoming largely about
- whitespace. Whitespace fixing changes, if needed, should normally be
- in their own commit, so that they don't crowd out coding changes
+ whitespace. Whitespace fixing changes, if needed, should normally be
+ in their own commit, so that they don't crowd out coding changes
in review.</p>
<p>Normally, tabs should not be used to indent code. Instead, spaces
should be used. If starting on a fresh file, please use 4 spaces to
- indent your code. If working on an existing file, please use
+ indent your code. If working on an existing file, please use
whichever of 3 or 4 spaces that file already follows.</p>
<p>Normally, braces should open on the same line as the decision
statement. Braces should normally close on their own line. Brackets
@@ -280,7 +280,7 @@
in consistently good patches over a period of several months.</p>
<p>The requirement for "good patches" generally means patches which can be applied
to SVN with little or no changes. These patches should include unit test, and
- appropriate documentation. Whilst your first patch to POI may require quite a
+ appropriate documentation. Whilst your first patch to POI may require quite a
bit of work before it can be committed by an existing committer, with any luck
your later patches will be applied with no / minor tweaks. Please do take note
of any changes required by your earlier patches, to learn for later ones! If
@@ -288,7 +288,7 @@
<p>The requirement for patches over several months is to ensure that committers
remain with the project. It's very easy for a good developer to fire off half
a dozen good patches in the couple of weeks that they're working on a POI
- powered project. However, if that developer then moves away, and stops
+ powered project. However, if that developer then moves away, and stops
contributing to POI after that spurt, then they're not a good candidate for
committership. As such, we generally require people to stay around for a while,
submitting patches and helping on the mailing list before considering them
@@ -299,7 +299,7 @@
<p>Where possible, the existing developers will try to help and mentor new
contributors. However, everyone involved in POI is a volunteer, and it may
happen that your first few patches come in at a time when all the committers
- are very busy. Do please have patience, and remember to use the
+ are very busy. Do please have patience, and remember to use the
<a href="site:mailinglists">dev mailing list</a> so that other
contributors can assist you!</p>
<p>For more information on getting started at Apache, mentoring, and local
@@ -313,16 +313,16 @@
<section><title>Publicly Available Information on the file formats</title>
<p>
In early 2008, Microsoft made a fairly complete set of documentation
- on the binary file formats freely and publicly available. These were
+ on the binary file formats freely and publicly available. These were
released under the <a href="https://msdn.microsoft.com/en-us/openspecifications/default">
Open Specification Promise</a>, which does allow us to use them for
- building open source software under the <a
+ building open source software under the <a
href="https://www.apache.org/foundation/license-FAQ.html">
Apache Software License</a>.
</p>
<p>
You can download the documentation on Excel, Word, PowerPoint and
- Escher (drawing) from
+ Escher (drawing) from
<a href="https://msdn.microsoft.com/en-us/library/cc313118.aspx">http://msdn.microsoft.com/en-us/library/cc313118.aspx</a>.
Documentation on a few of the supporting technologies used in these
file formats can be downloaded from
@@ -344,11 +344,11 @@
</p>
<p>
The newer Office Open XML (ooxml) file formats are documented as part
- of the ECMA / ISO standardisation effort for the formats. This
+ of the ECMA / ISO standardisation effort for the formats. This
documentation is quite large, but you can normally find the bit you
need without too much effort! This can be downloaded from
<a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a>,
- and is also under the
+ and is also under the
<a href="https://msdn.microsoft.com/en-us/openspecifications/default">OSP</a>.
</p>
<p>
@@ -368,24 +368,24 @@
in POI is done strictly by using public information. Most of this Public
Information currently comes from the documentation that Microsoft
makes freely available (see above). The rest of the public information
- includes sources from other open source projects, books that state the
- purpose intended is for allowing implementation of the file format and
- do not require any non-disclosure agreement and just hard work.
- We are intent on keeping it legal, by contributing patches you agree to
+ includes sources from other open source projects, books that state the
+ purpose intended is for allowing implementation of the file format and
+ do not require any non-disclosure agreement and just hard work.
+ We are intent on keeping it legal, by contributing patches you agree to
do the same.
</p>
- <p>
+ <p>
If you've ever received information regarding the OLE 2 Compound Document
- Format under any type of exclusionary agreement from Microsoft, or
- received such information from a person bound by such an agreement, you
- cannot participate in this project. Sorry. Well, unless you can persuade
+ Format under any type of exclusionary agreement from Microsoft, or
+ received such information from a person bound by such an agreement, you
+ cannot participate in this project. Sorry. Well, unless you can persuade
Microsoft to release you from the terms of the NDA on the grounds that
most of the information is now publicly available. However, if you have
been party to a Microsoft NDA, you will need to get clearance from Microsoft
before contributing.
</p>
<p>
- Those submitting patches that show insight into the file format may be
+ Those submitting patches that show insight into the file format may be
asked to state explicitly that they have only ever read the publicly
available file format information, and not any received under an NDA
or similar, and have only made us of the public documentation.
@@ -398,7 +398,7 @@
<legal>
Copyright (c) @year@ The Apache Software Foundation. All rights reserved.
<br />
- Apache POI, POI, Apache, the Apache feather logo, and the Apache
+ Apache POI, POI, Apache, the Apache feather logo, and the Apache
POI project logo are trademarks of The Apache Software Foundation.
</legal>
</footer>
Modified: poi/site/src/documentation/content/xdocs/devel/subversion.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/devel/subversion.xml?rev=1885840&r1=1885839&r2=1885840&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/devel/subversion.xml (original)
+++ poi/site/src/documentation/content/xdocs/devel/subversion.xml Sat Jan 23 08:59:52 2021
@@ -199,7 +199,7 @@
When things are ready in the workbranch do a
</p>
<source>
- git co master
+ git checkout master
git cherry-pick commitid ...
</source>
<p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org