summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorelie <elie>2015-09-19 13:42:34 +0000
committerelie <elie>2015-09-19 13:42:34 +0000
commit851e80ae0e04a05c40755d2f5a95d3571f71d64b (patch)
tree3a072a6e6896dd06c0086c070721eb0a0ae20684
parent45355ded422185b96b41ee72f283eea764cbe0da (diff)
downloadpysnmp-851e80ae0e04a05c40755d2f5a95d3571f71d64b.tar.gz
sidebar menu rearrangement + typo fixes
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator.rst5
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst25
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst4
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/contents.rst38
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst4
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst28
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst4
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst4
-rw-r--r--docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst4
-rw-r--r--docs/source/docs/v3arch/snmp-engine.rst2
-rw-r--r--docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst2
-rw-r--r--pysnmp/entity/rfc3413/oneliner/sync/cmdgen.py4
12 files changed, 48 insertions, 76 deletions
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator.rst b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator.rst
index 51d20bf..82d7727 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator.rst
@@ -1,9 +1,8 @@
+.. toctree::
+ :maxdepth: 2
Asynchronous Notification Originator
====================================
-.. toctree::
- :maxdepth: 2
-
.. autoclass:: pysnmp.entity.rfc3413.oneliner.ntforg.AsyncNotificationOriginator
:members:
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst
deleted file mode 100644
index cde3050..0000000
--- a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/contents.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-
-Synchronous Notification Originator
-===================================
-
-Functions dscribed in this section return generators that perform
-blocking SNMP queries. See :RFC:`3413#section-3.3` for more information
-on the Notification Originator Applications.
-
-.. toctree::
- :maxdepth: 2
-
- /docs/v3arch/asyncore/oneliner/agent/ntforg/notification
-
-Asynchronous Notification Originator
-====================================
-
-Implementation described in this section geared towards sending
-multiple simulataneous SNMP notifications on top of asynchronous
-I/O framework. Otherwise it is very similar to the Synchronous
-version.
-
-.. toctree::
- :maxdepth: 2
-
- /docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst
index b6061ad..8de1e3b 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/agent/ntforg/notification.rst
@@ -1,6 +1,6 @@
-Notification Originator
-=======================
+TRAP/INFORM notification
+========================
.. toctree::
:maxdepth: 2
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
index 2c0e3a8..0c1b480 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/contents.rst
@@ -21,22 +21,45 @@ other tasks till pending message is sent out (by I/O dispacher) and
response is arrived. At that point a previously supplied callback function
will be invoked and response data will be passed along.
-SNMP security configuration is conveyed to SNMP engine via
-:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData`
-and :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
-classes:
+Synchronous Command Generator
.. toctree::
:maxdepth: 2
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/contents
- /docs/v3arch/asyncore/oneliner/agent/ntforg/contents
+ /docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd
+ /docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd
+ /docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd
+ /docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd
+
+Synchronous Notification Originator
+
+.. toctree::
+ :maxdepth: 2
+
+ /docs/v3arch/asyncore/oneliner/agent/ntforg/notification
The asynchronous version is best suited for massively parallel SNMP
messaging possibly handling other I/O activities in the same time. The
synchronous version is advised to employ for singular and blocking
operations as well as for rapid prototyping.
+Asynchronous operations
+-----------------------
+
+.. toctree::
+ :maxdepth: 2
+
+ /docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator
+ /docs/v3arch/asyncore/oneliner/agent/ntforg/async-notification-originator
+
+SNMP Configuration
+------------------
+
+SNMP security configuration is conveyed to SNMP engine via
+:py:class:`~pysnmp.entity.rfc3413.oneliner.auth.CommunityData`
+and :py:class:`~pysnmp.entity.rfc3413.oneliner.auth.UsmUserData`
+classes:
+
.. toctree::
:maxdepth: 2
@@ -65,6 +88,9 @@ See :RFC:`3411#section-3.3.1` for details.
/docs/v3arch/asyncore/oneliner/snmp-context
+MIB variables
+-------------
+
MIB variables represent a collection of managed objects,
residing in MIBs. Command Generator applications refer
to MIB variables and their values using
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst
index 5882ca3..6c7d16f 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd.rst
@@ -1,6 +1,6 @@
-GETBULK Command Generator
-=========================
+GETBULK command
+===============
.. toctree::
:maxdepth: 2
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst
deleted file mode 100644
index 0552f0e..0000000
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/contents.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-
-Synchronous Command Generator
-=============================
-
-Functions dscribed in this section return generators that perform
-blocking SNMP queries. See :RFC:`3413#section-3.1` for more information
-on the Command Generator Applications.
-
-.. toctree::
- :maxdepth: 2
-
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/bulkcmd
-
-Asynchronous Command Generator
-==============================
-
-Implementation described in this section geared towards running
-multiple simulataneous SNMP queries on top of asynchronous
-I/O framework. Otherwise it is very similar to the Synchronous
-version.
-
-.. toctree::
- :maxdepth: 2
-
- /docs/v3arch/asyncore/oneliner/manager/cmdgen/async-command-generator
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst
index cf97515..6aed48d 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/getcmd.rst
@@ -1,6 +1,6 @@
-GET Command Generator
-=====================
+GET command
+===========
.. toctree::
:maxdepth: 2
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst
index 626ff48..63b7f79 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/nextcmd.rst
@@ -1,6 +1,6 @@
-GETNEXT Command Generator
-=========================
+GETNEXT command
+===============
.. toctree::
:maxdepth: 2
diff --git a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst
index e458c9f..3dc68a0 100644
--- a/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst
+++ b/docs/source/docs/v3arch/asyncore/oneliner/manager/cmdgen/setcmd.rst
@@ -1,6 +1,6 @@
-SET Command Generator
-=====================
+SET command
+===========
.. toctree::
:maxdepth: 2
diff --git a/docs/source/docs/v3arch/snmp-engine.rst b/docs/source/docs/v3arch/snmp-engine.rst
index 8ec77ae..339d618 100644
--- a/docs/source/docs/v3arch/snmp-engine.rst
+++ b/docs/source/docs/v3arch/snmp-engine.rst
@@ -2,7 +2,7 @@
SNMP Engine
===========
-SNMP Engine is a central, stateful objects used by all SNMP v3
+SNMP Engine is a central, stateful object used by all SNMP v3
substsems. Calls to oneliner Applications API also consume SNMP
Engine object on input.
diff --git a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst
index 364555c..787c66e 100644
--- a/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst
+++ b/docs/source/examples/v3arch/asyncore/oneliner/manager/cmdgen/snmp-versions.rst
@@ -19,7 +19,7 @@ Various SNMP versions
:start-after: """
:end-before: """#
-.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v2-cget.py
+.. literalinclude:: /../../examples/v3arch/asyncore/oneliner/manager/cmdgen/v2c-get.py
:start-after: """#
:language: python
diff --git a/pysnmp/entity/rfc3413/oneliner/sync/cmdgen.py b/pysnmp/entity/rfc3413/oneliner/sync/cmdgen.py
index c0f8af1..1369a43 100644
--- a/pysnmp/entity/rfc3413/oneliner/sync/cmdgen.py
+++ b/pysnmp/entity/rfc3413/oneliner/sync/cmdgen.py
@@ -419,8 +419,8 @@ def bulkCmd(snmpEngine, authData, transportTarget, contextData,
Class instance representing SNMP ContextEngineId and ContextName values.
nonRepeaters : int
- One MIB variable is requested in response for the first
- `nonRepeaters` MIB variables in request.
+ One MIB variable is requested in response for the first
+ `nonRepeaters` MIB variables in request.
maxRepetitions : int
`maxRepetitions` MIB variables are requested in response for each