Skip to content

Commit 2cb8e52

Browse files
committed
[lldb][docs] Fix plain text markers in Contributing
RST tries to resolve things in single backticks to a reference, which is not the intention here. Double backticks indicates plain text formatting. Fixes warnings in the docs build: contributing.rst:92: WARNING: 'any' reference target not found: A1 contributing.rst:92: WARNING: 'any' reference target not found: B1 contributing.rst:92: WARNING: 'any' reference target not found: B2 contributing.rst:92: WARNING: 'any' reference target not found: A2 contributing.rst:95: WARNING: 'any' reference target not found: A1->B1 contributing.rst:95: WARNING: 'any' reference target not found: B2->C2 contributing.rst:95: WARNING: 'any' reference target not found: C3->A3 contributing.rst:100: WARNING: 'any' reference target not found: LLDB_ACCEPTABLE_PLUGIN_DEPENDENCIES contributing.rst:100: WARNING: 'any' reference target not found: LLDB_TOLERATED_PLUGIN_DEPENDENCIES
1 parent 95bd878 commit 2cb8e52

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lldb/docs/resources/contributing.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,19 +90,19 @@ dependency graph manageable, we still have some rules to govern these
9090
relationships:
9191

9292
* All dependencies between plugins of the same kind must flow in the same
93-
direction (if plugin `A1` depends on plugin `B1`, then `B2` must not depend on
94-
`A2`)
93+
direction (if plugin ``A1`` depends on plugin ``B1``, then ``B2`` must not depend on
94+
``A2``)
9595
* Dependency graph of plugin kinds must not contain loops (dependencies like
96-
`A1->B1`, `B2->C2` and `C3->A3` are forbidden because they induce a cycle in
96+
``A1->B1``, ``B2->C2`` and ``C3->A3`` are forbidden because they induce a cycle in
9797
the plugin kind graph even though the plugins themselves are acyclical)
9898

9999

100100
The first of these rules is checked via CMake scripts (using the
101-
`LLDB_ACCEPTABLE_PLUGIN_DEPENDENCIES` property). Dependencies in this category
101+
``LLDB_ACCEPTABLE_PLUGIN_DEPENDENCIES`` property). Dependencies in this category
102102
are expected and permitted (subject to other constraints such as that dependency
103103
making sense for the particular pair of plugins). Unfortunately, due to historic
104104
reasons, not all plugin dependencies follow this rule, which is why we have
105-
another category called `LLDB_TOLERATED_PLUGIN_DEPENDENCIES`. New dependencies
105+
another category called ``LLDB_TOLERATED_PLUGIN_DEPENDENCIES``. New dependencies
106106
are forbidden (even though they are accepted by CMake) and existing ones should
107107
be removed wherever possible.
108108

0 commit comments

Comments
 (0)