[Lldb-commits] [lldb] [lldb][Docs] Remove .txt copy of tutorial (PR #90585)
https://github.com/DavidSpickett closed https://github.com/llvm/llvm-project/pull/90585 ___ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
[Lldb-commits] [lldb] [lldb][Docs] Remove .txt copy of tutorial (PR #90585)
https://github.com/JDevlieghere approved this pull request. https://github.com/llvm/llvm-project/pull/90585 ___ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
[Lldb-commits] [lldb] [lldb][Docs] Remove .txt copy of tutorial (PR #90585)
llvmbot wrote: @llvm/pr-subscribers-lldb Author: David Spickett (DavidSpickett) Changes This was last modified in 4fd3347d6e4b0c873c789528e1c9a1b55990d1b6 in 2021 and was made obsolete by the RST version that edb874b2310dc6eeaa27330ca1b1c013da7bdd65 added in 2019. There are some differences but at this point, I'd bet the RST is the correct one. --- Full diff: https://github.com/llvm/llvm-project/pull/90585.diff 1 Files Affected: - (removed) lldb/docs/lldb-for-gdb-users.txt (-488) ``diff diff --git a/lldb/docs/lldb-for-gdb-users.txt b/lldb/docs/lldb-for-gdb-users.txt deleted file mode 100644 index e5eae376bb4807..00 --- a/lldb/docs/lldb-for-gdb-users.txt +++ /dev/null @@ -1,488 +0,0 @@ -Here's a short precis of how to run lldb if you are familiar with the -gdb command set: - - -1) LLDB Command Structure: - -First some details on lldb command structure to help orient you... - -Unlike gdb's command set, which is rather free-form, we tried to make -the lldb command syntax fairly structured. The commands are all of the -form - - [-options [option-value]] [argument [argument...]] - -The command line parsing is done before command execution, so it is -uniform across all the commands. The command syntax is very simple, -basically arguments, options and option values are all white-space -separated. If you need to put a backslash or double-quote character -in an argument you back-slash it in the argument. That makes the -command syntax more regular, but it also means you may have to -quote some arguments in lldb that you wouldn't in gdb. - -Options can be placed anywhere on the command line, but if the arguments -begin with a "-" then you have to tell lldb that you're done with options -using the "--" option. So for instance, the "process launch" command takes -the "-s" option to mean "stop the process at the first instruction". It's -arguments are the arguments you are passing to the program. So if you wanted -to pass an argument that contained a "-" you would have to do: - -(lldb) process launch -- -program_arg value - -We also tried to reduce the number of special purpose argument -parsers, which sometimes forces the user to be a little more explicit -about stating their intentions. The first instance you'll note of -this is the breakpoint command. In gdb, to set a breakpoint, you -would just say: - -(gdb) break foo.c:12 - -or - -(gdb) break foo - -if foo is a function. As time went on, the parser that tells foo.c:12 -from foo from foo.c::foo (which means the function foo in the file -foo.c) got more and more complex and bizarre, and especially in C++ -there are times where there's really no way to specify the function -you want to break on. The lldb commands are more verbose but also precise. -So you say: - -(lldb) breakpoint set -f foo.c -l 12 - -to set a file & line breakpoint. To set a breakpoint on a function -by name, you do: - -(lldb) breakpoint set -n foo - -This can allow us to be more expressive, so you can say: - -(lldb) breakpoint set -M foo - -to break on all C++ methods named foo, or: - -(lldb) breakpoint set -S alignLeftEdges: - -to set a breakpoint on all ObjC selectors called alignLeftEdges:. It -also makes it easy to compose specifications, like: - -(lldb) breakpoint set -s foo.dylib -n foo - -for all functions called foo in the shared library foo.dylib. Suggestions -on more interesting primitives of this sort are also very welcome. - -So for instance: - -(lldb) breakpoint set -n "-[SKTGraphicView alignLeftEdges:]" - -Just like gdb, the lldb command interpreter does a shortest unique -string match on command names, so the previous command can also be -typed: - -(lldb) b s -n "-[SKTGraphicView alignLeftEdges:]" - -lldb also supports command completion for source file names, symbol -names, file names, etc. Completion is initiated by a hitting a . -Individual options in a command can have different completers, so for -instance the -f option in "breakpoint" completes to source files, the --s option to currently loaded shared libraries, etc... We can even do -things like if you specify -s, and are completing on -f, we will only -list source files in the shared library specified by -s... - -The individual commands are pretty extensively documented, using -the "help" command. And there is an "apropos" command that will -search the help for a particular word and dump a summary help string -for each matching command. - -Finally, there is a mechanism to construct aliases for commonly used -commands. So for instance if you get annoyed typing - -(lldb) b s -f foo.c -l 12 - -you can do: - -(lldb) command alias bfl breakpoint set -f %1 -l %2 -(lldb) bfl foo.c 12 - -We have added a few aliases for commonly used commands (e.g. "step", -"next" and "continue") but we haven't tried to be exhaustive because -in our experience it is more convenient to make the basic commands -unique down to a letter or two, and then learn these sequences than -fill the
[Lldb-commits] [lldb] [lldb][Docs] Remove .txt copy of tutorial (PR #90585)
https://github.com/DavidSpickett created https://github.com/llvm/llvm-project/pull/90585 This was last modified in 4fd3347d6e4b0c873c789528e1c9a1b55990d1b6 in 2021 and was made obsolete by the RST version that edb874b2310dc6eeaa27330ca1b1c013da7bdd65 added in 2019. There are some differences but at this point, I'd bet the RST is the correct one. >From 3943242eb3f484a370cacffcf4c490fe8f62c826 Mon Sep 17 00:00:00 2001 From: David Spickett Date: Tue, 30 Apr 2024 11:15:07 +0100 Subject: [PATCH] [lldb][Docs] Remove .txt copy of tutorial This was last modified in 4fd3347d6e4b0c873c789528e1c9a1b55990d1b6 in 2021 and was made obselete by the RST version that edb874b2310dc6eeaa27330ca1b1c013da7bdd65 added in 2019. There are some differences but at this point, I'd bet the RST is the correct one. --- lldb/docs/lldb-for-gdb-users.txt | 488 --- 1 file changed, 488 deletions(-) delete mode 100644 lldb/docs/lldb-for-gdb-users.txt diff --git a/lldb/docs/lldb-for-gdb-users.txt b/lldb/docs/lldb-for-gdb-users.txt deleted file mode 100644 index e5eae376bb4807..00 --- a/lldb/docs/lldb-for-gdb-users.txt +++ /dev/null @@ -1,488 +0,0 @@ -Here's a short precis of how to run lldb if you are familiar with the -gdb command set: - - -1) LLDB Command Structure: - -First some details on lldb command structure to help orient you... - -Unlike gdb's command set, which is rather free-form, we tried to make -the lldb command syntax fairly structured. The commands are all of the -form - - [-options [option-value]] [argument [argument...]] - -The command line parsing is done before command execution, so it is -uniform across all the commands. The command syntax is very simple, -basically arguments, options and option values are all white-space -separated. If you need to put a backslash or double-quote character -in an argument you back-slash it in the argument. That makes the -command syntax more regular, but it also means you may have to -quote some arguments in lldb that you wouldn't in gdb. - -Options can be placed anywhere on the command line, but if the arguments -begin with a "-" then you have to tell lldb that you're done with options -using the "--" option. So for instance, the "process launch" command takes -the "-s" option to mean "stop the process at the first instruction". It's -arguments are the arguments you are passing to the program. So if you wanted -to pass an argument that contained a "-" you would have to do: - -(lldb) process launch -- -program_arg value - -We also tried to reduce the number of special purpose argument -parsers, which sometimes forces the user to be a little more explicit -about stating their intentions. The first instance you'll note of -this is the breakpoint command. In gdb, to set a breakpoint, you -would just say: - -(gdb) break foo.c:12 - -or - -(gdb) break foo - -if foo is a function. As time went on, the parser that tells foo.c:12 -from foo from foo.c::foo (which means the function foo in the file -foo.c) got more and more complex and bizarre, and especially in C++ -there are times where there's really no way to specify the function -you want to break on. The lldb commands are more verbose but also precise. -So you say: - -(lldb) breakpoint set -f foo.c -l 12 - -to set a file & line breakpoint. To set a breakpoint on a function -by name, you do: - -(lldb) breakpoint set -n foo - -This can allow us to be more expressive, so you can say: - -(lldb) breakpoint set -M foo - -to break on all C++ methods named foo, or: - -(lldb) breakpoint set -S alignLeftEdges: - -to set a breakpoint on all ObjC selectors called alignLeftEdges:. It -also makes it easy to compose specifications, like: - -(lldb) breakpoint set -s foo.dylib -n foo - -for all functions called foo in the shared library foo.dylib. Suggestions -on more interesting primitives of this sort are also very welcome. - -So for instance: - -(lldb) breakpoint set -n "-[SKTGraphicView alignLeftEdges:]" - -Just like gdb, the lldb command interpreter does a shortest unique -string match on command names, so the previous command can also be -typed: - -(lldb) b s -n "-[SKTGraphicView alignLeftEdges:]" - -lldb also supports command completion for source file names, symbol -names, file names, etc. Completion is initiated by a hitting a . -Individual options in a command can have different completers, so for -instance the -f option in "breakpoint" completes to source files, the --s option to currently loaded shared libraries, etc... We can even do -things like if you specify -s, and are completing on -f, we will only -list source files in the shared library specified by -s... - -The individual commands are pretty extensively documented, using -the "help" command. And there is an "apropos" command that will -search the help for a particular word and dump a summary help string -for each matching command. - -Finally, there is a mechanism to construct aliases for commonly used -commands.
