Updating release number.

RELEASE_NOTES.md

@@ -2,9 +2,9 @@
 
 This file contains OFSwitch13 release notes (most recent releases first).
 
-## [Release 5.X.X](https://github.com/ljerezchaves/ofswitch13/releases/tag/5.X.X)
+## [Release 5.2.3](https://github.com/ljerezchaves/ofswitch13/releases/tag/5.2.3)
 
-**Release date:** XXX XX, XXXX.  
+**Release date:** Mar 02, 2024.  
 **Works with:** ns-3.38, ns-3.39, and ns-3.40.
 
 - Configuring `OFSwitch13PriorityQueue::QueueFactory` with `DropTailQueue<Packet>` queues by default.

doc/source/conf.py

@@ -26,15 +26,15 @@
 # Tip from https://stackoverflow.com/questions/9899283/how-do-you-change-the-code-example-font-size-in-latex-pdf-output-with-sphinx/9955928
 # Note:  sizes are \footnotesize (8pt), \small (9pt), and \normalsize (10pt).
 
-#from sphinx.highlighting import PygmentsBridge
-#from pygments.formatters.latex import LatexFormatter
+# from sphinx.highlighting import PygmentsBridge
+# from pygments.formatters.latex import LatexFormatter
 #
-#class CustomLatexFormatter(LatexFormatter):
+# class CustomLatexFormatter(LatexFormatter):
 #    def __init__(self, **options):
 #        super(CustomLatexFormatter, self).__init__(**options)
 #        self.verboptions = r"formatcom=\footnotesize"
 #
-#PygmentsBridge.latex_formatter = CustomLatexFormatter
+# PygmentsBridge.latex_formatter = CustomLatexFormatter
 
 # -- General configuration ------------------------------------------------
 
