You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2022/01/15 21:31:23 UTC
[logging-log4j2] branch master updated: Javadoc typos, "posix" is an acronym -> POSIX.
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/logging-log4j2.git
The following commit(s) were added to refs/heads/master by this push:
new 7bb1e70 Javadoc typos, "posix" is an acronym -> POSIX.
7bb1e70 is described below
commit 7bb1e70e843d26551f1a7598a0bfc6462bab4a25
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jan 15 16:28:13 2022 -0500
Javadoc typos, "posix" is an acronym -> POSIX.
---
.../logging/log4j/core/appender/FileManager.java | 8 ++++----
.../appender/rolling/DefaultRolloverStrategy.java | 2 +-
.../rolling/DirectWriteRolloverStrategy.java | 2 +-
.../rolling/action/PosixViewAttributeAction.java | 20 ++++++++++----------
.../apache/logging/log4j/core/util/FileUtils.java | 6 +++---
5 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FileManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FileManager.java
index a377836..0a673e5 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FileManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/FileManager.java
@@ -269,9 +269,9 @@ public class FileManager extends OutputStreamManager {
}
/**
- * Returns posix file permissions if defined and the OS supports posix file attribute,
+ * Returns POSIX file permissions if defined and the OS supports POSIX file attribute,
* null otherwise.
- * @return File posix permissions
+ * @return File POSIX permissions
* @see PosixFileAttributeView
*/
public Set<PosixFilePermission> getFilePermissions() {
@@ -289,7 +289,7 @@ public class FileManager extends OutputStreamManager {
}
/**
- * Returns file group if defined and the OS supports posix/group file attribute view,
+ * Returns file group if defined and the OS supports POSIX/group file attribute view,
* null otherwise.
* @return File group
* @see PosixFileAttributeView
@@ -301,7 +301,7 @@ public class FileManager extends OutputStreamManager {
/**
* Returns true if file attribute view enabled for this file manager.
*
- * @return True if posix or owner supported and defined false otherwise.
+ * @return True if POSIX or owner supported and defined false otherwise.
*/
public boolean isAttributeViewEnabled() {
return attributeViewEnabled;
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.java
index 7866db0..0facba8 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DefaultRolloverStrategy.java
@@ -519,7 +519,7 @@ public class DefaultRolloverStrategy extends AbstractRolloverStrategy {
}
if (compressAction != null && manager.isAttributeViewEnabled()) {
- // Propagate posix attribute view to compressed file
+ // Propagate POSIX attribute view to compressed file
// @formatter:off
final Action posixAttributeViewAction = PosixViewAttributeAction.newBuilder()
.setBasePath(compressedName)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DirectWriteRolloverStrategy.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DirectWriteRolloverStrategy.java
index 18de6d1..9d5d325 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DirectWriteRolloverStrategy.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/DirectWriteRolloverStrategy.java
@@ -330,7 +330,7 @@ public class DirectWriteRolloverStrategy extends AbstractRolloverStrategy implem
}
if (compressAction != null && manager.isAttributeViewEnabled()) {
- // Propagate posix attribute view to compressed file
+ // Propagate POSIX attribute view to compressed file
// @formatter:off
final Action posixAttributeViewAction = PosixViewAttributeAction.newBuilder()
.setBasePath(compressedName)
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.java
index 0d1791a..e115faa 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/rolling/action/PosixViewAttributeAction.java
@@ -42,9 +42,9 @@ import java.util.List;
import java.util.Set;
/**
- * File posix attribute view action.
+ * File POSIX attribute view action.
*
- * Allow to define file permissions, user and group for log files on posix supported OS.
+ * Allow to define file permissions, user and group for log files on POSIX supported OS.
*/
@Plugin(name = "PosixViewAttribute", category = Core.CATEGORY_NAME, printObject = true)
public class PosixViewAttributeAction extends AbstractPathAction {
@@ -80,7 +80,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Builder for the posix view attribute action.
+ * Builder for the POSIX view attribute action.
*/
public static class Builder implements org.apache.logging.log4j.plugins.util.Builder<PosixViewAttributeAction> {
@@ -162,7 +162,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Define base path to apply condition before execute posix file attribute action.
+ * Define base path to apply condition before execute POSIX file attribute action.
* @param basePath {@link AbstractPathAction#getBasePath()}
* @return This builder
*/
@@ -182,7 +182,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Define max folder depth to search for eligible files to apply posix attribute view.
+ * Define max folder depth to search for eligible files to apply POSIX attribute view.
* @param maxDepth Max search depth
* @return This builder
*/
@@ -203,7 +203,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Define file permissions in posix format to apply during action execution eligible files.
+ * Define file permissions in POSIX format to apply during action execution eligible files.
*
* Example:
* <p>rw-rw-rw
@@ -256,7 +256,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
for (final PathCondition pathFilter : conditions) {
final Path relative = basePath.relativize(file);
if (!pathFilter.accept(basePath, relative, attrs)) {
- LOGGER.trace("Not defining posix attribute base={}, relative={}", basePath, relative);
+ LOGGER.trace("Not defining POSIX attribute base={}, relative={}", basePath, relative);
return FileVisitResult.CONTINUE;
}
}
@@ -267,9 +267,9 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Returns posix file permissions if defined and the OS supports posix file attribute,
+ * Returns POSIX file permissions if defined and the OS supports POSIX file attribute,
* null otherwise.
- * @return File posix permissions
+ * @return File POSIX permissions
* @see PosixFileAttributeView
*/
public Set<PosixFilePermission> getFilePermissions() {
@@ -287,7 +287,7 @@ public class PosixViewAttributeAction extends AbstractPathAction {
}
/**
- * Returns file group if defined and the OS supports posix/group file attribute view,
+ * Returns file group if defined and the OS supports POSIX/group file attribute view,
* null otherwise.
* @return File group
* @see PosixFileAttributeView
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
index 2c0d7fa..5e4424c 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/util/FileUtils.java
@@ -137,7 +137,7 @@ public final class FileUtils {
}
/**
- * Define file posix attribute view on a path/file.
+ * Define file POSIX attribute view on a path/file.
*
* @param path Target path
* @param filePermissions Permissions to apply
@@ -178,9 +178,9 @@ public final class FileUtils {
}
/**
- * Check if posix file attribute view is supported on the default FileSystem.
+ * Check if POSIX file attribute view is supported on the default FileSystem.
*
- * @return true if posix file attribute view supported, false otherwise
+ * @return true if POSIX file attribute view supported, false otherwise
*/
public static boolean isFilePosixAttributeViewSupported() {
return FileSystems.getDefault().supportedFileAttributeViews().contains("posix");