Commit Graph

256 Commits

Author SHA1 Message Date
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
Enrico Granata 1490c6fd8f Fixed a bug where deleting a regex summary would not immediately reflect in the variables display
The "systemwide summaries" feature has been removed and replaced with a more general and
powerful mechanism.
Categories:
 - summaries can now be grouped into buckets, called "categories" (it is expected that categories
   correspond to libraries and/or runtime environments)
 - to add a summary to a category, you can use the -w option to type summary add and give
   a category name (e.g. type summary add -f "foo" foo_t -w foo_category)
 - categories are by default disabled, which means LLDB will not look into them for summaries,
   to enable a category use "type category enable". once a category is enabled, LLDB will
   look into that category for summaries. the rules are quite trivial: every enabled category
   is searched for an exact match. if an exact match is nowhere to be found, any match is
   searched for in every enabled category (whether it involves cascading, going to base classes,
   ...). categories are searched into the order in which they were enabled (the most recently
   enabled category first, then the second most and so on..)
 - by default, most commands that deal with summaries, use a category named "default" if no
   explicit -w parameter is given (the observable behavior of LLDB should not change when
   categories are not explicitly used)
 - the systemwide summaries are now part of a "system" category

llvm-svn: 135463
2011-07-19 02:34:21 +00:00
Enrico Granata f2bbf717f7 Python summary strings:
- you can use a Python script to write a summary string for data-types, in one of
   three ways:
    -P option and typing the script a line at a time
    -s option and passing a one-line Python script
    -F option and passing the name of a Python function
   these options all work for the "type summary add" command
   your Python code (if provided through -P or -s) is wrapped in a function
   that accepts two parameters: valobj (a ValueObject) and dict (an LLDB
   internal dictionary object). if you use -F and give a function name,
   you're expected to define the function on your own and with the right
   prototype. your function, however defined, must return a Python string
 - test case for the Python summary feature
 - a few quirks:
  Python summaries cannot have names, and cannot use regex as type names
  both issues will be fixed ASAP
major redesign of type summary code:
 - type summary working with strings and type summary working with Python code
   are two classes, with a common base class SummaryFormat
 - SummaryFormat classes now are able to actively format objects rather than
   just aggregating data
 - cleaner code to print descriptions for summaries
the public API now exports a method to easily navigate a ValueObject hierarchy
New InputReaderEZ and PriorityPointerPair classes
Several minor fixes and improvements

llvm-svn: 135238
2011-07-15 02:26:42 +00:00
Enrico Granata 79dce0a66e fixing missing RefCounter class
llvm-svn: 135012
2011-07-13 00:00:57 +00:00
Enrico Granata f4efecd958 smarter summary strings:
- formats %s %char[] %c and %a now work to print 0-terminated c-strings if they are applied to a char* or char[] even without the [] operator (e.g. ${var%s})
 - array formats (char[], intN[], ..) now work when applied to an array of a scalar type even without the [] operator (e.g. ${var%int32_t[]})
LLDB will not crash because of endless loop when trying to obtain a summary for an object that has no value and references itself in its summary string
In many cases, a wrong summary string will now display an "<error>" message instead of giving out an empty string

llvm-svn: 135007
2011-07-12 22:56:10 +00:00
Enrico Granata fc7a7f3b75 final fix for the global constructors issue
new GetValueForExpressionPath() method in ValueObject to navigate expression paths in a more bitfield vs slices aware way
changes to the varformats.html document (WIP)

llvm-svn: 134679
2011-07-08 02:51:01 +00:00
Enrico Granata 8f11a4ac96 new webpage describing type command
llvm-svn: 134575
2011-07-07 00:39:55 +00:00
Jim Ingham 57f29f8014 Added a few trivial mods.
llvm-svn: 133084
2011-06-15 21:01:30 +00:00
Caroline Tice 8f7eb81bf6 Add an introduction to the scripting example web page.
llvm-svn: 133061
2011-06-15 16:37:40 +00:00
Caroline Tice cbc0c247e1 Make a few minor changes/corrections to scripting
example on the web.

llvm-svn: 132554
2011-06-03 16:38:17 +00:00
Greg Clayton cbd2e3b001 Cleanup the sidebar and include a link to the new python scripting tutorial.
llvm-svn: 132515
2011-06-02 23:50:04 +00:00
Caroline Tice 54923eced3 Add the web page for the 'Using Python Scripting to
Debug a Program in LLDB' example.

