You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[lldb][docs] Fix header level warnings in a few documents
All these are using H1 for the main heading but H3 for the
rest, Sphinx warns about this:
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]
Copy file name to clipboardExpand all lines: lldb/docs/use/tutorials/writing-custom-commands.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Writing Custom Commands
2
2
3
-
###Create a new command using a Python function
3
+
## Create a new command using a Python function
4
4
5
5
Python functions can be used to create new LLDB command interpreter commands,
6
6
which will work like all the natively defined lldb commands. This provides a
@@ -51,7 +51,7 @@ command definition form can't do the right thing.
51
51
|`result`|`lldb.SBCommandReturnObject`| A return object which encapsulates success/failure information for the command and output text that needs to be printed as a result of the command. The plain Python "print" command also works but text won't go in the result by default (it is useful as a temporary logging facility). |
52
52
|`internal_dict`|`python dict object`| The dictionary for the current embedded script session which contains all variables and functions. |
53
53
54
-
###Create a new command using a Python class
54
+
## Create a new command using a Python class
55
55
56
56
Since lldb 3.7, Python commands can also be implemented by means of a class
57
57
which should implement the following interface:
@@ -103,7 +103,7 @@ print("my command does lots of cool stuff", file=result)
103
103
`SBCommandReturnObject` and `SBStream` both support this file-like behavior by
104
104
providing `write()` and `flush()` calls at the Python layer.
105
105
106
-
###Parsed Commands
106
+
## Parsed Commands
107
107
108
108
The commands that are added using this class definition are what lldb calls
109
109
"raw" commands. The command interpreter doesn't attempt to parse the command,
@@ -207,7 +207,7 @@ Mostly useful for handle_completion where you get passed the long option.
207
207
"""
208
208
```
209
209
210
-
###Completion
210
+
## Completion
211
211
212
212
lldb will handle completing your option names, and all your enum values
213
213
automatically. If your option or argument types have associated built-in completers,
@@ -280,7 +280,7 @@ You can optionally include a "descriptions" key, whose value is a parallel array
280
280
of description strings, and the completion will show the description next to
281
281
each completion.
282
282
283
-
###Loading Commands
283
+
## Loading Commands
284
284
285
285
One other handy convenience when defining lldb command-line commands is the
286
286
command "command script import" which will import a module specified by file
0 commit comments