From 16b4d05ab194d40c62de5d68e365a4daa28dd868 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Tue, 29 Jan 2008 07:08:43 +0000
Subject: [PATCH] Doc changes to Log Publisher Configuration docs and some copyright changes. Thanks to Daniel for the review.
---
opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml | 46 ++++++++++++++++++++++++++++++----------------
1 files changed, 30 insertions(+), 16 deletions(-)
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml
index 86d5c0d..00b30bc 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/FileBasedAccessLogPublisherConfiguration.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-based-access-log-publisher"
plural-name="file-based-access-log-publishers"
@@ -51,7 +51,7 @@
</adm:property-override>
<adm:property name="asynchronous" mandatory="true" advanced="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
will publish records asynchronously.
</adm:synopsis>
@@ -74,7 +74,15 @@
The maximum number of log records that can be stored in the
asynchronous queue.
</adm:synopsis>
- <adm:default-behavior>
+ <adm:requires-admin-action>
+ <adm:other>
+ <adm:synopsis>
+ The <adm:user-friendly-name /> must be restarted if this property
+ is changed and the asynchronous property is set to true.
+ </adm:synopsis>
+ </adm:other>
+ </adm:requires-admin-action>
+ <adm:default-behavior>
<adm:defined>
<adm:value>5000</adm:value>
</adm:defined>
@@ -91,14 +99,22 @@
<adm:property name="log-file" mandatory="true">
<adm:synopsis>
The file name to use for the log files generated by the
- <adm:user-friendly-name />
- . The path to the file is relative to the server root.
+ <adm:user-friendly-name />.
+ The path to the file is relative to the server root.
</adm:synopsis>
<adm:requires-admin-action>
<adm:component-restart />
</adm:requires-admin-action>
- <adm:syntax>
- <adm:string />
+ <adm:syntax>
+ <adm:string>
+ <adm:pattern>
+ <adm:regex>.*</adm:regex>
+ <adm:usage>FILE</adm:usage>
+ <adm:synopsis>
+ A path to an existing file that is readable by the server.
+ </adm:synopsis>
+ </adm:pattern>
+ </adm:string>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
@@ -109,8 +125,7 @@
<adm:property name="log-file-permissions" mandatory="true">
<adm:synopsis>
The UNIX permissions of the log files created by this
- <adm:user-friendly-name />
- .
+ <adm:user-friendly-name />.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -123,7 +138,7 @@
<adm:regex>^([0-7][0-7][0-7])$</adm:regex>
<adm:usage>MODE</adm:usage>
<adm:synopsis>
- An valid UNIX mode string. The mode string must contain
+ A valid UNIX mode string. The mode string must contain
three digits between zero and seven.
</adm:synopsis>
</adm:pattern>
@@ -137,8 +152,8 @@
</adm:property>
<adm:property name="time-interval" advanced="true">
<adm:synopsis>
- Specifies the interval to check whether the log files need to be
- rotated.
+ Specifies the interval at which to check whether the log files
+ need to be rotated.
</adm:synopsis>
<adm:default-behavior>
<adm:defined>
@@ -175,7 +190,7 @@
Specifies whether to flush the writer after every log record.
</adm:synopsis>
<adm:description>
- If the asynchronous writes option is used, the writer will be
+ If the asynchronous writes option is used, the writer is
flushed after all the log records in the queue are written.
</adm:description>
<adm:default-behavior>
@@ -244,14 +259,13 @@
.
</adm:synopsis>
<adm:description>
- When multiple policies are used, log files will be cleaned when
+ When multiple policies are used, log files are cleaned when
any of the policy's conditions are met.
</adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
- No retention policy is used and log files will never be
- cleaned.
+ No retention policy is used and log files are never cleaned.
</adm:synopsis>
</adm:alias>
</adm:default-behavior>
--
Gitblit v1.10.0