snmpstats Improve README formatting of list of items in MIB

kamailio · May 24, 2016 · b004753 · b004753
1 parent 0a14906
commit b004753
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 38 deletions.
diff --git a/modules/snmpstats/README b/modules/snmpstats/README
@@ -138,29 +138,46 @@ Chapter 1. Admin Guide
    KAMAILIO-SIP-COMMON-MIB, and KAMAILIO-SIP-SERVER-MIB. But briefly,
    these scalars are:
 
-   kamailioSIPProtocolVersion, kamailioSIPServiceStartTime,
-   kamailioSIPEntityType, kamailioSIPSummaryInRequests,
-   kamailioSIPSummaryOutRequest, kamailioSIPSummaryInResponses,
-   kamailioSIPSummaryOutResponses, kamailioSIPSummaryTotalTransactions,
-   kamailioSIPCurrentTransactions, kamailioSIPNumUnsupportedUris,
-   kamailioSIPNumUnsupportedMethods, kamailioSIPOtherwiseDiscardedMsgs,
-   kamailioSIPProxyStatefulness kamailioSIPProxyRecordRoute,
-   kamailioSIPProxyAuthMethod, kamailioSIPNumProxyRequireFailures,
-   kamailioSIPRegMaxContactExpiryDuration, kamailioSIPRegMaxUsers,
-   kamailioSIPRegCurrentUsers, kamailioSIPRegDfltRegActiveInterval,
-   kamailioSIPRegAcceptedRegistrations,
-   kamailioSIPRegRejectedRegistrations, kamailioMsgQueueDepth.
-   kamailioCurNumDialogs, kamailioCurNumDialogsInProgress,
-   kamailioCurNumDialogsInSetup, kamailioTotalNumFailedDialogSetups
+     * kamailioSIPProtocolVersion
+     * kamailioSIPServiceStartTime
+     * kamailioSIPEntityType
+     * kamailioSIPSummaryInRequests
+     * kamailioSIPSummaryOutRequest
+     * kamailioSIPSummaryInResponses
+     * kamailioSIPSummaryOutResponses
+     * kamailioSIPSummaryTotalTransactions
+     * kamailioSIPCurrentTransactions
+     * kamailioSIPNumUnsupportedUris
+     * kamailioSIPNumUnsupportedMethods
+     * kamailioSIPOtherwiseDiscardedMsgs
+     * kamailioSIPProxyStatefulness kamailioSIPProxyRecordRoute
+     * kamailioSIPProxyAuthMethod
+     * kamailioSIPNumProxyRequireFailures
+     * kamailioSIPRegMaxContactExpiryDuration
+     * kamailioSIPRegMaxUsers
+     * kamailioSIPRegCurrentUsers
+     * kamailioSIPRegDfltRegActiveInterval
+     * kamailioSIPRegAcceptedRegistrations
+     * kamailioSIPRegRejectedRegistrations
+     * kamailioMsgQueueDepth
+     * kamailioCurNumDialogs
+     * kamailioCurNumDialogsInProgress
+     * kamailioCurNumDialogsInSetup
+     * kamailioTotalNumFailedDialogSetups
 
    There are also scalars associated with alarms. They are as follows:
 
-   kamailioMsgQueueMinorThreshold, kamailioMsgQueueMajorThreshold,
-   kamailioMsgQueueDepthAlarmStatus, kamailioMsgQueueDepthMinorAlarm,
-   kamailioMsgQueueDepthMajorAlarm, kamailioDialogLimitMinorThreshold,
-   kamailioDialogLimitMajorThreshold, kamailioDialogUsageState,
-   kamailioDialogLimitAlarmStatus, kamailioDialogLimitMinorAlarm,
-   kamailioDialogLimitMajorAlarm
+     * kamailioMsgQueueMinorThreshold
+     * kamailioMsgQueueMajorThreshold
+     * kamailioMsgQueueDepthAlarmStatus
+     * kamailioMsgQueueDepthMinorAlarm
+     * kamailioMsgQueueDepthMajorAlarm
+     * kamailioDialogLimitMinorThreshold
+     * kamailioDialogLimitMajorThreshold
+     * kamailioDialogUsageState
+     * kamailioDialogLimitAlarmStatus
+     * kamailioDialogLimitMinorAlarm
+     * kamailioDialogLimitMajorAlarm
 
    In Kamailio 4.1 a set of new OIDs was added to reflect the Kamailio
    configuration, the version, core status (memory, connections),

diff --git a/modules/snmpstats/doc/snmpstats_admin.xml b/modules/snmpstats/doc/snmpstats_admin.xml
@@ -34,31 +34,38 @@
 			these scalars are:
 			</para>
 			<para>
