Commit Graph

267 Commits

Author SHA1 Message Date
Zachary Turner 773f6da037 Update the coding standard to reflect recent changes.
This removes the rule from the LLDB coding standard about putting
a space after function names and before parentheses.  We now
conform to the LLVM style guide.  If you previously wrote
pointer->func (args), it would now be written pointer->func(args).

Using clang-format will do this automatically.

llvm-svn: 228860
2015-02-11 18:24:38 +00:00
Greg Clayton 281b65bcde Update documenation for the changed in from ${var.script:<pythonfunction>} to the new ${script.var:<pythonfunction>}.
llvm-svn: 228216
2015-02-04 22:24:47 +00:00
Zachary Turner 34d2173abf Update the website with information about LLDB on Windows.
This patch updates the list of supported platforms to include
Windows, and also provides some detailed getting started instructions
for building LLDB on Windows.

Differential Revision: http://reviews.llvm.org/D6805

llvm-svn: 225023
2014-12-31 00:06:49 +00:00
Zachary Turner e511f0307b Fix HTML formatting and non-conformance.
llvm-svn: 225022
2014-12-31 00:06:41 +00:00
Jim Ingham 0ccb02c4e9 Add an initial description of the rules for constructing new SB API classes.
llvm-svn: 223550
2014-12-06 00:28:05 +00:00
Jim Ingham 15fe293460 First pass at a description of the lldb coding conventions.
llvm-svn: 223543
2014-12-05 23:18:01 +00:00
Jason Molenda 98b3fde8ac Fix the behavior of ${current-pc-arrow} in the default disassembly
format for the not-current-stack-frame.  This was causing
test/functionalities/inferior-assert to fail.

Also document the new additions to the format specifications used
in the disassembly-format changes to formats.html.

<rdar://problem/19102757> 

llvm-svn: 223096
2014-12-02 00:26:21 +00:00
Enrico Granata e8eb47037c Just a few words to introduce the extra optional argument to Python summaries
llvm-svn: 222594
2014-11-22 00:06:30 +00:00
Enrico Granata 90ff6428c9 Add a few words of documentation for the the $\{var.script:\} feature
llvm-svn: 220823
2014-10-28 21:13:31 +00:00
Enrico Granata 8387e2fafe Add a (Python only) lldb.SBSyntheticValueProvider class to our API surface
On a suggestion from Jim Ingham, this class allows you to very easily define synthetic child providers that return a synthetic value (in the sense of r219330), but no children

Also, document this new feature in our www docs

llvm-svn: 219337
2014-10-08 20:10:09 +00:00
Enrico Granata da0fd6d3ad Add documentation about the new SBExecutionContext for Python commands feature. This marks the end of rdar://18142728
llvm-svn: 218835
2014-10-01 21:53:32 +00:00
Ed Maste 279ebe2ded Correct typo in tutorial page
llvm-svn: 217733
2014-09-14 00:56:13 +00:00
Sylvestre Ledru f6102892ef Fix some typos:
* transfered => transferred
* unkown => unknown
* sucessfully => successfully

llvm-svn: 215367
2014-08-11 18:06:28 +00:00
Jim Ingham 3f762ef111 Add docs for the "thread.completed-expression" format entry.
llvm-svn: 212507
2014-07-08 01:10:49 +00:00
Bruce Mitchener d93c4a3339 Fix typos.
llvm-svn: 212132
2014-07-01 21:22:11 +00:00
Bruce Mitchener 8e97653528 Terminate italics tag.
llvm-svn: 212131
2014-07-01 21:19:25 +00:00
Bruce Mitchener 6a7f33387d Fix a few typos.
llvm-svn: 211851
2014-06-27 02:42:12 +00:00
Alp Toker 01d9c64055 Remove obsolete CXX11 buld instructions
There's an element of guesswork involved in the GCC updates but it seems better
than what was there before.

llvm-svn: 207912
2014-05-03 15:05:40 +00:00
Ed Maste bcd2cacb2e Note that the FreeBSD x86_64 buildbot uses CMake
The other buildbots in the list include their build method.

