Commit Graph

188 Commits

Author SHA1 Message Date
Daniel Malea 4d3c008c7d Fix document typos, indentation in python code, and API examples.
Patch by Bruce Mitchener!

llvm-svn: 175002
2013-02-12 20:01:49 +00:00
Greg Clayton faf6df6e6e Added new "env" regular expression alias into the evironment settings section of the GDB/LLDB commands.
llvm-svn: 174993
2013-02-12 18:54:34 +00:00
Enrico Granata d7760bffda Describe the data formatters as part of the architecture
llvm-svn: 173734
2013-01-29 00:42:12 +00:00
Enrico Granata 04700d5564 Changing the Python reference document to be more explicit in discouraging usage of lldb.{debugger,...} convenience variables for formatters and other non-interactive Python extensions
llvm-svn: 172663
2013-01-16 22:25:17 +00:00
Jim Ingham 4e117582d5 Fix for the separation between -i and -u in expression.
llvm-svn: 172505
2013-01-15 02:57:33 +00:00
Daniel Malea 2e64aeda89 minor update to status page: C++ exception breakpoints work on linux
llvm-svn: 172142
2013-01-10 23:13:06 +00:00
Daniel Malea 1e6764b485 Simplify build instructions
- setting PYTHONPATH is no longer needed to run the lldb CLI on Linux.
- added instructions for setting PYTHONPATH correctly for running scripts in the native interpreter

llvm-svn: 171566
2013-01-05 00:16:08 +00:00
Jason Molenda 2114187370 A few small tweaks to the symbolication page.
llvm-svn: 171542
2013-01-04 22:37:21 +00:00
Greg Clayton 6aede697c9 Added a bit more explanation for the python modules that aid with symbolication.
llvm-svn: 171500
2013-01-04 19:01:39 +00:00
Greg Clayton cbaf730927 Added a page that describes how to to manual symbolication with LLDB from the command line, from python, and also how to use the build in modules to do symbolication.
llvm-svn: 171477
2013-01-04 18:18:21 +00:00
Greg Clayton ed74db7cd5 http://llvm.org/bugs/show_bug.cgi?id=14629
Fixed incorrect documentation.

llvm-svn: 170479
2012-12-19 00:15:34 +00:00
Daniel Malea 66d5714ae6 Mention how to do a (Linux) release build on the build instructions page.
Also, a few minor fixes:
- paragraph formatting
- capitalize "Python" where appropriate

llvm-svn: 170372
2012-12-17 21:32:49 +00:00
Daniel Malea 41ed60b7d8 Add GCC instructions to build section of website
llvm-svn: 170236
2012-12-14 20:02:21 +00:00
Jim Ingham bd15897f35 Added a warning about using the lldb.target, etc. for anything other than convenience when using the
script command.

llvm-svn: 170014
2012-12-12 20:23:52 +00:00
Sean Callanan a87ecb43ab Minor grammar and style fixes in documentation.
<rdar://problem/12861963>
<rdar://problem/12861904>

llvm-svn: 169997
2012-12-12 18:02:47 +00:00
Jason Molenda 69740d6869 Add examples of how to set env vars for the inferior process from lldb.
llvm-svn: 169552
2012-12-06 22:10:27 +00:00
Greg Clayton 20921e1883 Added malloc introspection commands for Mac OS X for both GDB and LLDB.
llvm-svn: 168315
2012-11-19 17:47:29 +00:00
Greg Clayton e4afd4d175 Add more info for shell commands being used by DebugSymbols.framework.
llvm-svn: 168314
2012-11-19 17:38:24 +00:00
Greg Clayton 6670c7e4b4 Added symbols page for Mac OS X that explains how DebugSymbols.framework can be customized.
llvm-svn: 168224
2012-11-16 23:50:32 +00:00
Jim Ingham ef404fc9c6 Explain how to use "expr -u" as the lldb equivalent of "set unwind-on-signal 0; print".
llvm-svn: 168071
2012-11-15 19:13:33 +00:00
Daniel Malea f1759fa915 Fix minor typo on build page.
llvm-svn: 167770
2012-11-12 22:34:24 +00:00
Daniel Malea cfe417ed3e Update platform section to mention Linux/FreeBSD local debugging support, and also mention that LLDB builds on Linux with clang and libstdc++/libc++.
llvm-svn: 167768
2012-11-12 22:32:00 +00:00
Daniel Malea 44a3d901c0 Test commit: clean up C++11 options in lldb (on Linux) build page
llvm-svn: 167677
2012-11-10 18:09:36 +00:00
Jason Molenda c500aea639 Mark Objective-C 2.0 status as "Not applicable" on Linux.
The objc 2 runtime doesn't run on Linux.

