Avoid non-backticked -- under <code>

dodoc converts this to mdash.

Author: mandolaerik

deprecations_to_md.py

@@ -20,11 +20,11 @@
 with open(outfile, 'w') as f:
     f.write(Path(header).read_text())
     for (ver, features) in sorted(by_version.items()):
-        f.write(f"""
-### Features available up to and including --simics-api={ver.str}
+        f.write(rf"""
+### Features available up to and including -\-simics-api={ver.str}
 These features correspond to functionality removed when compiling using
 Simics API {ver.ordinal + 1} or newer. With older Simics API versions, these
-features can be disabled individually by passing <tt>--no-compat=<em>TAG</em></tt>
+features can be disabled individually by passing <tt>-\-no-compat=<em>TAG</em></tt>
 to the `dmlc` compiler.
 """)
         f.write("<dl>\n")

doc/1.2/deprecations-header.md

@@ -63,7 +63,7 @@ be used for a model. When building with the standard Simics build system, this
 is controlled by the `SIMICS_API_VERSION` variable in `make`, or the
 `SIMICS_API`/`MODULE_SIMICS_API` variable in `CMake`.
 
-DMLC also provides the <code>--no-compat=_tag_</code> flag, which disables the
+DMLC also provides the <code>-\-no-compat=_tag_</code> flag, which disables the
 feature represented by _`tag`_. The available tags are listed in the next
 section. The tag also controls the name of a global boolean parameter that the
 DML program may use to check whether the feature is available. The parameter's

doc/1.4/deprecations-header.md

@@ -63,7 +63,7 @@ be used for a model. When building with the standard Simics build system, this
 is controlled by the `SIMICS_API_VERSION` variable in `make`, or the
 `SIMICS_API`/`MODULE_SIMICS_API` variable in `CMake`.
 
-DMLC also provides the <code>--no-compat=_tag_</code> flag, which disables the
+DMLC also provides the <code>-\-no-compat=_tag_</code> flag, which disables the
 feature represented by _`tag`_. The available tags are listed in the next
 section. The tag also controls the name of a global boolean parameter that the
 DML program may use to check whether the feature is available. The parameter's

doc/1.4/running-dmlc.md

@@ -67,7 +67,7 @@ The following are the available command line options to
 
 <dl><dt>
 
--h, --help
+-h, -\-help
 </dt><dd>
 
 Print usage help.
@@ -89,7 +89,7 @@ string, a boolean, an integer, or a floating point
 constant. The parameter will appear in the top-level scope.
 </dd><dt>
 
---dep
+-\-dep
 </dt><dd>
 
 Output makefile rules describing dependencies.
@@ -110,7 +110,7 @@ This generates a DML debug file leveraged by debug-simics, and
 causes generated C code to follow the DML code more closely.
 </dd><dt>
 
---coverity
+-\-coverity
 </dt><dd>
 
 Adds Synopsys® Coverity® analysis annotations to suppress common false positives
@@ -124,59 +124,59 @@ unexpected behavior. Because of this, it's recommended that `--coverity` is
 only used when needed.
 </dd><dt>
 
---warn=*tag*
+-\-warn=*tag*
 </dt><dd>
 
 Enable selected warnings. The tags can be found using
 the `-T` option.
 </dd><dt>
 
---nowarn=*tag*
+-\-nowarn=*tag*
 </dt><dd>
 
 Suppress selected warnings. The tags can be found using
 the `-T` option.
 </dd><dt>
 
---werror
+-\-werror
 </dt><dd>
 
 Turn all warnings into errors.
 </dd><dt>
 
---strict
+-\-strict
 </dt><dd>
 
 Report errors for some constructs that will be forbidden in
 future versions of the DML language
 </dd><dt>
 
---noline
+-\-noline
 </dt><dd>
 
 Suppress line directives for the C preprocessor so
 that the C code can be debugged.
 </dd><dt>
 
---info
+-\-info
 </dt><dd>
 
 Enable the output of an XML file describing register layout.
 </dd><dt>
 
---version
+-\-version
 </dt><dd>
 
 Print version information.
 </dd><dt>
 
---simics-api=*version*
+-\-simics-api=*version*
 </dt><dd>
 
 Use Simics API version *version*.
 </dd><dt>
 
---max-errors=*N*
+-\-max-errors=*N*
 </dt><dd>
 
 Limit the number of error messages to *N*.

py/dml/dmlc.py

@@ -318,7 +318,7 @@ def main(argv):
     # <file>dmlc</file>:
     # <dl>
 
-    # <dt>-h, --help</dt>
+    # <dt>-h, -\-help</dt>
     # <dd>Print usage help.</dd>
 
     # <dt>-I <i>path</i></dt>
@@ -341,22 +341,22 @@ def main(argv):
         default=[],
         help='set compile time constant NAME to VALUE')
 
-    # <dt>--dep</dt>
+    # <dt>-\-dep</dt>
     # <dd>Output makefile rules describing dependencies.</dd>
     parser.add_argument(
         '--dep', action='store',
         help='generate makefile dependencies')
 
-    # <dt>--no-dep-phony</dt>
-    # <dd>With --dep, avoid addition of a phony target for each dependency
+    # <dt>-\-no-dep-phony</dt>
+    # <dd>With -\-dep, avoid addition of a phony target for each dependency
     # other than the main file.</dd>
     parser.add_argument(
         '--no-dep-phony', action='store_true',
         help='With --dep, avoid addition of a phony target for each'
         + ' dependency other than the main file.')
 
-    # <dt>--dep-target</dt>
-    # <dd>With --dep, change the target of the rule emitted by dependency
+    # <dt>-\-dep-target</dt>
+    # <dd>With -\-dep, change the target of the rule emitted by dependency
     # generation. Specify multiple times to have multiple targets.</dd>
     parser.add_argument(
         '--dep-target', action='append', metavar='TARGET', default=[],
@@ -366,7 +366,7 @@ def main(argv):
 
     # <dt>-T</dt>
     # <dd>Show tags on warning messages. The tags can be used with
-    # the <tt>--nowarn</tt> and <tt>--warn</tt> options.</dd>
+    # the <tt>-\-nowarn</tt> and <tt>-\-warn</tt> options.</dd>
     parser.add_argument(
         '-T', dest='include_tag', action='store_true',
         help='show tags on warning messages')
@@ -384,7 +384,7 @@ def main(argv):
         '-g', dest='debuggable', action='store_true',
         help='generate artifacts and C code that allow for easier debugging')
 
-    # <dt>--warn=<i>tag</i></dt>
+    # <dt>-\-warn=<i>tag</i></dt>
     # <dd>Enable selected warnings. The tags can be found using
     # the <tt>-T</tt> option.</dd>
     parser.add_argument(
@@ -393,7 +393,7 @@ def main(argv):
         default=[],
         help='enable warning TAG')
 
-    # <dt>--nowarn=<i>tag</i></dt>
+    # <dt>-\-nowarn=<i>tag</i></dt>
     # <dd>Suppress selected warnings. The tags can be found using
     # the <tt>-T</tt> option.</dd>
     parser.add_argument(
@@ -404,7 +404,7 @@ def main(argv):
 
     parser.add_argument('--help-warn', action=WarnHelpAction,
                         help='List warning tags available for --warn/--nowarn')
-    # <dt>--werror</dt>
+    # <dt>-\-werror</dt>
     # <dd>Turn all warnings into errors.</dd>
     parser.add_argument('--werror', action='store_true',
                       help='Turn all warnings into errors')
@@ -415,7 +415,7 @@ def main(argv):
     parser.add_argument('--strict-int', action='store_true',
                         help='Alias for --no-compat=dml12_int')
 
-    # <dt>--coverity</dt>
+    # <dt>-\-coverity</dt>
     # <dd> Adds Synopsys® Coverity® analysis annotations to suppress common
     # false positives in generated C code created from DML 1.4 device models.
     # </dd>
@@ -424,20 +424,20 @@ def main(argv):
         help=('Adds Synopsys® Coverity® analysis annotations to suppress '
                 + 'common false positives in generated C code created from '
                 + 'DML 1.4 device models.'))
-    # <dt>--noline</dt>
+    # <dt>-\-noline</dt>
     # <dd>Suppress line directives for the C preprocessor so
     # that the C code can be debugged.</dd>
     parser.add_argument(
         '--noline', action='store_true',
         help='suppress line directives in generated C code')
 
-    # <dt>--info</dt>
+    # <dt>-\-info</dt>
     # <dd>Enable the output of an XML file describing register layout.</dd>
     parser.add_argument(
         '--info', action='store_true',
         help='generate XML file describing register layout')
 
-    # <dt>--simics-api=<i>version</i></dt>
+    # <dt>-\-simics-api=<i>version</i></dt>
     # <dd>Use Simics API version <i>version</i>.</dd>
     parser.add_argument(
         '--simics-api', action='store',
@@ -446,7 +446,7 @@ def main(argv):
         help=('specify Simics API version (default %s)'
               % default_api_version()))
 
-    # <dt>--max-errors=<i>N</i></dt>
+    # <dt>-\-max-errors=<i>N</i></dt>
     # <dd>Limit the number of error messages to <i>N</i>.</dd>
     parser.add_argument(
         '--max-errors', action='store',
@@ -457,7 +457,7 @@ def main(argv):
     # </dl>
     # </add>
 
-    # <dt>--no-compat=<i>TAG</i></dt>
+    # <dt>-\-no-compat=<i>TAG</i></dt>
     # <dd>Disable a compatibility feature</dd>
     parser.add_argument(
         '--no-compat', action='append', default=[],