llvm-svn: 206892
2014-04-22 13:20:20 +00:00
Ed Maste a56bd2ed29 Update FreeBSD: Threads and Watchpoints generally work
llvm-svn: 206787
2014-04-21 20:43:20 +00:00
Greg Clayton 5f1000107d Update for Ubuntu 13.10 after feedback from Eran Ifrah.
llvm-svn: 204619
2014-03-24 16:30:59 +00:00
Enrico Granata c1690d0c2b Add conditional breakpoints to our cheat sheet
llvm-svn: 200995
2014-02-07 21:30:02 +00:00
Ed Maste 611d8c4361 Update URL for OS X buildbot
llvm-svn: 200799
2014-02-04 21:59:03 +00:00
Jason Molenda 303eb178a9 Fix typeo on memory read command example.
llvm-svn: 199228
2014-01-14 17:41:13 +00:00
Jim Ingham a78f365b40 Document unsetting environment variables in the lldb/gdb cheat sheet.
llvm-svn: 198881
2014-01-09 19:30:11 +00:00
Enrico Granata cb0c85e166 Fix sidebar links
llvm-svn: 198039
2013-12-26 07:23:52 +00:00
Enrico Granata 0e0e9f531f Adding a document that describes the architecture of data formatters. Suggestions and ideas for improvements most welcome
llvm-svn: 198038
2013-12-26 07:21:41 +00:00
Jean-Daniel Dupas 59ceb0440e Update cmake build instruction to compile LLVM in C++11 mode
Thanks to Xavier de Gaye for the pointer.

llvm-svn: 196794
2013-12-09 18:13:47 +00:00
Enrico Granata d28f5a54d9 A few more details on the DataVisualization class in our architectural doc. It is in dire need of expansion, but this is a start at least.
llvm-svn: 196176
2013-12-03 00:30:22 +00:00
Enrico Granata cf2412d41d Tweak documentation for formats in categories
llvm-svn: 192235
2013-10-08 21:07:22 +00:00
Sylvestre Ledru fbf4a54a43 Update the build documentation for Debian & Ubuntu
llvm-svn: 191635
2013-09-29 10:46:25 +00:00
Joerg Sonnenberger 340a17595e Convert to UNIX line endings.
llvm-svn: 191367
2013-09-25 10:37:32 +00:00
Greg Clayton 07457be649 Clean up some documentation.
llvm-svn: 188912
2013-08-21 18:13:29 +00:00
Jason Molenda 39587672b8 Change the sidebar to link directly to the C++ API docs and the Python API docs,
instead of pointing to a page with two links on it.

llvm-svn: 188706
2013-08-19 20:53:56 +00:00
Jason Molenda f131c82b75 Make the link to the Python API docs more explicit in the Python Reference page.
llvm-svn: 188704
2013-08-19 20:46:15 +00:00
Jason Molenda ab89ea2cb2 Make it explicit what "API Documentation" is documenting (the C++/Python SB APIs)
llvm-svn: 188703
2013-08-19 20:40:22 +00:00
Jim Ingham 45228fd2fb Document "show args" -> "settings show target.run-args"
llvm-svn: 187270
2013-07-26 23:20:05 +00:00
Ed Maste 29b4246f9d Update www build instructions for FreeBSD
llvm-svn: 187045
2013-07-24 14:53:48 +00:00
Ed Maste e52a34c993 Add FreeBSD buildbots to build page
llvm-svn: 187043
2013-07-24 14:44:09 +00:00
Ed Maste 4e82328789 Update current state of FreeBSD port
llvm-svn: 187037
2013-07-24 13:51:45 +00:00
Ashok Thirumurthi fbad1d6b47 Updated the LLDB status page to reflect recent work on Linux.
llvm-svn: 187036
2013-07-24 13:32:18 +00:00
Stefanus Du Toit 403477bdac Remove spurious "-C" flag from CMake command lines in build.html.
-C usually specifies a script to prepopulate the CMake cache. In this case no
script is specified, so CMake appears to just ignore it. So don't mention it
in the first place - it's not desired anyways.

