From f093e33c861a0dfd71992189b7943998f49fc9a2 Mon Sep 17 00:00:00 2001
From: lfrost <lfrost@localhost>
Date: Tue, 29 Jan 2008 07:04:14 +0000
Subject: [PATCH] Doc changes to Matching Rule and Monitor Provider Configuration Doc and some copyright changes. Thanks to Daniel for the review.
---
opends/src/admin/defn/org/opends/server/admin/std/MemoryUsageMonitorProviderConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/ApproximateMatchingRuleConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/EntryCacheMonitorProviderConfiguration.xml | 6 +-
opends/src/admin/defn/org/opends/server/admin/std/EqualityMatchingRuleConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/MatchingRuleConfiguration.xml | 14 ++++--
opends/src/admin/defn/org/opends/server/admin/std/SubstringMatchingRuleConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/ClientConnectionMonitorProviderConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/VersionMonitorProviderConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/OrderingMatchingRuleConfiguration.xml | 2
opends/src/admin/defn/org/opends/server/admin/std/MonitorProviderConfiguration.xml | 11 ++---
opends/src/admin/defn/org/opends/server/admin/std/SystemInfoMonitorProviderConfiguration.xml | 4 +-
opends/src/admin/defn/org/opends/server/admin/std/StackTraceMonitorProviderConfiguration.xml | 6 +-
12 files changed, 33 insertions(+), 30 deletions(-)
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/ApproximateMatchingRuleConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/ApproximateMatchingRuleConfiguration.xml
index 3633ff1..3463bd6 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/ApproximateMatchingRuleConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/ApproximateMatchingRuleConfiguration.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="approximate-matching-rule"
plural-name="approximate-matching-rules"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/ClientConnectionMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/ClientConnectionMonitorProviderConfiguration.xml
index d225d5f..e9a8709 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/ClientConnectionMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/ClientConnectionMonitorProviderConfiguration.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="client-connection-monitor-provider"
plural-name="client-connection-monitor-providers"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/EntryCacheMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/EntryCacheMonitorProviderConfiguration.xml
index 28ae32e..916e656 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/EntryCacheMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/EntryCacheMonitorProviderConfiguration.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="entry-cache-monitor-provider"
plural-name="entry-cache-monitor-providers"
@@ -33,8 +33,8 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- exposes monitor information about Directory Server entry caches
- state.
+ exposes monitor information about the state of Directory Server
+ entry caches.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/EqualityMatchingRuleConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/EqualityMatchingRuleConfiguration.xml
index b5db16a..14c1978 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/EqualityMatchingRuleConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/EqualityMatchingRuleConfiguration.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="equality-matching-rule"
plural-name="equality-matching-rules"
@@ -33,7 +33,7 @@
<adm:synopsis>
<adm:user-friendly-plural-name />
define a set of rules for performing equality matching operations
- against assertion values (i.e., to determine whether an attribute
+ against assertion values (that is, to determine whether an attribute
value equals an assertion value).
</adm:synopsis>
<adm:profile name="ldap">
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/MatchingRuleConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/MatchingRuleConfiguration.xml
index 8e61b12..7c0f9fb 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/MatchingRuleConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/MatchingRuleConfiguration.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="matching-rule" plural-name="matching-rules"
package="org.opends.server.admin.std" abstract="true"
@@ -35,8 +35,12 @@
assertion values.
</adm:synopsis>
<adm:description>
- The primary types of matching rules are equality, ordering,
- substring, and approximate.
+ Matching rules are frequently associated with an attribute syntax
+ and are used to compare values according to that syntax. For example,
+ the distinguishedNameEqualityMatch matching rule can be used to
+ determine whether two DNs are equal and can ignore unnecessary spaces
+ around commas and equal signs, differences in capitalization in
+ attribute names, an so on.
</adm:description>
<adm:tag name="core" />
<adm:profile name="ldap">
@@ -47,7 +51,7 @@
</adm:profile>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
is enabled for use.
</adm:synopsis>
@@ -62,7 +66,7 @@
</adm:property>
<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/opends/src/admin/defn/org/opends/server/admin/std/MemoryUsageMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/MemoryUsageMonitorProviderConfiguration.xml
index 7116436..d17a9f9 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/MemoryUsageMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/MemoryUsageMonitorProviderConfiguration.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="memory-usage-monitor-provider"
plural-name="memory-usage-monitor-providers"
@@ -33,7 +33,7 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- may be used to publish information about memory consumption and
+ can be used to publish information about memory consumption and
garbage collection activity in the JVM.
</adm:synopsis>
<adm:profile name="ldap">
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/MonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/MonitorProviderConfiguration.xml
index c7178ca..d3e5b0d 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/MonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/MonitorProviderConfiguration.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="monitor-provider"
plural-name="monitor-providers" package="org.opends.server.admin.std"
@@ -32,12 +32,11 @@
xmlns:cli="http://www.opends.org/admin-cli">
<adm:synopsis>
<adm:user-friendly-plural-name />
- may be used to provide information about the state of the server or
+ can be used to provide information about the state of the server or
one of its components.
</adm:synopsis>
<adm:description>
- This information may be useful for monitoring and/or troubleshooting
- purposes.
+ This information is useful for monitoring or troubleshooting.
</adm:description>
<adm:tag name="core" />
<adm:profile name="ldap">
@@ -51,7 +50,7 @@
</adm:profile>
<adm:property name="enabled" mandatory="true">
<adm:synopsis>
- Indicate whether the
+ Indicates whether the
<adm:user-friendly-name />
is enabled for use.
</adm:synopsis>
@@ -66,7 +65,7 @@
</adm:property>
<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/opends/src/admin/defn/org/opends/server/admin/std/OrderingMatchingRuleConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/OrderingMatchingRuleConfiguration.xml
index 4d3d0f1..d111262 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/OrderingMatchingRuleConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/OrderingMatchingRuleConfiguration.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="ordering-matching-rule"
plural-name="ordering-matching-rules"
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/StackTraceMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/StackTraceMonitorProviderConfiguration.xml
index 4432c0b..561dd35 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/StackTraceMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/StackTraceMonitorProviderConfiguration.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="stack-trace-monitor-provider"
plural-name="stack-trace-monitor-providers"
@@ -33,8 +33,8 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- provides the ability for clients to obtain a stack trace of all
- threads currently running in the Directory Server.
+ enables clients to obtain a stack trace of all the threads that are
+ currently running in the Directory Server.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/SubstringMatchingRuleConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/SubstringMatchingRuleConfiguration.xml
index c37d01a..ec1cad8 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/SubstringMatchingRuleConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/SubstringMatchingRuleConfiguration.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="substring-matching-rule"
plural-name="substring-matching-rules"
@@ -36,7 +36,7 @@
against assertion values.
</adm:synopsis>
<adm:description>
- Substring matching may be used to perform partial matching with
+ Substring matching can be used to perform partial matching with
attribute values.
</adm:description>
<adm:profile name="ldap">
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/SystemInfoMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/SystemInfoMonitorProviderConfiguration.xml
index 1c22c9c..b3c4d44 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/SystemInfoMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/SystemInfoMonitorProviderConfiguration.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="system-info-monitor-provider"
plural-name="system-info-monitor-providers"
@@ -33,7 +33,7 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- may be used to publish information about the system and virtual
+ can be used to publish information about the system and virtual
machine on which the Directory Server is running.
</adm:synopsis>
<adm:profile name="ldap">
diff --git a/opends/src/admin/defn/org/opends/server/admin/std/VersionMonitorProviderConfiguration.xml b/opends/src/admin/defn/org/opends/server/admin/std/VersionMonitorProviderConfiguration.xml
index 2855b89..7fe1ed4 100644
--- a/opends/src/admin/defn/org/opends/server/admin/std/VersionMonitorProviderConfiguration.xml
+++ b/opends/src/admin/defn/org/opends/server/admin/std/VersionMonitorProviderConfiguration.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="version-monitor-provider"
plural-name="version-monitor-providers"
@@ -33,7 +33,7 @@
<adm:synopsis>
The
<adm:user-friendly-name />
- may be used to publish Directory Server version information.
+ can be used to publish Directory Server version information.
</adm:synopsis>
<adm:profile name="ldap">
<ldap:object-class>
--
Gitblit v1.10.0