Author: David Spickett Date: 2025-12-09T12:44:00Z New Revision: 2cb8e526f73635ca562221c93ff9f237919049b1
URL: https://github.com/llvm/llvm-project/commit/2cb8e526f73635ca562221c93ff9f237919049b1 DIFF: https://github.com/llvm/llvm-project/commit/2cb8e526f73635ca562221c93ff9f237919049b1.diff LOG: [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 Added: Modified: lldb/docs/resources/contributing.rst Removed: ################################################################################ diff --git a/lldb/docs/resources/contributing.rst b/lldb/docs/resources/contributing.rst index 7e84df41c3fbd..8da87684f39ee 100644 --- a/lldb/docs/resources/contributing.rst +++ b/lldb/docs/resources/contributing.rst @@ -90,19 +90,19 @@ dependency graph manageable, we still have some rules to govern these relationships: * All dependencies between plugins of the same kind must flow in the same - direction (if plugin `A1` depends on plugin `B1`, then `B2` must not depend on - `A2`) + direction (if plugin ``A1`` depends on plugin ``B1``, then ``B2`` must not depend on + ``A2``) * Dependency graph of plugin kinds must not contain loops (dependencies like - `A1->B1`, `B2->C2` and `C3->A3` are forbidden because they induce a cycle in + ``A1->B1``, ``B2->C2`` and ``C3->A3`` are forbidden because they induce a cycle in the plugin kind graph even though the plugins themselves are acyclical) The first of these rules is checked via CMake scripts (using the -`LLDB_ACCEPTABLE_PLUGIN_DEPENDENCIES` property). Dependencies in this category +``LLDB_ACCEPTABLE_PLUGIN_DEPENDENCIES`` property). Dependencies in this category are expected and permitted (subject to other constraints such as that dependency making sense for the particular pair of plugins). Unfortunately, due to historic reasons, not all plugin dependencies follow this rule, which is why we have -another category called `LLDB_TOLERATED_PLUGIN_DEPENDENCIES`. New dependencies +another category called ``LLDB_TOLERATED_PLUGIN_DEPENDENCIES``. New dependencies are forbidden (even though they are accepted by CMake) and existing ones should be removed wherever possible. _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