llvm-svn: 167606
2012-11-09 06:16:12 +00:00
Jason Molenda 1f3ea66e23 Update the status page to include Linux status information,
patch from Dan Malea, daniel.malea@intel.com.

llvm-svn: 167605
2012-11-09 06:14:39 +00:00
Jason Molenda aba75e6495 Show both lldb-168 and earlier "bt -c 5" as well as lldb-169 and later "bt 5" usage.
llvm-svn: 166839
2012-10-26 23:56:03 +00:00
Jason Molenda ca76ecda8a Document "bt <n>" for "thread backtrace -c <n>", note that it is available
in lldb-169 and later.

llvm-svn: 166838
2012-10-26 23:52:49 +00:00
Greg Clayton 13b1213de3 Updated the "breakpoint command add" documentation and fixed the web site docs for the signature of the python breakpoint callback functions.
llvm-svn: 166789
2012-10-26 17:53:21 +00:00
Jason Molenda a3843dd2a5 Document target.source-map as the replacement for gdb's directory command.
llvm-svn: 166753
2012-10-26 04:38:09 +00:00
Jim Ingham 06933e2af0 Add section on creating convenience variables.
llvm-svn: 166697
2012-10-25 17:35:53 +00:00
Enrico Granata 44818163ed <rdar://problem/12523238> Commit 3 of 3
Changed all relevant test cases to verify that MightHaveChildren() works correctly for objects of interest
Added a bunch of convenience methods for test cases to use: target(), process(), thread() and frame() which mimic the lldb.X convenience variables
As a bonus, edited the documentation on the website to describe the new method available for synthetic children providers writers to implement!

That's all folks!

llvm-svn: 166535
2012-10-24 01:23:57 +00:00
Jason Molenda 60c9dae2bf Reorder the sections of "USE AND EXTENSIONS" so the most useful to
users new to lldb are at the top.

llvm-svn: 166381
2012-10-20 21:01:22 +00:00
Jason Molenda 96c53b71cb Rename the lldb/gdb command page.
Remove 'Customization', 'Documentation', and 'FAQ' pages from the sidebar's "USE AND EXTENSION"
section.  These pages have no content.  If someone ever wants to add content to them, we can
re-add them to the sidebar.

llvm-svn: 166380
2012-10-20 21:00:03 +00:00
Jason Molenda 3929249281 Remove -w write flag to watch set var from tutorial.html.
Fix one gdb example that had an "(lldb)" prompt in the lldb/gdb page.

llvm-svn: 166297
2012-10-19 19:52:12 +00:00
Jim Ingham 5114f91a43 Mention "break set -r" and "break set -p".
llvm-svn: 166238
2012-10-18 21:54:05 +00:00
Greg Clayton 84ffa16de6 Added register write examples and also how to modify the pc. For this we show and example of GDB using the "jump" command, and LLDB using "register write" with an expression.
llvm-svn: 166127
2012-10-17 20:58:52 +00:00
Greg Clayton 3c6aa277b9 Patch from Daniel Malea -- Updated build instructions for Linux.
llvm-svn: 165964
2012-10-15 20:39:39 +00:00
Jason Molenda 48d88919d7 Remove two more cases of "-w write" being specified
to watch var set/exp -- that's now the default in the
shipped lldb.

llvm-svn: 165333
2012-10-05 20:28:11 +00:00
Jason Molenda 80f1663a9c Improve shortened examples of the watchpoint commands.
Document "f <n>" selects frame n.  
"t <n>" selects thread n but this was just added to TOT
so most people won't have access to an lldb that accepts it.