Reviewed by: Daniel Malea

llvm-svn: 186964
2013-07-23 17:29:44 +00:00
Stefanus Du Toit 4d933aa956 Add instructions to www/source.html for using the Git mirror for those so inclined.
Reviewed by: Daniel Malea

llvm-svn: 186958
2013-07-23 17:18:43 +00:00
Daniel Malea 7b4d27c53b Add another link to the Python API docs.
llvm-svn: 186712
2013-07-19 19:15:45 +00:00
Daniel Malea dece1a5c5c Add links to LLDB API reference docs
llvm-svn: 186699
2013-07-19 17:33:02 +00:00
Daniel Malea e1873736cb Add LLDB API reference docs (for Python and C++)
llvm-svn: 186697
2013-07-19 17:28:54 +00:00
Jason Molenda 3b537d4023 Fix typeos.
llvm-svn: 186457
2013-07-16 21:11:29 +00:00
Enrico Granata 9ca7f75bc1 Adding information on the scriptable keywords ${target|process|thread|frame.script:function} to the LLDB documentation
llvm-svn: 186201
2013-07-12 20:46:02 +00:00
Enrico Granata da504ff00a Tweaks to the Python reference and example command to use the preferred print style and the (finally available :-) SetError API
llvm-svn: 186122
2013-07-11 21:49:38 +00:00
Jim Ingham 34e1edf2bf Direct dir to target.source-map.
llvm-svn: 184778
2013-06-24 19:37:49 +00:00
Ashok Thirumurthi d5dcec1181 Updated the LLDB download page to reflect Debian package locations for 3.3 as well as the incremental 3.4 releases.
llvm-svn: 184339
2013-06-19 19:32:56 +00:00
Greg Clayton cd3523c12d Added a troubleshooting page as a place to add commonly asked questions with solutions.
The first two questions I have added explanations and answers to are:
- File and line breakpoints are not getting hit
- How do I check if I have debug symbols?

llvm-svn: 184159
2013-06-18 01:01:31 +00:00
Ashok Thirumurthi 5e75455062 LLDB feature status update to mention limitations with core-file debugging and exec.
llvm-svn: 183832
2013-06-12 14:26:58 +00:00
Ashok Thirumurthi aecb66ec33 Updated the links to Debian packages, provided a link to the blog on the nightly,
and provided download links for incremental 3.4 packages for 32/64-bit editions.

llvm-svn: 183668
2013-06-10 15:26:48 +00:00
Ashok Thirumurthi b65edd4b95 Updated the LLDB status page to reflect the recent addition of multi-threaded support.
Reworked the download information on lldb.llvm.org:
- svn copy of download.html to source.html with information on source-code access
- new download.html with links to download nightly builds and Debian releases
- updated the sidebar to reflect these changes

llvm-svn: 183547
2013-06-07 19:21:45 +00:00
Enrico Granata 8e698323ec A few cleanups for our documentation
llvm-svn: 183058
2013-05-31 22:54:23 +00:00
Daniel Malea d72b3ceb6b Add instructions for running LLDB tests with non-default compiler/architectures
- documented the cmake variable LLDB_TEST_ARGS

llvm-svn: 182797
2013-05-28 19:14:44 +00:00
Daniel Malea f92c4a814a Add CMake targets to build LLDB reference docs
- [ninja|make] lldb-cpp-doc builds the C++ API reference docs
- [ninja|make] lldb-python-doc builds the python API reference docs
- updated build page on website to include instructions to build docs

Tested on Linux/Mac OS X

llvm-svn: 182752
2013-05-28 03:47:34 +00:00
Ashok Thirumurthi 2a27227da0 Updated the status page to reflect the current Linux status.
- Fix for attach by name
- Details for register support
- Punted on i386 details as its status has drifted since this page was originally posted
- Multi-threaded target support is soon to be released on Linux
- Partial back-trace is called out since its a high-profile issue