@@ -45,37 +45,37 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.imgmath']
+extensions = ["sphinx.ext.imgmath"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 #
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'ofswitch13'
+master_doc = "ofswitch13"
 
 # General information about the project.
-project = u'OFSwitch13'
-author = u'Luciano Jerez Chaves'
-copyright = u'2023 Computer Networks Laboratory'
+project = "OFSwitch13"
+author = "Luciano Jerez Chaves"
+copyright = "2023 Computer Networks Laboratory"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'5.2.2'
+version = "5.2.3"
 # The full version, including alpha/beta/rc tags.
-release = u'5.2.2'
+release = "5.2.3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -96,7 +96,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # These patterns also affect html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -118,7 +118,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -135,7 +135,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'ns3_html_theme'
+html_theme = "ns3_html_theme"
 
 # 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
@@ -144,13 +144,13 @@
 # html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = ['../../../../doc/']
+html_theme_path = ["../../../../doc/"]
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
 # html_title = 'est vtest'
-html_title = 'Manual'
+html_title = "Manual"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #
@@ -182,7 +182,7 @@
 # bottom, using the given strftime format.
 # The empty string is equivalent to '%b %d, %Y'.
 #
-html_last_updated_fmt = '%b %d, %Y %H:%M'
+html_last_updated_fmt = "%b %d, %Y %H:%M"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -250,19 +250,17 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ns-3doc'
+htmlhelp_basename = "ns-3doc"
 
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # VerbatimBorderColor:  make the box around code samples blend into the background
@@ -275,10 +273,10 @@
     # See above to change the font size of verbatim code blocks
     #
     # 'preamble': '',
-    'preamble': u'''\\usepackage{amssymb}
+    "preamble": """\\usepackage{amssymb}
  \\definecolor{VerbatimBorderColor}{rgb}{1,1,1}
  \\renewcommand{\\sphinxcode}[1]{\\texttt{\\small{#1}}}
-'''
+"""
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -288,14 +286,19 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('ofswitch13', 'ofswitch13.tex', u'OFSwitch13 Module Documentation',
-  u'Computer Networks Laboratory at Unicamp, Brazil', 'manual'),
+    (
+        "ofswitch13",
+        "ofswitch13.tex",
+        "OFSwitch13 Module Documentation",
+        "Computer Networks Laboratory at Unicamp, Brazil",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
 #
-#latex_logo = None
+# latex_logo = None
 
 # If true, show page references after internal links.
 #
@@ -323,22 +326,19 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'ns-3-manual', u'ns-3 Manual',
-     [u'ns-3 project'], 1)
-]
+man_pages = [("index", "ns-3-manual", "ns-3 Manual", ["ns-3 project"], 1)]
 
 # If true, show URL addresses after external links.
 #
 # man_show_urls = False
 
 # -- Options for texinfo output ---------------------------------------
 
-#texinfo_documents = [
+# texinfo_documents = [
 #    (master_doc, 'test', u'test Documentation',
 #    author, 'test', 'One line description of project.',
 #     'Miscellaneous'),
-#]
+# ]
 
 # Documents to append as an appendix to all manuals.
 #

doc/source/ofswitch13-description.rst

@@ -203,8 +203,8 @@ For *ns-3* OpenFlow users who want to port existing code to this new module, ple
 The only required modification to the *ns-3* source code for *OFSwitch13* integration is the inclusion of the new OpenFlow receive callback in the ``CsmaNetDevice`` and ``VirtualNetDevice``.
 The module brings the patch for including this receive callback into *ns-3* source code, available under ``utils/`` directory.
 
-The current *OFSwitch13* stable version is 5.2.2.
-This version is compatible with *ns-3* versions 3.38 and 3.39, and will not compile with older *ns-3* versions.
+The current *OFSwitch13* stable version is 5.2.3.
+This version is compatible with *ns-3* versions 3.38, 3.39, adn 3.40, and will not compile with older *ns-3* versions.
 If you need to use another *ns-3* release, you can check the RELEASE_NOTES file for previous *OFSwitch13* releases and their *ns-3* version compatibility, but keep in mind that old releases may have known bugs and an old API.
 It is strongly recommended to use the latest module version.
 

doc/source/ofswitch13-usage.rst

@@ -31,13 +31,13 @@ Before starting, ensure you have the following minimal requirements installed on
 Compiling the code
 ##################
 
-Clone the *ns-3* source code repository into your machine and checkout a stable version (we are using the ns-3.39):
+Clone the *ns-3* source code repository into your machine and checkout a stable version (we are using the ns-3.40):
 
 .. code-block:: bash
 
   $ git clone https://gitlab.com/nsnam/ns-3-dev.git
   $ cd ns-3-dev
-  $ git checkout -b ns-3.39 ns-3.39
+  $ git checkout -b ns-3.40 ns-3.40
 
 Download the *OFSwitch13* code into the ``contrib/`` folder.
 
@@ -46,22 +46,22 @@ Download the *OFSwitch13* code into the ``contrib/`` folder.
   $ cd contrib/
   $ git clone https://github.com/ljerezchaves/ofswitch13.git
 
-Update the *OFSwitch13* code to a stable version (we are using release 5.2.2, which is compatible with ns-3.39) [#f2]_:
+Update the *OFSwitch13* code to a stable version (we are using release 5.2.3, which is compatible with ns-3.40) [#f2]_:
 
 .. [#f2] Starting at *OFSwitch13* release 5.2.0, the ``cmake`` build system will automatically download and compile the correct version of *BOFUSS* library (Internet connection is required).
          For older *OFSwitch13* releases, we suggest you check the documentation and follow the proper build steps.
 
 .. code-block:: bash
 
   $ cd ofswitch13
-  $ git checkout 5.2.2
+  $ git checkout 5.2.3
 
 Go back to the *ns-3* root directory and patch the *ns-3* code with the appropriated ``ofswitch13`` patch available under the ``ofswitch13/utils/`` directory (check for the correct *ns-3* version):
 
 .. code-block:: bash
 
   $ cd ../../
-  $ patch -p1 < contrib/ofswitch13/utils/ofswitch13-3_39.patch
+  $ patch -p1 < contrib/ofswitch13/utils/ofswitch13-3_40.patch
 
 This patch creates the new OpenFlow receive callback at ``CsmaNetDevice`` and ``VirtualNetDevice``, allowing OpenFlow switch to get raw packets from these devices.
 The module also brings a ``csma-full-duplex`` patch for improving CSMA connections with full-duplex support.