llvm-svn: 132513
2011-06-02 23:40:56 +00:00
Greg Clayton 8a51be9e1b Reroute the blog link to the LLVM blog site.
llvm-svn: 130014
2011-04-22 21:03:40 +00:00
Greg Clayton e302c2c785 Added a blog page with a description and tutorial on using the new "command regex"
command.

llvm-svn: 129898
2011-04-21 01:09:42 +00:00
Greg Clayton 471257c132 Added a few more commands, but I mainly wanted to include how to run lldb
with the same program arguments for a process over and over without having
to specify them (like you can with gdb with the "--args" option).

llvm-svn: 129332
2011-04-12 00:43:35 +00:00
Greg Clayton 0cb4acfc8d Use the same colors in the LLDB/GDB table as the sidebar so things look
consistent and also to lighten up the page a bit.

llvm-svn: 128939
2011-04-05 21:44:24 +00:00
Greg Clayton d5a395aa9c Removed a stray '\' character.
llvm-svn: 128934
2011-04-05 21:40:10 +00:00
Jim Ingham f55a836181 Little bit of cleanup, and added a few new bits.
llvm-svn: 128678
2011-03-31 21:56:13 +00:00
Greg Clayton efcb603008 Updated the web site with a getting started with LLDB and also some resources
to help GDB users figure out the equivalent commands in LLDB.

llvm-svn: 128518
2011-03-30 01:02:37 +00:00
Greg Clayton 678f396d20 Added Mac OS X build instructions and included the Linux build instructions
that Stephen Wilson sent out.

llvm-svn: 128116
2011-03-22 22:39:26 +00:00
Caroline Tice ab174c9d44 Apply patch from Bruce Mitchener to fix spelling errors.
llvm-svn: 123002
2011-01-07 17:16:03 +00:00
Greg Clayton 7a98e5b4e5 Clarified some caveats for thread format strings.
llvm-svn: 115491
2010-10-04 03:06:05 +00:00
Greg Clayton 877b59dc9c Added documentation for the new frame and thread format strings.
llvm-svn: 115488
2010-10-04 02:33:45 +00:00
Christopher Friesen fa7936bc8d Fix utilities text
llvm-svn: 105877
2010-06-12 03:34:21 +00:00
Chris Lattner 2292bcc3cb ssi is annoying to test :)
llvm-svn: 105854
2010-06-11 23:12:28 +00:00
Chris Lattner af73b04924 rearrange the sidebar a little bit to separate the high level status
from the internal and usage dox.

llvm-svn: 105853
2010-06-11 23:11:13 +00:00
Chris Lattner 649caee022 missed a chunk
llvm-svn: 105851
2010-06-11 23:07:52 +00:00
Chris Lattner 4519346079 that seemed to work, switch the rest of the files to use the shared sidebar.incl file.
llvm-svn: 105850
2010-06-11 23:07:14 +00:00
Chris Lattner 2812000273 split the sidebar out to an SSI file so it isn't duplicated everywhere.
llvm-svn: 105849
2010-06-11 23:04:20 +00:00
Chris Lattner 2a49439a0e fix a few typos.
llvm-svn: 105847
2010-06-11 22:52:46 +00:00
Jason Molenda 572f232f18 Spelling fix from Sebastian Redl.
llvm-svn: 105785
2010-06-10 08:23:00 +00:00
Benjamin Kramer fc6980b295 Add some missing close tags.
llvm-svn: 105784
2010-06-10 08:12:17 +00:00
Eric Christopher 84f89a8648 Fix paragraph tag. Patch by Mike Miller.
llvm-svn: 105783
2010-06-10 05:35:26 +00:00
Greg Clayton 86f0baa8f0 Fixed an error in the architecture page.
llvm-svn: 105779
2010-06-10 02:50:28 +00:00
Greg Clayton 491fbdf139 Updated the web pages with new navigable web pages.
llvm-svn: 105778
2010-06-10 02:48:57 +00:00
Greg Clayton c3df232164 Removing www files, will replace them with new ones after this commit.
llvm-svn: 105777
2010-06-10 02:48:13 +00:00
Jason Molenda a9de79c6ae I declare "x86-64" to be the official formatting for
this page.

llvm-svn: 105717
2010-06-09 09:27:53 +00:00
Eric Christopher e56c3af033 Use correct name for the OS here too.
llvm-svn: 105701
2010-06-09 07:32:16 +00:00
Chris Lattner 30fdc8d841 Initial checkin of lldb code from internal Apple repo.
llvm-svn: 105619
2010-06-08 16:52:24 +00:00