Commit 578712c1 authored by David B. Kinder's avatar David B. Kinder Committed by Anas Nashif
Browse files

doc: fix uses of back quotes in documentation



ReST defines interpreted text roles where text enclosed by single quotes
can be "intrepreted", for example :ref:`some name` becomes a link to
a label anywhere in the doc set named "some name", :c:func:`funcname()`
becomes a link to the API documentation for "funcname", and
:option:`CONFIG_NAME` becomes a link to, in our case, the documentation
for the generated Kconfig option.

This patch fixes uses of `some name` (without a role) by either adding
an explicit role, or changing to ``some name``, which indicates inline
code block formatting (most likely what was intended).

This is a precursor to changing the default behavior of interpreted
text to treat `some name` as :any:`some name` (as configured in
doc/conf.py), which would attempt to create a link to any available
definition of "some name".

We may not change this default role behavior, but it becomes an option
after the fixes in this patch.  In any case, this patch fixes incorrect
uses of single-quoted text (possibly introduced because GitHub's
markdown language uses single-quoted text for inline code formatting).

Jira: ZEP-2414

Signed-off-by: default avatarDavid B. Kinder <david.b.kinder@intel.com>
parent a488946d
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ This is a free-to-use tool that records and visualizes events such as thread
scheduling and interrupts, and is helpful to find unintended interactions
and resource conflicts on complex systems.  The tool is available for the
major development platforms, and requires hardware support.  Please consult
the `product web page <https://www.segger.com/systemview.html?p=1731>` for
the `product web page <https://www.segger.com/systemview.html?p=1731>`_ for
more information.

Source code in this package has been obtained from the product web page