[Lldb-commits] [lldb] [lldb][docs] Fix "Developing LLDB" table of contents (PR #113166)
via lldb-commits
lldb-commits at lists.llvm.org
Mon Oct 21 07:10:24 PDT 2024
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: Michael Buch (Michael137)
<details>
<summary>Changes</summary>
Currently all the headings marked as `#` show up
as a top-level entry in the `Developing LLDB`
toctree. This patch marks these as `##` so only
`Adding Programming Language Support` is displayed
in the table of contents.
---
Full diff: https://github.com/llvm/llvm-project/pull/113166.diff
1 Files Affected:
- (modified) lldb/docs/resources/addinglanguagesupport.md (+5-5)
``````````diff
diff --git a/lldb/docs/resources/addinglanguagesupport.md b/lldb/docs/resources/addinglanguagesupport.md
index 28789048643d77..524d0b5f2940aa 100644
--- a/lldb/docs/resources/addinglanguagesupport.md
+++ b/lldb/docs/resources/addinglanguagesupport.md
@@ -49,21 +49,21 @@ clearer that evaluation with the static `Module`-returned `TypeSystem` instances
make no sense, and have them error out on those calls. But either approach is
fine.
-# Creating Types
+## Creating Types
Your `TypeSystem` will need an approach for creating types based on a set of
`Module`s. If your type info is going to come from DWARF info, you will want to
subclass [DWARFASTParser](https://github.com/llvm/llvm-project/blob/main/lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParser.h).
-# Add Expression Evaluation Support
+## Add Expression Evaluation Support
Expression Evaluation support is enabled by implementing the relevant methods on
a `TypeSystem`-derived class. Search for `Expression` in the
[TypeSystem header](https://github.com/llvm/llvm-project/blob/main/lldb/include/lldb/Symbol/TypeSystem.h)
to find the methods to implement.
-# Type Completion
+## Type Completion
There are three levels of type completion, each requiring more type information:
1. Pointer size: When you have a forward decl or a reference, and that's all you
@@ -76,7 +76,7 @@ There are three levels of type completion, each requiring more type information:
Ensure you never complete more of a type than is needed for a given situation.
This will keep your type system from doing more work than necessary.
-# Language and LanguageRuntime Plugins
+## Language and LanguageRuntime Plugins
If you followed the steps outlined above, you already have taught LLDB a great
deal about your language. If your language's runtime model and fundamental data
@@ -92,4 +92,4 @@ These tasks are covered by two plugins:
information (for example dynamic type resolution).
* a `Language` plugin, which provides LLDB with a static view of your language;
questions that are statically knowable and do not require a process are
- answered by this plugin (for example data formatters).
\ No newline at end of file
+ answered by this plugin (for example data formatters).
``````````
</details>
https://github.com/llvm/llvm-project/pull/113166
More information about the lldb-commits
mailing list