-			kamailioSIPProtocolVersion, kamailioSIPServiceStartTime, kamailioSIPEntityType,
-			kamailioSIPSummaryInRequests, kamailioSIPSummaryOutRequest, 
-			kamailioSIPSummaryInResponses, kamailioSIPSummaryOutResponses,
-			kamailioSIPSummaryTotalTransactions, kamailioSIPCurrentTransactions, 
-			kamailioSIPNumUnsupportedUris, kamailioSIPNumUnsupportedMethods, 
-			kamailioSIPOtherwiseDiscardedMsgs, kamailioSIPProxyStatefulness
-			kamailioSIPProxyRecordRoute, kamailioSIPProxyAuthMethod, 
-			kamailioSIPNumProxyRequireFailures, kamailioSIPRegMaxContactExpiryDuration,
-			kamailioSIPRegMaxUsers, kamailioSIPRegCurrentUsers, 
-			kamailioSIPRegDfltRegActiveInterval, kamailioSIPRegAcceptedRegistrations,
-			kamailioSIPRegRejectedRegistrations, kamailioMsgQueueDepth.
-			kamailioCurNumDialogs, kamailioCurNumDialogsInProgress, 
-			kamailioCurNumDialogsInSetup, kamailioTotalNumFailedDialogSetups
+			<itemizedlist>
+			<listitem>
+			kamailioSIPProtocolVersion</listitem><listitem> kamailioSIPServiceStartTime</listitem><listitem> kamailioSIPEntityType</listitem><listitem>
+			kamailioSIPSummaryInRequests</listitem><listitem> kamailioSIPSummaryOutRequest</listitem><listitem> 
+			kamailioSIPSummaryInResponses</listitem><listitem> kamailioSIPSummaryOutResponses</listitem><listitem>
+			kamailioSIPSummaryTotalTransactions</listitem><listitem> kamailioSIPCurrentTransactions</listitem><listitem> 
+			kamailioSIPNumUnsupportedUris</listitem><listitem> kamailioSIPNumUnsupportedMethods</listitem><listitem> 
+			kamailioSIPOtherwiseDiscardedMsgs</listitem><listitem> kamailioSIPProxyStatefulness
+			kamailioSIPProxyRecordRoute</listitem><listitem> kamailioSIPProxyAuthMethod</listitem><listitem> 
+			kamailioSIPNumProxyRequireFailures</listitem><listitem> kamailioSIPRegMaxContactExpiryDuration</listitem><listitem>
+			kamailioSIPRegMaxUsers</listitem><listitem> kamailioSIPRegCurrentUsers</listitem><listitem> 
+			kamailioSIPRegDfltRegActiveInterval</listitem><listitem> kamailioSIPRegAcceptedRegistrations</listitem><listitem>
+			kamailioSIPRegRejectedRegistrations</listitem><listitem> kamailioMsgQueueDepth</listitem><listitem>
+			kamailioCurNumDialogs</listitem><listitem> kamailioCurNumDialogsInProgress</listitem><listitem> 
+			kamailioCurNumDialogsInSetup</listitem><listitem> kamailioTotalNumFailedDialogSetups</listitem>
+			</itemizedlist>
 			</para>
 			<para>
 			There are also scalars associated with alarms.  They are as follows:
 			</para>
 
 			<para>
-			kamailioMsgQueueMinorThreshold, kamailioMsgQueueMajorThreshold,
-			kamailioMsgQueueDepthAlarmStatus, kamailioMsgQueueDepthMinorAlarm,
-			kamailioMsgQueueDepthMajorAlarm, kamailioDialogLimitMinorThreshold,
-			kamailioDialogLimitMajorThreshold, kamailioDialogUsageState,
-			kamailioDialogLimitAlarmStatus, kamailioDialogLimitMinorAlarm,
+			<itemizedlist>
+			<listitem>
+			kamailioMsgQueueMinorThreshold</listitem><listitem> kamailioMsgQueueMajorThreshold</listitem><listitem>
+			kamailioMsgQueueDepthAlarmStatus</listitem><listitem> kamailioMsgQueueDepthMinorAlarm</listitem><listitem>
+			kamailioMsgQueueDepthMajorAlarm</listitem><listitem> kamailioDialogLimitMinorThreshold</listitem><listitem>
+			kamailioDialogLimitMajorThreshold</listitem><listitem> kamailioDialogUsageState</listitem><listitem>
+			kamailioDialogLimitAlarmStatus</listitem><listitem> kamailioDialogLimitMinorAlarm</listitem><listitem>
 			kamailioDialogLimitMajorAlarm
+			</listitem>
+			</itemizedlist>
 			</para>
 			<para>
 			In Kamailio 4.1 a set of new OIDs was added to reflect the