From: Juliana Fajardini <jufajardini@gmail.com>
Date: Tue, 31 Aug 2021 14:37:09 +0000 (+0100)
Subject: devguide/app-layer: rename /img dir to /diagrams
X-Git-Tag: suricata-7.0.0-beta1~1329
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2cd25e8105f195c763eddd930bc6523e6f1f67e2;p=thirdparty%2Fsuricata.git

devguide/app-layer: rename /img dir to /diagrams

Semantically speaking it makes more sense, because it stores `msc`
files for dynamic image generation.
Updated files that refered to `img` accordingly, too.
---

diff --git a/doc/devguide/.gitignore b/doc/devguide/.gitignore
index cfc63d82f8..faba9ed00c 100644
--- a/doc/devguide/.gitignore
+++ b/doc/devguide/.gitignore
@@ -1,2 +1,2 @@
 _build
-extending/app-layer/img/*.png
+extending/app-layer/diagrams/*.png
diff --git a/doc/devguide/extending/app-layer/img/DnsUnidirectionalTransactions.msc b/doc/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc
similarity index 100%
rename from doc/devguide/extending/app-layer/img/DnsUnidirectionalTransactions.msc
rename to doc/devguide/extending/app-layer/diagrams/DnsUnidirectionalTransactions.msc
diff --git a/doc/devguide/extending/app-layer/img/HTTP2BidirectionalTransaction.msc b/doc/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc
similarity index 100%
rename from doc/devguide/extending/app-layer/img/HTTP2BidirectionalTransaction.msc
rename to doc/devguide/extending/app-layer/diagrams/HTTP2BidirectionalTransaction.msc
diff --git a/doc/devguide/extending/app-layer/img/TemplateTransaction.msc b/doc/devguide/extending/app-layer/diagrams/TemplateTransaction.msc
similarity index 100%
rename from doc/devguide/extending/app-layer/img/TemplateTransaction.msc
rename to doc/devguide/extending/app-layer/diagrams/TemplateTransaction.msc
diff --git a/doc/devguide/extending/app-layer/img/TlsHandshake.msc b/doc/devguide/extending/app-layer/diagrams/TlsHandshake.msc
similarity index 100%
rename from doc/devguide/extending/app-layer/img/TlsHandshake.msc
rename to doc/devguide/extending/app-layer/diagrams/TlsHandshake.msc
diff --git a/doc/devguide/extending/app-layer/transactions.rst b/doc/devguide/extending/app-layer/transactions.rst
index 7cbf82de88..b05bdb334f 100644
--- a/doc/devguide/extending/app-layer/transactions.rst
+++ b/doc/devguide/extending/app-layer/transactions.rst
@@ -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.
 
diff --git a/doc/devguide/tools/generate-images.sh b/doc/devguide/tools/generate-images.sh
index 4a69eb11b2..74b3dc9810 100755
--- a/doc/devguide/tools/generate-images.sh
+++ b/doc/devguide/tools/generate-images.sh
@@ -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