devguide: drop use of mscgen script in builds/make

Currently, it seems easier to upload the diagram images to git than to
try to make the image generation script work with out of the tree builds
and other corner cases.

This means, however, that one must activelly remember to update msc
diagram files, run the script and re-add new png files, if those ever
need to be updated. To raise awareness to that, a watermark was added
to the diagram images.

Also removed configuration steps that added mscgen as dependency
(locally and for workflow builds and readthedocs).

diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml
index 0007322ff4da194ee1459c29260ffc94ec7fdf60..b393e21ac5379f1dde332b9b1f35d63ac468ce2c 100644 (file)
--- a/.github/workflows/builds.yml
+++ b/.github/workflows/builds.yml
@@ -1115,7 +1115,6 @@ jobs:
                 libjansson-dev \
                 libpython2.7 \
                 make \
-                mscgen \
                 parallel \
                 python3-yaml \
                 rustc \

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index f3fa6e66c544bb0abb982c399dad5b471f30ec68..bc23deb5f0825edcf8a254b7c3284a189c767d0f 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -7,7 +7,3 @@ python:
   # Use an empty install section to avoid RTD from picking up a non-python
   # requirements.txt file.
   install: []
-
-build:
-  apt_packages:
-    - mscgen

diff --git a/Makefile.am b/Makefile.am
index cb101f708b17da2461324d4cb8c0903b0a2cb82c..b061fa475eb1d65f62cc669b93bad7fa295f79e9 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -6,7 +6,8 @@ EXTRA_DIST = ChangeLog COPYING LICENSE suricata.yaml.in \
              threshold.config \
              $(SURICATA_UPDATE_DIR) \
             lua \
-            acsite.m4
+            acsite.m4 \
+            scripts/generate-images.sh
 SUBDIRS = $(HTP_DIR) rust src qa rules doc contrib etc python ebpf \
           $(SURICATA_UPDATE_DIR)
 

diff --git a/configure.ac b/configure.ac
index 754237da12195c885a75ff6a0c649b443a919a77..89ee81adb4ca8a3a5f4e81744df91601a6a03ef3 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -2168,18 +2168,6 @@ fi
         AC_DEFINE([CLS],[64],[L1 cache line size])
     fi
 
-# mscgen for devguide images
-    AC_PATH_PROG([HAVE_MSCGEN], mscgen, "no")
-    if test "$HAVE_MSCGEN" = "no"; then
-        enable_mscgen=no
-        echo "WARNING! mscgen package not installed."
-        echo "    Devguide images won't be generated!"
-        echo "    Get mscgen package:"
-        echo "    https://www.mcternan.me.uk/mscgen/"
-        echo "    or install it from your distribution"
-    fi
-    AM_CONDITIONAL([HAVE_MSCGEN], [test "x$enable_mscgen" != "xno" ])
-
 # sphinx for documentation
     AC_PATH_PROG(HAVE_SPHINXBUILD, sphinx-build, "no")
     if test "$HAVE_SPHINXBUILD" = "no"; then

diff --git a/doc/userguide/Makefile.am b/doc/userguide/Makefile.am
index e535462a8a844839772d7ca8e94f7dae174ae8f1..8da69b757e799d406ca2dba35351173a4b439dfb 100644 (file)
--- a/doc/userguide/Makefile.am
+++ b/doc/userguide/Makefile.am
@@ -89,6 +89,5 @@ clean-local:
        rm -rf $(top_builddir)/doc/userguide/_build
        rm -f $(top_builddir)/doc/userguide/suricata*.1
        rm -f $(top_builddir)/doc/userguide/userguide.pdf
-       rm -f $(top_builddir)/doc/userguide/devguide/extending/app-layer/diagrams/*.png
 
 endif # HAVE_SPHINXBUILD

diff --git a/doc/userguide/conf.py b/doc/userguide/conf.py
index 1cb1287d2aee728e0e0e0c014896d496a25360d0..36570c1654f4d3ac94d0f2b8b36ac1da9db81a21 100644 (file)
--- a/doc/userguide/conf.py
+++ b/doc/userguide/conf.py
@@ -135,6 +135,11 @@ if not on_rtd:
         html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
     except:
         html_theme = 'default'
+    def setup(app):
+        if hasattr(app, 'add_css_file'):
+            app.add_css_file('css/suricata.css')
+        else:
+            app.add_stylesheet('css/suricata.css')
 else:
     html_context = {
         'css_files': [
@@ -144,15 +149,6 @@ else:
         ],
     }
 
-def setup(app):
-    # Generate images.
-    subprocess.check_call("./devguide/tools/generate-images.sh")
-    if not on_rtd:
-        if hasattr(app, 'add_css_file'):
-            app.add_css_file('css/suricata.css')
-        else:
-            app.add_stylesheet('css/suricata.css')
-
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.

diff --git a/doc/userguide/devguide/.gitignore b/doc/userguide/devguide/.gitignore
deleted file mode 100644 (file)
index 507d52c..0000000
--- a/doc/userguide/devguide/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-extending/app-layer/diagrams/*.png

diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png
new file mode 100644 (file)
index 0000000..611ae31
Binary files /dev/null and b/doc/userguide/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.png differ

diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png
new file mode 100644 (file)
index 0000000..02de5dc
Binary files /dev/null and b/doc/userguide/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.png differ

diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png
new file mode 100644 (file)
index 0000000..89daed4
Binary files /dev/null and b/doc/userguide/devguide/extending/app-layer/diagrams/TemplateTransaction.png differ

diff --git a/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png
new file mode 100644 (file)
index 0000000..4be7b04
Binary files /dev/null and b/doc/userguide/devguide/extending/app-layer/diagrams/TlsHandshake.png differ

diff --git a/doc/userguide/devguide/tools/generate-images.sh b/scripts/generate-images.sh
similarity index 90%
rename from doc/userguide/devguide/tools/generate-images.sh
rename to scripts/generate-images.sh
index 5db3f953cfdeb0c9443b4ca4ccc743bad830b799..b50b75e0c45b9a7db06e1ae2f83cb346a981258d 100755 (executable)
--- a/doc/userguide/devguide/tools/generate-images.sh
+++ b/scripts/generate-images.sh
@@ -8,7 +8,7 @@ parent_path=$(cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P)
 set -e
 
 cd "$parent_path"
-cd ../extending/app-layer/diagrams
+cd ../doc/userguide/devguide/extending/app-layer/diagrams
 
 for FILE in *.msc ; do
     # call mscgen and convert each file in images dir