llvm-svn: 165332
2012-10-05 20:25:53 +00:00
Jason Molenda 766e7277ed one more small fix for the gdb-comes-first column order
llvm-svn: 165301
2012-10-05 05:31:01 +00:00
Jason Molenda 840e2819c6 typeo
llvm-svn: 165297
2012-10-05 04:29:13 +00:00
Jason Molenda 293e210a59 typeo
llvm-svn: 165296
2012-10-05 04:28:53 +00:00
Jason Molenda 74f29358b1 Update the intro paragraph of text describing the table below to
reflect that the columns were just swapped.

llvm-svn: 165295
2012-10-05 04:28:33 +00:00
Jason Molenda c8fd91603a Swap the columns in the lldb & gdb command comparison table. I
often hear feedback from people that having the lldb commands on
the left hand side is non-intuitive -- they say "I want a *gdb* to
*lldb* table, not a *lldb* to *gdb* table".  It doesn't seem odious
to go from the right-hand column to the left hand column but I've
heard this same feedback enough that it's also pointless to keep
the format lldb-first, gdb-second when it was an arbitrary choice
to begin with.

llvm-svn: 165294
2012-10-05 04:26:06 +00:00
Jason Molenda e5b55eadda Add examples of using the kdp-remote and gdb-remote commands to connect to
gdb-remote protocol and kdp protocol systems.

llvm-svn: 164730
2012-09-26 22:42:25 +00:00
Filipe Cabecinhas d685840a5e Don't force libc++ and c++11 on everyone.
Make the flags part of configure and make invocations, for now.

llvm-svn: 163911
2012-09-14 17:09:06 +00:00
Jim Ingham 02430574d5 Add "info func" to the list.
llvm-svn: 163669
2012-09-12 00:38:19 +00:00
Jim Ingham b520a104c1 Add the "expr" command to the gdb command equivalents.
llvm-svn: 162617
2012-08-24 22:56:40 +00:00
Enrico Granata 5eb99ccd3e Providing an additional Python command example
llvm-svn: 162600
2012-08-24 21:20:14 +00:00
Johnny Chen a7e1d39309 Update build instructions. Patch from "Kopec, Matt" <matt.kopec@intel.com>!
llvm-svn: 162001
2012-08-16 00:08:21 +00:00
Enrico Granata 40d557107f <rdar://problem/11975483> Removing user-visible references to 'dict' as a parameter name for Python summary-generating functions since it is a Python keyword.
llvm-svn: 161467
2012-08-08 02:06:30 +00:00
Greg Clayton 3e3b48e669 Added information on how to get API documentation in a "Documentation" section.
llvm-svn: 159434
2012-06-29 16:25:05 +00:00
Sean Callanan a69e64481d Added a GDB equivalent for saving binary memory
data.

llvm-svn: 157192
2012-05-21 17:01:59 +00:00
Enrico Granata e89f3fe3f3 Fixing a typo in the lldb-gdb webpage
llvm-svn: 156779
2012-05-14 21:39:38 +00:00
Jim Ingham db81e83c2e Add "echo" -> "script print".
llvm-svn: 156624
2012-05-11 18:01:15 +00:00
Enrico Granata 2980927107 Update the docs to reflect the recent changes to categories
llvm-svn: 156020
2012-05-02 21:13:16 +00:00
Enrico Granata 19e7a185f2 Mentioning in the docs that Python commands can have docstrings
llvm-svn: 156018
2012-05-02 21:00:41 +00:00
Enrico Granata 4a3274af96 Removing cascading through inheritance chains for data formatters
This is the feature that allowed the user to have things like:

class Base { ... };
class Derived : public Base { ... };

and have formatters defined for Base work automatically for Derived.

This feature turned out to be too expensive since it requires completing types.

This patch takes care of removing cascading (other than typedefs chain cascading), updating the test suite accordingly, and adding required Cocoa class names to keep the AppKit formatters working

