From: Paul Vinciguerra <pvinci@vinciconsulting.com>
Date: Sun, 1 Mar 2020 06:42:28 +0000 (-0500)
Subject: docs: doxygen fix siphon under python3
X-Git-Tag: v20.09-rc0~434
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=vpp.git;a=commitdiff_plain;h=b55aec1c8e0c05520c47c3641c20684fc539f8a1

docs: doxygen fix siphon under python3

siphon used cgi.escape which was deprecated in python 3.2 and
removed in python 3.8.

Update the code to use html.escape instead.

Type: fix

Change-Id: I3192e3f69a4a95fe23cb24e1c29194ba5310932b
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
---

diff --git a/doxygen/siphon/parsers.py b/doxygen/siphon/parsers.py
index 6fe8600d4b3..162205de4ca 100644
--- a/doxygen/siphon/parsers.py
+++ b/doxygen/siphon/parsers.py
@@ -10,7 +10,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import cgi, pyparsing as pp
+import html
+import pyparsing as pp
 
 # Some useful primitives
 ident = pp.Word(pp.alphas + "_", pp.alphas + pp.nums + "_")
@@ -102,7 +103,7 @@ class ParseFunctionMacroStmt(ParserFunctionMacro):
 
 """
 Parser for our struct initializers which are composed from a
-function-like macro, equals sign, and then a normal C struct initalizer
+function-like macro, equals sign, and then a normal C struct initializer
 block.
 """
 class MacroInitializer(ParserFunctionMacro):
@@ -144,6 +145,6 @@ class MacroInitializer(ParserFunctionMacro):
         }
 
         for param in item[2]:
-            r["value"][param[0]] = cgi.escape(param[1])
+            r["value"][param[0]] = html.escape(param[1])
 
         return r