]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
rust: add doc target to build rust docs
authorJason Ish <jason.ish@oisf.net>
Mon, 6 Jul 2020 19:17:26 +0000 (13:17 -0600)
committerVictor Julien <victor@inliniac.net>
Tue, 14 Jul 2020 17:55:04 +0000 (19:55 +0200)
Uses "cargo doc --no-deps" to build the documentation just for
our Suricata package. Without --no-deps, documentation will be
build for all our dependencies as well.

The generated documentation will end up in target/doc as HTML.

rust/Makefile.am

index 317f346515d0bd3abba536a1fbfc17bbb5a242e1..4d86a3bd068e338f1160fdc2451e6b20b67e284b 100644 (file)
@@ -78,3 +78,6 @@ gen/rust-bindings.h:
 else
 gen/rust-bindings.h:
 endif
+
+doc:
+       CARGO_HOME=$(CARGO_HOME) $(CARGO) doc --all-features --no-deps