From 4ffd42109c50d19b00a97ec7cbc5bcd30f844edc Mon Sep 17 00:00:00 2001 From: Thomas Winget Date: Sat, 29 Feb 2020 19:53:07 -0500 Subject: [PATCH] some tooling documentation --- docs/tooling.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/tooling.txt diff --git a/docs/tooling.txt b/docs/tooling.txt new file mode 100644 index 000000000..1c1bd1270 --- /dev/null +++ b/docs/tooling.txt @@ -0,0 +1,24 @@ +What is a RouterEvent? + + A RouterEvent is a way of representing a conceptual event that took place in a "router" (relay or client). + + RouterEvents are used in order to collect information about a network all in one place and preserve causality. + +How do I make a new RouterEvent? + + Add your event following the structure in llarp/tooling/router_events.{hpp,cpp} + + Add your event to pybind in pybind/llarp/tooling/router_event.cpp + +What if a class my event uses is missing members in pybind? + + Find the relevant file pybind/whatever/class.cpp and remedy that! + +What if I need to refer to classes which aren't available already in pybind? + + Add pybind/namespace/namespace/etc/class.cpp and pybind it! + + You will need to edit the following files accordingly: + pybind/common.hpp + pybind/module.cpp + pybind/CMakeLists.txt