llvm-svn: 153272
2012-03-22 19:55:55 +00:00
Johnny Chen 907c233591 Add "frame info" command to the "Examining Thread State" section, as suggested by Andrew Trick.
llvm-svn: 153204
2012-03-21 18:14:37 +00:00
Enrico Granata a7a3a4c79e Editing documentation to reflect recent changes in the formatters support
llvm-svn: 153068
2012-03-19 23:57:06 +00:00
Enrico Granata 3713cadd09 Changed the URL to the CFString summary provider; slightly reworded the relevant piece of content
llvm-svn: 152972
2012-03-17 02:14:46 +00:00
Enrico Granata 0fddd5631d Pointing users to a new example of synthetic children provider en lieu of the old StdVector example which was removed earlier today
llvm-svn: 152971
2012-03-17 02:04:20 +00:00
Johnny Chen a113abce1d rdar://problem/11057400
Add documentation for watchpoint commands.

llvm-svn: 152882
2012-03-16 00:44:02 +00:00
Johnny Chen f224ea69e6 Minor modification.
llvm-svn: 151182
2012-02-22 19:02:32 +00:00
Greg Clayton 7f7d6f50ce Updated our main LLDB page as it was vastly out of date.
llvm-svn: 151175
2012-02-22 18:01:09 +00:00
Enrico Granata f4ca30d74b fixing documentation to refer to the correct name of the module init function __lldb_init_module
llvm-svn: 150992
2012-02-20 22:05:47 +00:00
Greg Clayton 53905d198c Document that we now support the GDB shorthand format syntax on any commands
that take formats or sizes.

Also document that scalar expression results can be used in any command using
expressions inside backticks.

llvm-svn: 150652
2012-02-16 02:10:58 +00:00
Greg Clayton ba728e6d7d Added some clarifications about when the __lldb_init_module would be called
and showed a work around for when this won't.

llvm-svn: 149046
2012-01-26 05:36:07 +00:00
Greg Clayton 690b034161 Fix page title.
llvm-svn: 149004
2012-01-26 00:32:22 +00:00
Jim Ingham feb332c0f7 Better name for the Python Scripting.
llvm-svn: 148770
2012-01-24 02:44:55 +00:00
Jim Ingham 6ae0f99f59 Better name for the python reference.
llvm-svn: 148769
2012-01-24 02:44:07 +00:00
Jim Ingham 87a593687c Proof-reading the python docs.
llvm-svn: 148768
2012-01-24 02:40:42 +00:00
Greg Clayton d879a6305b Added a python FAQ page with detailed examples of how to add python functions
to breakpoints, creating new LLDB commands using python modules and also how
to run scripts from the command line. 

llvm-svn: 148650
2012-01-22 02:55:08 +00:00
Greg Clayton 13d284b284 Updated HTML with info for ${function.name-with-args}
llvm-svn: 148111
2012-01-13 08:41:20 +00:00
Sean Callanan 49e446d9ea Added examples of commands that list and delete
breakpoints.

llvm-svn: 147549
2012-01-04 21:20:39 +00:00
Jim Ingham 73ca05a2a0 Add the ability to capture the return value in a thread's stop info, and print it
as part of the thread format output.
Currently this is only done for the ThreadPlanStepOut.
Add a convenience API ABI::GetReturnValueObject.
Change the ValueObject::EvaluationPoint to BE an ExecutionContextScope, rather than
trying to hand out one of its subsidiary object's pointers.  That way this will always
be good.

llvm-svn: 146806
2011-12-17 01:35:57 +00:00
Eli Friedman 00fda923b6 Fix <title> on webpage.
llvm-svn: 146085
2011-12-07 22:09:43 +00:00
Greg Clayton 04b78e9f20 Updated the grossly out of date status page.
llvm-svn: 143092
2011-10-27 01:33:27 +00:00
Jason Molenda 4223b3b380 typeo
llvm-svn: 142900
2011-10-25 01:28:56 +00:00
Jason Molenda b278f1e191 Add examples of shortest-possible lldb commands where appropriate.
Add new "Examining Variables" section.
Updated a few command entries to match current lldb behavior.

llvm-svn: 142898
2011-10-25 01:28:31 +00:00
Jason Molenda a98d106d49 Document nexti, show some shorter versions of long lldb
commands.

