summaryrefslogtreecommitdiff
path: root/rustlibd/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'rustlibd/README.org')
-rw-r--r--rustlibd/README.org21
1 files changed, 21 insertions, 0 deletions
diff --git a/rustlibd/README.org b/rustlibd/README.org
new file mode 100644
index 0000000000..d30991b7f3
--- /dev/null
+++ b/rustlibd/README.org
@@ -0,0 +1,21 @@
+* Rust Library Based Daemon Skeleton
+
+This is the skeleton for a rust library based FRR daemon.
+
+** Development
+*** Editor/LSP support
+
+In order for LSP support to work you will likely need to do a couple things if
+you use a build directory.
+
+- Create 2 symlinks from the generated files in ~BUILDDIR/rustlibd~ for
+ `build.rs` and `wrapper.h` e.g. if your build dir is in `frr/build`, and
+ create a `Cargo.toml` in the source directory that points to itself. Example
+ follows:
+
+ #+begin_src bash
+ cd frr/rustlibd
+ ln -s ../build/rustlibd/build.rs .
+ ln -s ../build/rustlibd/wrapper.h .
+ sed -e 's,@srcdir@/,,g' < Cargo.toml.in > Cargo.toml
+ #+end_src