File 2871-snmp-doc-snmp_index-type-cleanup.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2871-snmp-doc-snmp_index-type-cleanup.patch of Package erlang

From 6ecb1edd933e54c3296f80225c942739d5ff5ffa Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 15 Jan 2024 17:34:22 +0100
Subject: [PATCH 51/67] [snmp|doc] snmp_index type cleanup

---
 lib/snmp/doc/src/snmp_index.xml | 59 +--------------------------------
 1 file changed, 1 insertion(+), 58 deletions(-)

diff --git a/lib/snmp/doc/src/snmp_index.xml b/lib/snmp/doc/src/snmp_index.xml
index fc410f5217..d0ab58e67f 100644
--- a/lib/snmp/doc/src/snmp_index.xml
+++ b/lib/snmp/doc/src/snmp_index.xml
@@ -151,64 +151,7 @@ get_next_pid(Oid, SnmpIndex) ->
 </datatypes>
 
 <section>
- <title>Common data types</title>
- The following data types are used in the functions below:
- 
- <list type="bulleted">
- <item>
- <c>index()</c>
- </item>
- <item>
- <c>oid() = [byte()]</c>
- </item>
- <item>
- <c>key_types = type_spec() | {type_spec(), type_spec(), ...}</c>
- </item>
- <item>
- <c>type_spec() = fix_string | string | integer</c>
- </item>
- <item>
- <c>key() = key_spec() | {key_spec(), key_spec(), ...}</c>
- </item>
- <item>
- <c>key_spec() = string() | integer()</c>
- </item>
- </list>
- The <c>index()</c> type denotes an snmp index structure.
- 
- The <c>oid()</c> type is used to represent an ASN.1 OBJECT
- IDENTIFIER.
- 
- The <c>key_types()</c> type is used when creating the
- index structure, and the <c>key()</c> type is used when inserting
- and deleting items from the structure.
- 
- The <c>key_types()</c> type defines the types of the SNMP INDEX
- columns for the table. If the table has one single INDEX column,
- this type should be a single atom, but if the table has multiple
- INDEX columns, it should be a tuple with atoms.
- 
- If the INDEX column is of type INTEGER, or derived from
- INTEGER, the corresponding type should be <c>integer</c>. If it
- is a variable length type (e.g. OBJECT IDENTIFIER, OCTET STRING),
- the corresponding type should be <c>string</c>. Finally, if the
- type is of variable length, but with a fixed size restriction
- (e.g. IpAddress), the corresponding type should be
- <c>fix_string</c>.
- 
- For example, if the SNMP table has two INDEX columns, the first
- one an OCTET STRING with size 2, and the second one an OBJECT
- IDENTIFIER, the corresponding <c>key_types</c> parameter would be
- <c>{fix_string, string}</c>.
- 
- The <c>key()</c> type correlates to the <c>key_types()</c>
- type. If the <c>key_types()</c> is a single atom, the
- corresponding <c>key()</c> is a single type as well, but if the
- <c>key_types()</c> is a tuple, <c>key</c> must be a tuple of the
- same size.
- 
- In the example above, valid <c>keys</c> could be <c>{"hi", "mom"}</c> and <c>{"no", "thanks"}</c>, whereas <c>"hi"</c>,
- <c>{"hi", 42}</c> and <c>{"hello", "there"}</c> would be invalid.
+ <title>Warnings</title>
 <warning>
 <marker id="1"></marker>
 All API functions that update the index return a <c>NewIndex</c>
-- 
2.35.3

Places

File 2871-snmp-doc-snmp_index-type-cleanup.patch of Package erlang

Places