]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
devguide/app-layer: rename /img dir to /diagrams
authorJuliana Fajardini <jufajardini@gmail.com>
Tue, 31 Aug 2021 14:37:09 +0000 (15:37 +0100)
committerVictor Julien <victor@inliniac.net>
Wed, 29 Sep 2021 12:51:59 +0000 (14:51 +0200)
Semantically speaking it makes more sense, because it stores `msc`
files for dynamic image generation.
Updated files that refered to `img` accordingly, too.

doc/devguide/.gitignore
doc/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc [moved from doc/devguide/extending/app-layer/img/DnsUnidirectionalTransactions.msc with 100% similarity]
doc/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc [moved from doc/devguide/extending/app-layer/img/HTTP2BidirectionalTransaction.msc with 100% similarity]
doc/devguide/extending/app-layer/diagrams/TemplateTransaction.msc [moved from doc/devguide/extending/app-layer/img/TemplateTransaction.msc with 100% similarity]
doc/devguide/extending/app-layer/diagrams/TlsHandshake.msc [moved from doc/devguide/extending/app-layer/img/TlsHandshake.msc with 100% similarity]
doc/devguide/extending/app-layer/transactions.rst
doc/devguide/tools/generate-images.sh

index cfc63d82f8141bd0b84ff7fbf38505e9d686a7ef..faba9ed00cb40e5736e2061f58c782166f1a4bae 100644 (file)
@@ -1,2 +1,2 @@
 _build
-extending/app-layer/img/*.png
+extending/app-layer/diagrams/*.png
index 7cbf82de88ac22d3f711f3c75388aef30e8fbb47..b05bdb334f195f78debdd101cd0b54c1f09bd1e6 100644 (file)
@@ -227,7 +227,7 @@ Sequence Diagrams
 
 A DNS transaction in Suricata can be considered unidirectional:
 
-.. image:: img/DnsUnidirectionalTransactions.png
+.. image:: diagrams/DnsUnidirectionalTransactions.png
   :width: 600
   :alt: A sequence diagram with two entities, Client and Server, with an arrow going from the Client to the Server, labeled "DNS Request". After that, there is a dotted line labeled "Transaction Completed".
 
@@ -236,13 +236,13 @@ overlap, scenario not shown in this Sequence Diagram):
 
 .. TODO add another example for overlapping HTTP2 transaction
 
-.. image:: img/HTTP2BidirectionalTransaction.png
+.. image:: diagrams/HTTP2BidirectionalTransaction.png
   :width: 600
   :alt: A sequence diagram with two entities, Client and Server, with an arrow going from the Client to the Server labeled "Request" and below that an arrow going from Server to Client labeled "Response". Below those arrows, a dotted line indicates that the transaction is completed.
 
 A TLS Handshake is a more complex example, where several messages are exchanged before the transaction is considered completed:
 
-.. image:: img/TlsHandshake.png
+.. image:: diagrams/TlsHandshake.png
   :width: 600
   :alt: A sequence diagram with two entities, Client and Server, with an arrow going from the Client to the Server labeled "ClientHello" and below that an arrow going from Server to Client labeled "ServerHello". Below those arrows, several more follow from Server to Client and vice-versa, before a dotted line indicates that the transaction is finally completed.
 
@@ -253,7 +253,7 @@ Suricata has a template protocol for educational purposes, which has simple bidi
 
 A completed transaction for the template looks like this:
 
-.. image:: img/TemplateTransaction.png
+.. image:: diagrams/TemplateTransaction.png
   :width: 600
   :alt: A sequence diagram with two entities, Client and Server, with an arrow going from the Client to the Server, labeled "Request". An arrow below that first one goes from Server to Client.
 
index 4a69eb11b2276d4c2aa092a6cb570c08f12ddb60..74b3dc9810cfcdcc99a1cd0d409a48cf4df17750 100755 (executable)
@@ -3,7 +3,7 @@
 # Script to generate Sequence Diagram images with mscgen
 #
 
-cd extending/app-layer/img
+cd extending/app-layer/diagrams
 
 for FILE in *.msc ; do
     # call mscgen and convert each file in images dir