summaryrefslogtreecommitdiffstats
path: root/src/plugins
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2017-09-27 15:09:48 -0400
committerFlorin Coras <florin.coras@gmail.com>2017-09-28 01:04:56 +0000
commit64ebb5ff1338140d94c7f9ee72138fe84d89de2e (patch)
tree338f13adac0036599943061d2fabfd673479643e /src/plugins
parent4ff586d1c6fc5c40e1548cd6f221a8a7f3ad033b (diff)
General documentation updates
- We now have several developer-focused docs, so create an index page for them. - Rework several docs to fit into the index structure. - Experiment with code highlighting; tweak the CSS slightly to make it slightly nicer to look at. Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6 Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'src/plugins')
-rw-r--r--src/plugins/acl/acl_hash_lookup_doc.md (renamed from src/plugins/acl/hash_lookup.md)2
-rw-r--r--src/plugins/acl/acl_multicore_doc.md (renamed from src/plugins/acl/acl-plugin.md)6
2 files changed, 5 insertions, 3 deletions
diff --git a/src/plugins/acl/hash_lookup.md b/src/plugins/acl/acl_hash_lookup_doc.md
index 95524643e25..cb93df04bff 100644
--- a/src/plugins/acl/hash_lookup.md
+++ b/src/plugins/acl/acl_hash_lookup_doc.md
@@ -1,4 +1,4 @@
-ACL plugin constant-time lookup design
+ACL plugin constant-time lookup design {#acl_hash_lookup}
======================================
The initial implementation of ACL plugin performs a trivial for() cycle,
diff --git a/src/plugins/acl/acl-plugin.md b/src/plugins/acl/acl_multicore_doc.md
index 1b44bca959c..b2cf7b9c6d4 100644
--- a/src/plugins/acl/acl-plugin.md
+++ b/src/plugins/acl/acl_multicore_doc.md
@@ -1,4 +1,4 @@
-Multicore support for ACL plugin
+Multicore support for ACL plugin {#acl_multicore}
================================
This captures some considerations and design decisions that I have made,
@@ -20,16 +20,18 @@ at the time of replacing the old ACL being checked, with
the new ACL.
In case an acl_add_replace is being used to replace the rules
-within the existing entry, a reallocation of am->acls[X].rules
+within the existing entry, a reallocation of `am->acls[X].rules`
vector will happen and potentially a change in count.
acl_match_5tuple() has the following code:
+```{.c}
a = am->acls + acl_index;
for (i = 0; i < a->count; i++)
{
r = a->rules + i;
. . .
+```
Ideally we should be immune from a->rules changing,
but the problem arises if the count changes in flight,