From ab55cc40cc380c223125102ad7a3f402c139cac6 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Tue, 29 Jan 2008 07:07:32 +0000
Subject: [PATCH] Doc changes to Log Rotation and Retention Policy Configuration docs and some copyright changes. Thanks to Daniel for the review.
---
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRetentionPolicyConfiguration.xml | 4 ++--
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/TimeLimitLogRotationPolicyConfiguration.xml | 6 ++++--
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRetentionPolicyConfiguration.xml | 8 ++++----
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FixedTimeLogRotationPolicyConfiguration.xml | 6 +++---
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRotationPolicyConfiguration.xml | 4 ++--
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRotationPolicyConfiguration.xml | 5 +++--
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FreeDiskSpaceLogRetentionPolicyConfiguration.xml | 7 +++++--
opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FileCountLogRetentionPolicyConfiguration.xml | 6 +++---
8 files changed, 26 insertions(+), 20 deletions(-)
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FileCountLogRetentionPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FileCountLogRetentionPolicyConfiguration.xml
index ca4c401..e3af46b 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FileCountLogRetentionPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FileCountLogRetentionPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="file-count-log-retention-policy"
plural-name="file-count-log-retention-policies"
@@ -50,8 +50,8 @@
</adm:property-override>
<adm:property name="number-of-files" mandatory="true">
<adm:synopsis>
- Number of log files to retain before the oldest ones will be
- cleaned.
+ Specifies the number of archived log files to retain before the
+ oldest ones are cleaned.
</adm:synopsis>
<adm:syntax>
<adm:integer lower-limit="1" />
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FixedTimeLogRotationPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FixedTimeLogRotationPolicyConfiguration.xml
index 62395c9..dcea75a 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FixedTimeLogRotationPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FixedTimeLogRotationPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="fixed-time-log-rotation-policy"
plural-name="fixed-time-log-rotation-policies"
@@ -31,7 +31,7 @@
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
- Rotation policy based on fixed time of day.
+ Rotation policy based on a fixed time of day.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
@@ -51,7 +51,7 @@
<adm:property name="time-of-day" multi-valued="true"
mandatory="true">
<adm:synopsis>
- The time of day which log rotation should occur.
+ Specifies the time of day at which log rotation should occur.
</adm:synopsis>
<adm:syntax>
<adm:string>
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FreeDiskSpaceLogRetentionPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FreeDiskSpaceLogRetentionPolicyConfiguration.xml
index 4f51dcf..7a5afd4 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FreeDiskSpaceLogRetentionPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/FreeDiskSpaceLogRetentionPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="free-disk-space-log-retention-policy"
plural-name="free-disk-space-log-retention-policies"
@@ -52,7 +52,10 @@
</adm:default-behavior>
</adm:property-override>
<adm:property name="free-disk-space" mandatory="true">
- <adm:synopsis>The size of free disk space needed.</adm:synopsis>
+ <adm:synopsis>Specifies the minimum amount of free disk space that
+ should be available on the file system on which the archived
+ log files are stored.
+ </adm:synopsis>
<adm:syntax>
<adm:size lower-limit="1" />
</adm:syntax>
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRetentionPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRetentionPolicyConfiguration.xml
index d74babb..b1245e4 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRetentionPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRetentionPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="log-retention-policy"
plural-name="log-retention-policies"
@@ -47,7 +47,7 @@
</adm:profile>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
- The fully-qualified name of the Java class that provides the
+ Specifies the fully-qualified name of the Java class that provides the
<adm:user-friendly-name />
implementation.
</adm:synopsis>
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRotationPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRotationPolicyConfiguration.xml
index cac8881..6d269d1 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRotationPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/LogRotationPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="log-rotation-policy"
plural-name="log-rotation-policies"
@@ -47,7 +47,7 @@
</adm:profile>
<adm:property name="java-class" mandatory="true">
<adm:synopsis>
- The fully-qualified name of the Java class that provides the
+ Specifies the fully-qualified name of the Java class that provides the
<adm:user-friendly-name />
implementation.
</adm:synopsis>
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRetentionPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRetentionPolicyConfiguration.xml
index 5e9661e..31a408f 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRetentionPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRetentionPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="size-limit-log-retention-policy"
plural-name="size-limit-log-retention-policies"
@@ -31,8 +31,8 @@
xmlns:adm="http://www.opends.org/admin"
xmlns:ldap="http://www.opends.org/admin-ldap">
<adm:synopsis>
- Retention policy based on the amount of space taken by the log files
- on disk.
+ Retention policy based on the amount of space taken by all the log
+ files on disk.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
@@ -51,7 +51,7 @@
</adm:property-override>
<adm:property name="disk-space-used" mandatory="true">
<adm:synopsis>
- The maximum total disk space used by the log files.
+ Specifies the maximum total disk space used by the log files.
</adm:synopsis>
<adm:syntax>
<adm:size lower-limit="1" />
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRotationPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRotationPolicyConfiguration.xml
index 203447e..b11bf4d 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRotationPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/SizeLimitLogRotationPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="size-limit-log-rotation-policy"
plural-name="size-limit-log-rotation-policies"
@@ -50,7 +50,8 @@
</adm:property-override>
<adm:property name="file-size-limit" mandatory="true">
<adm:synopsis>
- The size of the file when rotation takes place.
+ Specifies the maximum size that a log file can reach before
+ it is rotated.
</adm:synopsis>
<adm:syntax>
<adm:size lower-limit="1" />
diff --git a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/TimeLimitLogRotationPolicyConfiguration.xml b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/TimeLimitLogRotationPolicyConfiguration.xml
index 3b925ab..12f57cd 100644
--- a/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/TimeLimitLogRotationPolicyConfiguration.xml
+++ b/opendj-sdk/opends/src/admin/defn/org/opends/server/admin/std/TimeLimitLogRotationPolicyConfiguration.xml
@@ -23,7 +23,7 @@
! CDDL HEADER END
!
!
- ! Portions Copyright 2007 Sun Microsystems, Inc.
+ ! Portions Copyright 2007-2008 Sun Microsystems, Inc.
! -->
<adm:managed-object name="time-limit-log-rotation-policy"
plural-name="time-limit-log-rotation-policies"
@@ -49,7 +49,9 @@
</adm:default-behavior>
</adm:property-override>
<adm:property name="rotation-interval" mandatory="true">
- <adm:synopsis>The time interval between rotations.</adm:synopsis>
+ <adm:synopsis>
+ Specifies the time interval between rotations.
+ </adm:synopsis>
<adm:syntax>
<adm:duration base-unit="ms" lower-limit="1" />
</adm:syntax>
--
Gitblit v1.10.0