aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Barach <dave@barachs.net>2020-06-17 16:31:34 -0400
committerDave Barach <dave@barachs.net>2020-06-17 17:02:48 -0400
commit70a9f442f5206c34b7b4058fd3cc5e46c0d0fbf3 (patch)
tree6e50ad7a2c55cada9f3e9933f0e0941eddc23b41
parent994a44c4116dd8f5c3d5270f8772f5b860e368bd (diff)
docs: add more FEATURE.yaml documentation
For src/tools/g2, src/vlibapi, and src/vlibmemory Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I800c3e3a1ecb011d5e692d78a015e78342706786
-rw-r--r--src/tools/g2/FEATURE.yaml12
-rw-r--r--src/vlibapi/FEATURE.yaml14
-rw-r--r--src/vlibmemory/FEATURE.yaml13
3 files changed, 39 insertions, 0 deletions
diff --git a/src/tools/g2/FEATURE.yaml b/src/tools/g2/FEATURE.yaml
new file mode 100644
index 00000000000..5b0c70cbb40
--- /dev/null
+++ b/src/tools/g2/FEATURE.yaml
@@ -0,0 +1,12 @@
+---
+name: G2 graphical event log viewer
+maintainer:
+ - Dave Barach <dave@barachs.net>
+features:
+ - Vppinfra elog.[ch] log viewer
+ - Scales to over 10e6 events, 10e4 tracks
+ - Automated anomaly detector
+ - View snapshots
+description: "A highly scalable graphical event log viewer, specifically
+ tailored to displaying src/vppinfra/elog.[ch] log files"
+state: production
diff --git a/src/vlibapi/FEATURE.yaml b/src/vlibapi/FEATURE.yaml
new file mode 100644
index 00000000000..4e809ff1013
--- /dev/null
+++ b/src/vlibapi/FEATURE.yaml
@@ -0,0 +1,14 @@
+---
+name: Binary API library
+maintainer:
+ - Dave Barach <dave@barachs.net>
+features:
+ - Event logging
+ - Message execution
+ - Message handler registration
+ - Message replay
+ - Message tracing
+ - Post-mortem message trace capture
+ - Platform-dependent message handler invocation
+description: "Transport-independent binary API message handling library"
+state: production
diff --git a/src/vlibmemory/FEATURE.yaml b/src/vlibmemory/FEATURE.yaml
new file mode 100644
index 00000000000..b0e0a9c1ab0
--- /dev/null
+++ b/src/vlibmemory/FEATURE.yaml
@@ -0,0 +1,13 @@
+---
+name: Binary API shared memory / socket transport library
+maintainer:
+ - Dave Barach <dave@barachs.net>
+features:
+ - Transport connection setup and teardown binary API message definitions
+ - Transport connection setup and teardown binary API message handlers
+ - Remote procedure call binary API support
+ - Debug CLI for binary api message trace dump and replay
+ - Command-line configuration of binary api tracing
+description: "Binary API message transport library"
+state: production
+properties: [API, CLI, MULTITHREAD]