docs: add more FEATURE.yaml documentation 87/27587/1
authorDave Barach <dave@barachs.net>
Wed, 17 Jun 2020 20:31:34 +0000 (16:31 -0400)
committerDave Barach <dave@barachs.net>
Wed, 17 Jun 2020 21:02:48 +0000 (17:02 -0400)
For src/tools/g2, src/vlibapi, and src/vlibmemory

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I800c3e3a1ecb011d5e692d78a015e78342706786

src/tools/g2/FEATURE.yaml [new file with mode: 0644]
src/vlibapi/FEATURE.yaml [new file with mode: 0644]
src/vlibmemory/FEATURE.yaml [new file with mode: 0644]

diff --git a/src/tools/g2/FEATURE.yaml b/src/tools/g2/FEATURE.yaml
new file mode 100644 (file)
index 0000000..5b0c70c
--- /dev/null
@@ -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 (file)
index 0000000..4e809ff
--- /dev/null
@@ -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 (file)
index 0000000..b0e0a9c
--- /dev/null
@@ -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]