llvm-svn: 142715
2011-10-22 02:31:42 +00:00
Johnny Chen c6d3b6e7a6 Minor fix.
llvm-svn: 141826
2011-10-12 22:25:13 +00:00
Johnny Chen 4ffde88b42 Add pointer to the examples/customization directory for examples of lldb customizations.
llvm-svn: 141823
2011-10-12 22:22:09 +00:00
Johnny Chen a319b84f6a Modify sidebar.incl and remove files to reflect r141554 change.
llvm-svn: 141556
2011-10-10 18:06:09 +00:00
Johnny Chen c12ec2f600 Add a simple scenario of emacs and lldb interaction.
llvm-svn: 141347
2011-10-07 01:06:37 +00:00
Johnny Chen fad6cde32a Add a page describing the emacs integration elisp code based on the Grand Unified Debugger.
An lldb-enhanced gud.el is located under utils/emacs.

llvm-svn: 141241
2011-10-05 22:53:08 +00:00
Greg Clayton 98f8c5252e Added GDB/LLDB commands for the "target stop-hook add" command.
llvm-svn: 139529
2011-09-12 19:56:07 +00:00
Greg Clayton dc55a80da3 Added help on stack frame selection compared to GDB and corrected the register
command help to match the current LLDB.

llvm-svn: 139313
2011-09-08 20:14:22 +00:00
Enrico Granata d769c128b6 other documentation changes
llvm-svn: 139271
2011-09-08 00:50:01 +00:00
Enrico Granata 645a763d72 documentation changes (WIP)
llvm-svn: 139249
2011-09-07 19:20:42 +00:00
Jason Molenda 289673c052 Change old "settings set frame-prompt" and thread-prompt
to frame-format and thread-format.

llvm-svn: 138544
2011-08-25 02:46:44 +00:00
Enrico Granata 45403f31f1 Documentation edits: correcting typos, adding information and general tweaks for readability
llvm-svn: 138442
2011-08-24 17:12:47 +00:00
Enrico Granata c5df00f0b9 Documentation on dynamic types (WIP)
llvm-svn: 138425
2011-08-24 04:53:31 +00:00
Enrico Granata 83cfc9abf8 Minor documentation changes (WIP)
llvm-svn: 138423
2011-08-24 01:49:09 +00:00
Enrico Granata 64997d6c0e More documentation changes (WIP)
llvm-svn: 138421
2011-08-24 01:32:46 +00:00
Enrico Granata 88da35f881 Improved the user-friendliness of errors shown by the summary feature in certain areas
Renamed format "signed decimal" to be "decimal". "unsigned decimal" remains unchanged:
 - the name "signed decimal" was interfering with symbol %S (use summary) in summary strings.
   because of the way summary strings are implemented, this did not really lead to a bug, but
   simply to performing more steps than necessary to display a summary. this is fixed.
Documentation improvements (more on synthetic children, some information on filters). This is still a WIP.

llvm-svn: 138384
2011-08-23 21:26:09 +00:00
Enrico Granata 5a61fc0da5 Exception-awareness for gnu_libstdcpp formatters ; Documentation update
llvm-svn: 138236
2011-08-22 16:10:25 +00:00
Jim Ingham 096675d781 Add "--" before providing the file & command args when launching lldb from the command line.
llvm-svn: 137790
2011-08-17 00:23:09 +00:00
Johnny Chen d63991ca4a Fix some typos.
llvm-svn: 136919
2011-08-04 21:01:04 +00:00
Enrico Granata d55546b27a when typing a summary string you can use the %S symbol to explicitly indicate that you want the summary to be used to print the target object
(e.g. ${var%S}). this might already be the default if your variable is of an aggregate type
new feature: synthetic filters. you can restrict the number of children for your variables to only a meaningful subset
 - the restricted list of children obeys the typical rules (e.g. summaries prevail over children)
 - one-line summaries show only the filtered (synthetic) children, if you type an expanded summary string, or you use Python scripts, all the real children are accessible
 - to provide a synthetic children list use the "type synth add" command, as in:
   type synth add foo_type --child varA --child varB[0] --child varC->packet->flags[1-4]
   (you can use ., ->, single-item array operator [N] and bitfield operator [N-M]; array slice access is not supported, giving simplified names to expression paths is not supported)
 - a new -S option to frame variable and target variable lets you override synthetic children and instead show real ones

llvm-svn: 135731
2011-07-22 00:16:08 +00:00