llvm-svn: 182664
2013-05-24 19:25:33 +00:00
Greg Clayton b1e4a25b03 Added a few linux build configure/make examples.
llvm-svn: 182160
2013-05-17 21:06:45 +00:00
Daniel Malea 716d924e4c Update LLDB web docs with instructions to run individual test suites/directories
llvm-svn: 182117
2013-05-17 16:08:45 +00:00
Enrico Granata e8be51d7d7 the return False in breakpoint actions should also be mentioned on the website
llvm-svn: 182060
2013-05-16 23:17:25 +00:00
Sean Callanan a49d9bef05 Removed a duplicate entry from the GDB to
LLDB transition page.  Also fixed a <b>...</b>
tag.

<rdar://problem/13871874>

llvm-svn: 181720
2013-05-13 18:30:58 +00:00
Enrico Granata 083fcdb414 Providing a more interesting command template for LLDB
This one actually exploits the SB API to obtain information about your inferior process

llvm-svn: 181500
2013-05-09 01:32:24 +00:00
Enrico Granata 068c11096a Now that you can "command script import" packages, the docs should reflect the best practice
llvm-svn: 181475
2013-05-08 21:39:19 +00:00
Matt Kopec 23f23f4b7a Update lldb status page to reflect watchpoint support on Linux.
llvm-svn: 181460
2013-05-08 19:45:07 +00:00
Greg Clayton 6991afe31b Added a few things that need to be installed on linux to build LLDB.
llvm-svn: 181028
2013-05-03 16:29:42 +00:00
Jim Ingham 526560a553 Document how to get "info line" information from "image lookup -v".
llvm-svn: 179800
2013-04-18 22:03:01 +00:00
Daniel Malea 3905296d4f Minor update to build instructions: workaround a bug in cmake+make build files
llvm-svn: 178569
2013-04-02 20:08:19 +00:00
Enrico Granata ceba071330 - Masking out SBCommandReturnObject::Printf() from the Python layer because SWIG and varargs do not get along well.
It is replaced by a Print("str") call which is equivalent to Printf("%s","str")
- Providing file-like behavior for SBStream with appropriate extension write() and flush() calls, plus documenting that these are only meant and only exist for Python
Documenting the file-like behavior on our website

llvm-svn: 177877
2013-03-25 17:37:39 +00:00
Daniel Malea b6c6e0492b Be more precise in GCC/autoconf build instructions about compiler versions
llvm-svn: 176528
2013-03-05 22:58:53 +00:00
Daniel Malea fad9aae937 Typos: be more precise on the build page when mentioning the non-cmake build system
llvm-svn: 176524
2013-03-05 22:43:08 +00:00
Daniel Malea a2e4598d88 Add instructions for building LLDB with CMake
- suported generators: Ninja and Unix Makefiles
- added instructions to run tests when building with autoconf

llvm-svn: 176522
2013-03-05 22:38:50 +00:00
Daniel Malea 4dfd057e44 Add links to buildbots on the LLDB build instructions page
llvm-svn: 176126
2013-02-26 21:41:55 +00:00
Jim Ingham 04c1de182b Mention "return" -> "thread return"
llvm-svn: 175689
2013-02-20 23:38:37 +00:00
Enrico Granata e5631635bf Lastly, a few synthetic children classes for Cocoa are available
llvm-svn: 175591
2013-02-20 02:27:07 +00:00
Enrico Granata 710d88fd64 And the NSString formatter is not Python anymore
llvm-svn: 175590
2013-02-20 02:24:20 +00:00
Enrico Granata df21e40f94 Data formatters are not a *recent* addition...
llvm-svn: 175589
2013-02-20 02:22:00 +00:00
Jim Ingham 719d2c9d36 Mention the inline-breakpoint-strategy in the lldb-gdb.html file.
llvm-svn: 175201
2013-02-14 19:17:49 +00:00
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