You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2022/07/15 15:15:20 UTC
[commons-vfs] branch master updated: Fix typos in project documentations (#275)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push:
new 8afa5405 Fix typos in project documentations (#275)
8afa5405 is described below
commit 8afa5405da811850a0f8196709c552ae24554e6d
Author: Marc Wrobel <ma...@gmail.com>
AuthorDate: Fri Jul 15 17:15:15 2022 +0200
Fix typos in project documentations (#275)
---
RELEASE-NOTES.txt | 14 +++++++-------
src/changes/changes.xml | 22 +++++++++++-----------
src/site/xdoc/anttasks.xml | 8 ++++----
src/site/xdoc/api.xml | 12 ++++++------
src/site/xdoc/filesystems.xml | 2 +-
src/site/xdoc/index.xml | 2 +-
src/site/xdoc/mail-lists.xml | 2 +-
src/site/xdoc/testing.xml | 2 +-
8 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index a8ddf543..22daf834 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -56,7 +56,7 @@ o Bump Maven Surefire from 2.19.1 to 3.0.0-M5. Thanks to Gary Gregory.
o Bump net.sourceforge.pmd:pmd-* from 6.32.0 to 6.33.0.
o Bump checkstyle from 8.41 to 8.44 #175. Thanks to Dependabot, Gary Gregory.
o Bump actions/setup-java to v2 #177. Thanks to Boris Petrov.
-o Bump mockito-core from 3.8.0 to 3.11.2 #178. Thanks to Dependabot, Gary GRegory.
+o Bump mockito-core from 3.8.0 to 3.11.2 #178. Thanks to Dependabot, Gary Gregory.
o Bump commons-io from 2.8.0 to 2.10.0. Thanks to Gary Gregory.
o Bump actions/cache from 2.1.4 to 2.1.6 #183. Thanks to Dependabot.
o Bump jackrabbit2.version from 2.21.5 to 2.21.6 #180. Thanks to Dependabot.
@@ -586,7 +586,7 @@ o VFS-252: [SMB] SmbFileObject does not support setLastModifiedTime while jcifs
o VFS-313: [FTP] Configuration does not include option for setting socket timeout. Thanks to bdavis@saintandreas.org.
o VFS-414: [FTP] Add config API to set the file type.
o VFS-182: [FTP] Usage of FTP with heterogeneous FTP server (possibility of using Ascii file type).
-o VFS-381: Iterate over a FileObject using the Java "foreach" statement, to provide all descendents of a FileObject.
+o VFS-381: Iterate over a FileObject using the Java "foreach" statement, to provide all descendants of a FileObject.
o VFS-373: Add FileContent write APIs.
o VFS-372: Add constructors FileDepthSelector() and FileDepthSelector(int).
o VFS-371: Add FileObject API deleteAll().
@@ -598,10 +598,10 @@ o VFS-424: Fix StandardFileSystemManager class loading so it works in a OSGi en
o VFS-490: [vfsclassloader] Do not open folders with .jar extension. Adds tests.
o VFS-582: [tests] revert rename of getTestDirectoryFile to make test classes more compatible for external providers.
o VFS-480: Make startup of SoftRefsFileCache cleaner thread work and less racy to avoid leaks.
-o VFS-549: Use File.seperator instead of getProperty("file.separator").
+o VFS-549: Use File.separator instead of getProperty("file.separator").
o VFS-567: [ftp] Ignore exceptions while QUIT/disconnect. Thanks to Antonio Petrelli.
o VFS-572: [sftp] better documentation for knownhosts file option. Thanks to Sandra Parsick.
-o VFS-574: Ensure FileOpertionProviders are closed. Adds some testcases.
+o VFS-574: Ensure FileOperationProviders are closed. Adds some testcases.
The error code for missing operations exceptions corrected: vfs.operation/operation-not-supported.error
o VFS-279: [local] Avoid ClassCastException when replicating local files while OnCall caching is active. Thanks to Didier Earith, Simon Legner.
o VFS-297: [sftp] VSF fails to reuse FileSystem instances if FileSystemOptions contain
@@ -707,13 +707,13 @@ o VFS-283: [SFTP] SFTP provider did not support passphrase-protected keys nor t
keys only, a new structure EntityInfo has been created. SftpFileSystemConfigBuilder has now the new
getter and setter methods getIdentityInfo and setIdentity info which replace the now deprecated methods
getIdentities and setIdentities.
-o VFS-463: FileSytemConfigBuilder supports system properties for the value of enum-based configuration entries.
+o VFS-463: FileSystemConfigBuilder supports system properties for the value of enum-based configuration entries.
o VFS-462: [FTPS] Deprecate FtpsFileSystemConfigBuilder.setFtpsType and FtpsFileSystemConfigBuilder.getFtpsType
in favor of FtpsFileSystemConfigBuilder.setFtpsMode and FtpsFileSystemConfigBuilder.getFtpsMode which
use new enum FtpsMode instead.
o VFS-459: [FTP/FTPS] Sent commands and the received answer is logged at debug level.
o VFS-457: Update test dependencies: sshd-core version 0.7.0 to 0.8.0; mina-core 2.0.4 to 2.0.7; junit 4.11 to 4.12; slf4j-* 1.5.5 to 1.5.11
-o VFS-456: Use org.bouncycastel:bcprov-jdk16 instead of org.bouncycastle:bcprof-jdk15on since Java 1.6 is required.
+o VFS-456: Use org.bouncycastle:bcprov-jdk16 instead of org.bouncycastle:bcprof-jdk15on since Java 1.6 is required.
o VFS-415: Update VFS requirement to Java 1.6.
o VFS-418: Update to Apache Commons Compress 1.4.1.
o VFS-321: AbstractFileObject sometimes uses getFileSystem() and sometimes references "fs" field directly. Thanks to sebb.
@@ -754,4 +754,4 @@ Visit http://commons.apache.org/proper/commons-vfs/
Download it from http://commons.apache.org/proper/commons-vfs/download_vfs.cgi
------------------------------------------------------------------------------
\ No newline at end of file
+-----------------------------------------------------------------------------
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 86c1b9c6..1f8c5172 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -129,7 +129,7 @@ The <action> type attribute can be add,update,fix,remove.
<action type="add" dev="ggregory">
Add github/codeql-action.
</action>
- <!-- UDPATE -->
+ <!-- UPDATE -->
<action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">
Bump actions/cache from 2.1.6 to 3.0.5 #221, #249.
</action>
@@ -237,7 +237,7 @@ The <action> type attribute can be add,update,fix,remove.
Minor changes #185.
</action>
<action type="fix" dev="ggregory" due-to="Gary Gregory">
- Port internal embedded HTTP asynchronous file server used in tests from from Apache HttpComponents HttpCore/HttpClient 4.x to 5.0.x.
+ Port internal embedded HTTP asynchronous file server used in tests from Apache HttpComponents HttpCore/HttpClient 4.x to 5.0.x.
</action>
<action type="fix" dev="ggregory" due-to="Arturo Bernal">
Replace construction of FileInputStream and FileOutputStream objects with Files NIO APIs. #164.
@@ -286,7 +286,7 @@ The <action> type attribute can be add,update,fix,remove.
SftpFileObject: Add synchronized to methods that read or write the thread-unsafe instance variable of type com.jcraft.jsch.SftpATTRS.
</action>
<action type="fix" issue="VFS-759" dev="ggregory" due-to="Woonsan Ko">
- WebDAV providers should loaded only when commons-vfs2-jackrabbit* jars are available #84
+ WebDAV providers should be loaded only when commons-vfs2-jackrabbit* jars are available #84
</action>
<action type="fix" dev="ggregory" due-to="Arturo Bernal">
Simplify conditions and avoid extra checks #187.
@@ -310,7 +310,7 @@ The <action> type attribute can be add,update,fix,remove.
<action dev="ggregory" due-to="Boris Petrov" type="update">
Bump actions/setup-java to v2 #177.
</action>
- <action dev="ggregory" due-to="Dependabot, Gary GRegory" type="update">
+ <action dev="ggregory" due-to="Dependabot, Gary Gregory" type="update">
Bump mockito-core from 3.8.0 to 3.11.2 #178.
</action>
<action dev="ggregory" due-to="Gary Gregory, Dependabot" type="update">
@@ -605,7 +605,7 @@ The <action> type attribute can be add,update,fix,remove.
Remove workaround for JDK BUG: 6192331 which was fixed way back in Java 6: https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6192331
</action>
<action dev="ggregory" due-to="Gary Gregory" type="fix">
- FileObject.getURL() returns an illegal URL when a it should escape a space.
+ FileObject.getURL() returns an illegal URL when it should escape a space.
</action>
<action dev="ggregory" due-to="Gary Gregory" type="add">
Add FileObject.getURI().
@@ -1086,7 +1086,7 @@ Therefore source and binary compatibility is not affected.">
Make startup of SoftRefsFileCache cleaner thread work and less racy to avoid leaks.
</action>
<action issue="VFS-549" dev="ecki" type="fix">
- Use File.seperator instead of getProperty("file.separator").
+ Use File.separator instead of getProperty("file.separator").
</action>
<action issue="VFS-567" dev="ecki" type="fix" due-to="Antonio Petrelli">
[ftp] Ignore exceptions while QUIT/disconnect.
@@ -1095,7 +1095,7 @@ Therefore source and binary compatibility is not affected.">
[sftp] better documentation for knownhosts file option.
</action>
<action issue="VFS-574" dev="ecki" type="fix">
- Ensure FileOpertionProviders are closed. Adds some testcases.
+ Ensure FileOperationProviders are closed. Adds some testcases.
The error code for missing operations exceptions corrected: vfs.operation/operation-not-supported.error
</action>
<action issue="VFS-279" dev="ecki" type="fix" due-to="Didier Earith, Simon Legner">
@@ -1287,7 +1287,7 @@ Therefore source and binary compatibility is not affected.">
StaticUserAuthenticator should return only requested authentication data.
</action>
<action issue="VFS-463" dev="joehni" type="update">
- FileSytemConfigBuilder supports system properties for the value of enum-based configuration entries.
+ FileSystemConfigBuilder supports system properties for the value of enum-based configuration entries.
</action>
<action issue="VFS-462" dev="joehni" type="update">
[FTPS] Deprecate FtpsFileSystemConfigBuilder.setFtpsType and FtpsFileSystemConfigBuilder.getFtpsType
@@ -1368,7 +1368,7 @@ Therefore source and binary compatibility is not affected.">
Update test dependencies: sshd-core version 0.7.0 to 0.8.0; mina-core 2.0.4 to 2.0.7; junit 4.11 to 4.12; slf4j-* 1.5.5 to 1.5.11
</action>
<action issue="VFS-456" dev="joehni" type="update">
- Use org.bouncycastel:bcprov-jdk16 instead of org.bouncycastle:bcprof-jdk15on since Java 1.6 is required.
+ Use org.bouncycastle:bcprov-jdk16 instead of org.bouncycastle:bcprof-jdk15on since Java 1.6 is required.
</action>
<action issue="VFS-415" dev="ggregory" type="update">
Update VFS requirement to Java 1.6.
@@ -1494,7 +1494,7 @@ Therefore source and binary compatibility is not affected.">
SFTP getChildren() does not fail when called on a file.
</action>
<action issue="VFS-381" dev="ggregory" type="add">
- Iterate over a FileObject using the Java "foreach" statement, to provide all descendents of a FileObject.
+ Iterate over a FileObject using the Java "foreach" statement, to provide all descendants of a FileObject.
</action>
<action issue="VFS-380" dev="ggregory" type="fix">
FTP connect.error message used instead of SFTP connect.error message.
@@ -1568,7 +1568,7 @@ Therefore source and binary compatibility is not affected.">
Update the version of commons-net.
</action>
<action issue="VFS-230" dev="rgoers" type="fix">
- Documented FileSystem capabilities on the web site.
+ Documented FileSystem capabilities on the website.
</action>
<action issue="VFS-337" dev="rgoers" type="fix">
AbstractFileObject and classes that extend from it use AbstractFileName in the constructor and in
diff --git a/src/site/xdoc/anttasks.xml b/src/site/xdoc/anttasks.xml
index 4d1534f9..6c559a5a 100644
--- a/src/site/xdoc/anttasks.xml
+++ b/src/site/xdoc/anttasks.xml
@@ -82,7 +82,7 @@
dependencies into the
<code>$ANT_HOME/lib</code>
directory,
- and use the following in your Ant scipt to define the tasks:
+ and use the following in your Ant script to define the tasks:
</p>
<source><![CDATA[
@@ -143,7 +143,7 @@
</tr>
<tr>
<td>srcdir</td>
- <td>The source folder. If used the includes and desdir
+ <td>The source folder. If used the includes and destdir
attributes should be specified.</td>
<td>No</td>
</tr>
@@ -184,7 +184,7 @@
</tr>
<tr>
<td>src</td>
- <td>A source file or folder to copy. Copies all descendents
+ <td>A source file or folder to copy. Copies all descendants
of a folder.</td>
<td>No</td>
</tr>
@@ -252,7 +252,7 @@
</tr>
<tr>
<td>file</td>
- <td>The file or folder to delete. All descendents of
+ <td>The file or folder to delete. All descendants of
the folder are deleted.</td>
<td rowspan="2">One only</td>
</tr>
diff --git a/src/site/xdoc/api.xml b/src/site/xdoc/api.xml
index 42b659e3..3e614ec1 100644
--- a/src/site/xdoc/api.xml
+++ b/src/site/xdoc/api.xml
@@ -68,7 +68,7 @@ for (int i = 0; i < children.length; i++) {
}]]></source>
<p>
- In some cases you might want to explicitely free resources allocated by the filesystem.
+ In some cases you might want to explicitly free resources allocated by the filesystem.
You can do this by calling
<a href="commons-vfs2/apidocs/org/apache/commons/vfs2/FileSystemManager.html#closeFileSystem">VFS.getManager().closeFileSystem(fs)</a>.
If you use VFS as singleton (as described above) you should take care that this will close the filesystem for
@@ -92,8 +92,8 @@ for (int i = 0; i < children.length; i++) {
it will be released.
</p>
<p>
- There is also a internal cache of each file object avoid the need to access the network layer. Now its possible
- to configure this behviour through the use of <a href="commons-vfs2/apidocs/org/apache/commons/vfs2/CacheStrategy.html">CacheStrategy</a>.
+ There is also an internal cache of each file object avoid the need to access the network layer. Now it's possible
+ to configure this behaviour through the use of <a href="commons-vfs2/apidocs/org/apache/commons/vfs2/CacheStrategy.html">CacheStrategy</a>.
<br />
Do this on the DefaultFileSystemManager. For example:
<code>
@@ -124,7 +124,7 @@ FileObject fo = VFS.getManager().resolveFile("smb://host/anyshare/dir", opts);]]
Internally the UserAuthenticator uses char arrays which will be zeroed before it is
freed for garbage collection.Unhappily none of the current libraries use char
arrays and so VFS has to create a string. Thus, the main advantage
- of this solution - security - is lost, but hey, thats not VFS fault ;-)
+ of this solution - security - is lost, but hey, that's not VFS fault ;-)
</p>
<p>
VFS calls <code>UserAuthenticator.requestAuthentication</code> each time it
@@ -164,12 +164,12 @@ FileObject fo = VFS.getManager().resolveFile("smb://host/anyshare/dir", opts);]]
If such a file is found Commons VFS uses it in <u>addition</u> to the default providers.xml.
This allows you to start using a new filesystem by simply drop its implementation into the classpath.
The configuration file format is described below.<br />
- <b>Notice:</b> Currently it is not allowed to override a already configured filesystem. Commons VFS throws
+ <b>Notice:</b> Currently it is not allowed to override an already configured filesystem. Commons VFS throws
an exception if there is already a filesystem for a scheme.
</p>
<p>
- To configure Commons VFS programatically, you can create an
+ To configure Commons VFS programmatically, you can create an
instance of
<a href="commons-vfs2/apidocs/org/apache/commons/vfs2/impl/DefaultFileSystemManager.html">DefaultFileSystemManager</a>
and configure it manually. The default constructor
diff --git a/src/site/xdoc/filesystems.xml b/src/site/xdoc/filesystems.xml
index 6bb8c34f..e429adcf 100644
--- a/src/site/xdoc/filesystems.xml
+++ b/src/site/xdoc/filesystems.xml
@@ -762,7 +762,7 @@
<section name="Resource">
<p>
- This is not really a filesystem, it just tries to lookup a resource using javas <code>ClassLoader.getResource()</code>
+ This is not really a filesystem, it just tries to look up a resource using javas <code>ClassLoader.getResource()</code>
and creates a VFS url for further processing.
</p>
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 708e4489..3b5a6715 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -154,7 +154,7 @@
</p>
<p>
Apache Commons VFS 2.0 adds support for FTPS and WebDav have been added in addition to many bugs
- being fixed. Version 2.0 is not binary compatible with version 1.0. To insure that both 1.0 and 2.0 can
+ being fixed. Version 2.0 is not binary compatible with version 1.0. To ensure that both 1.0 and 2.0 can
coexist version 2.0 has had its Maven groupId changed to org.apache.commons, its Maven artifact changed
to commons-vfs2, and the package names are now org.apache.commons.vfs2. The API changes are fairly minor
and will mostly impact provider implementations.
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index cedd3af9..cabb264e 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -158,7 +158,7 @@ limitations under the License.
<td>
<strong>Commons Commits List</strong>
<br /><br />
- Only for e-mails automatically generated by the <a href="scm.html">source control</a> sytem.
+ Only for e-mails automatically generated by the <a href="scm.html">source control</a> system.
<br /><br />
</td>
<td><a href="mailto:commits-subscribe@commons.apache.org">Subscribe</a></td>
diff --git a/src/site/xdoc/testing.xml b/src/site/xdoc/testing.xml
index 3903a5db..7b45cd7a 100644
--- a/src/site/xdoc/testing.xml
+++ b/src/site/xdoc/testing.xml
@@ -26,7 +26,7 @@
Apache Commons VFS comes with a suite of (nearly 2000) tests (in <code>core/src/test</code>). The JUnit framework
is used, and executed at build time via the Maven
<a href="http://maven.apache.org/surefire/maven-surefire-plugin/">Surefire plugin</a> by the <code>mvn test</code> goal.
- It you plan to contribute a patch for a bug or feature, make sure to also provide a test
+ If you plan to contribute a patch for a bug or feature, make sure to also provide a test
which can reproduce the bug or exercise the new feature. Also run the whole test suite against the patched code.
</p>
<p>