summaryrefslogtreecommitdiffstats
path: root/lldb/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* [Docs] Remove stale documentationJonas Devlieghere2019-07-221-21/+2
| | | | | | | This removes a stale piece of documentation about building LLDB with the Xcode project. llvm-svn: 366741
* [docs] Adjust variable formatting tableJonas Devlieghere2019-07-171-1/+10
| | | | | | | | | | | | | | While the in-place hints on valid formats are up to date (e.g. when choosing an invalid format expr -f nonExisting -- 42), the corresponding online docs table is not. The formats "address", "hex float", "instruction" and "void" are missing, and "decimal" refers to an outdated abbreviation 'i' instead of 'd'. Patch by: Lukas Böger Differential revision: https://reviews.llvm.org/D63813 llvm-svn: 366364
* [Docs] Replace SVN revisions with lldb versionsDave Lee2019-07-091-7/+6
| | | | | | | | | | | | | | Summary: Replaces references to svn commits with the lldb version number those commits first appeared in. Themotivation is to show that these features are no longer that new and can generally be adopted. Reviewers: JDevlieghere Subscribers: lldb-commits Tags: #lldb Differential Revision: https://reviews.llvm.org/D61778 llvm-svn: 365559
* [Docs] Remove stale builderJonas Devlieghere2019-07-031-1/+0
| | | | llvm-svn: 365086
* [Docs] Update documentation build instructions.Jonas Devlieghere2019-07-031-3/+3
| | | | | | | Given that we use Ninja as the build system in the instructions below, we might as well use it to build the documentation as well. llvm-svn: 365083
* Remove code-signing.txt now that it's part of the docsJonas Devlieghere2019-07-031-69/+0
| | | | | | | The file's content is part of the website: https://lldb.llvm.org/resources/build.html llvm-svn: 365082
* [Docs] Unify build instructionsJonas Devlieghere2019-07-031-244/+243
| | | | | | | | | | The current build instructions are structured according the host platform. Instead of having instructions on how to build with CMake repeated for every platform, I unified them, using subsections if things are different for between platforms. I also added the code signing instructions, which were hidden in a text file in the repository. llvm-svn: 365081
* [lldb] Mention automatic codesign setup script [NFC]Raphael Isemann2019-07-021-1/+4
| | | | | | | | | The script is the modern way of getting the certificate, so we should mention it in the documentation. Patch idea by Davidino Italiano! llvm-svn: 364967
* [Docs] Modernize references to macOSJ. Ryan Stinnett2019-05-303-11/+15
| | | | | | | | | | | | | | | | | | | | | | | | Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
* Update list of supported architectures.Adrian Prantl2019-05-171-5/+5
| | | | llvm-svn: 361049
* [Docs] Remove SVN checkout from LLDB build stepsJonas Devlieghere2019-05-171-51/+0
| | | | | | | | | | | | | | This removes several older paragraphs in the LLDB build steps for Unix systems which suggested checking out various components via SVN. Since there's a separate page about getting the LLDB source which only mentions Git, it seems appropriate to remove this older info from the build docs. Patch by: J. Ryan Stinnett Differential revision: https://reviews.llvm.org/D62041 llvm-svn: 361046
* [Docs] Fix headings in remote debuggingJonas Devlieghere2019-05-171-8/+18
| | | | | | | Add the proper headings instead of using just a bold font. Also add the local ToC. llvm-svn: 360971
* [Docs] Remove architectures from feature matrixJonas Devlieghere2019-05-171-24/+23
| | | | | | | This is outdated, there's a bunch of architectures missing. If we want them to be part of this table they should be a separate row anyway. llvm-svn: 360967
* [Docs] Unify sidebar paddingJonas Devlieghere2019-05-171-4/+3
| | | | | | Unify the padding across list items and the list header. llvm-svn: 360964
* Slightly update the macOS part of status.rst to be less out-of-date.Adrian Prantl2019-05-161-4/+5
| | | | llvm-svn: 360956
* Update LLDB license on the LLDB home page to Apache+LLVM.Adrian Prantl2019-05-151-3/+4
| | | | llvm-svn: 360822
* Get back the navigation sidebar on the LLDB website.Adrian Prantl2019-05-156-116/+177
| | | | | | | | | This returns the look & feel of the Sphinx-generated LLDB website to the original pre-Sphinx layout. Differential Revision: https://reviews.llvm.org/D61913 llvm-svn: 360819
* [CMake] Add error to clarify that lldb requires libcxxStefan Granitz2019-05-151-0/+6
| | | | | | | | | | | | | | | | | | | | | Summary: This adds a specific error message to clarify that lldb requires libcxx when built together with clang on macOS. In addition, the lldb building docs are also updated. Fixes https://bugs.llvm.org/show_bug.cgi?id=41866 Reviewers: sgraenitz, JDevlieghere, EricWF Reviewed By: sgraenitz Subscribers: mgorny, lldb-commits Tags: #lldb Differential Revision: https://reviews.llvm.org/D61877 llvm-svn: 360756
* [Docs] Document lldb-dotestJonas Devlieghere2019-05-151-13/+35
| | | | | | Document the lldb-dotest binary. llvm-svn: 360748
* Rename MacOS X -> macOS where applicable.Adrian Prantl2019-05-1412-31/+30
| | | | llvm-svn: 360691
* LLDB website: Change the title back to "The LLDB Debugger"Adrian Prantl2019-05-142-4/+9
| | | | | | This is what the old homepage also used. llvm-svn: 360641
* [Docs] Differentiate between public and private APIJonas Devlieghere2019-05-141-2/+3
| | | | | | | On the homepage we should have a clear distinction between the public and private C++ APIs. llvm-svn: 360638
* [Docs] Fix code formattign in variable.rstJonas Devlieghere2019-05-131-0/+1
| | | | | | Fixes missing newline between :: and the actual code. llvm-svn: 360632
* [Docs] Fix table formatting in Pytho referenceJonas Devlieghere2019-05-101-98/+98
| | | | llvm-svn: 360398
* [Docs] Port python reference pageJonas Devlieghere2019-05-092-0/+823
| | | | | | | I somehow forgot to port over this page from the old website. Thank you Jim for the heads up! llvm-svn: 360386
* [Docs] list command: lldb run <args>Jonas Devlieghere2019-05-081-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The run command is only an abbreviation for the more verbose process launch -- <args> but it works just as with GDB and therefore should be mentioned in the GDB to LLDB command map. For educational purposes I've not listed it as the first option on the LLDB side so that new LLDB user can, if they want, also know what the "native" way is for LLDB. Here's the help documentation for the run command in lldb which gives proof: > (lldb) help run > Launch the executable in the debugger. > > Syntax: run [<run-args>] > > Command Options Usage: > run [<run-args>] > > 'run' is an abbreviation for 'process launch -c /bin/sh --' Patch by: Konrad Kleine Differential revision: https://reviews.llvm.org/D61483 llvm-svn: 360269
* [Docs] Fix incorrect heading and update titles.Jonas Devlieghere2019-05-083-9/+9
| | | | | | | | This patch fixes two incorrect headings in source.rst which caused it to show up on the homepage. I also updated the titles to have more sensible links there. llvm-svn: 360219
* [Docs] Re-order homepage: Download -> Build -> TestJonas Devlieghere2019-05-082-14/+17
| | | | | | I also reformatted some paragraphs to 80 cols. llvm-svn: 360218
* [Docs] Add timestampJonas Devlieghere2019-05-071-1/+1
| | | | llvm-svn: 360209
* [Docs] Add remote.html redirectJonas Devlieghere2019-05-061-7/+8
| | | | | | | Add a redirect for the old remote.html page and sort the pages to make dding redirects easier in the future. llvm-svn: 360083
* [CMake] Fix subtle CMake bugAlex Langford2019-04-291-3/+2
| | | | | | | | CMake specifies that the DEPENDS field of add_custom_target is for files and output of add_custom_command. In order to add a target dependency, add_dependencies should be used. llvm-svn: 359490
* [Docs] Generate the python reference without building all of LLDBJonas Devlieghere2019-04-291-21/+36
| | | | | | | | | | | | As discussed on the mailing list, we should be able to generate the Python reference without building all of LLDB. To make that possible I create a dummy python package, which is then parsed by epydoc. The latter will complain that it couldn't import lldb, but that doesn't matter as far as generation of the docs is concerned. Differential revision: https://reviews.llvm.org/D61216 llvm-svn: 359465
* [Docs] Add more redirectsJonas Devlieghere2019-04-241-1/+2
| | | | | | Found two more broken links. llvm-svn: 359063
* [Docs] Update the CI pageJonas Devlieghere2019-04-241-0/+17
| | | | | | | - Add the Sphinx bot - Add a little more info llvm-svn: 359062
* [Docs] Move external links upJonas Devlieghere2019-04-242-18/+5
| | | | | | | With a duplicate link removed and the API reference moved up, the page didn't make much sense anymore. llvm-svn: 359061
* [Docs] Fix link to C++ docsJonas Devlieghere2019-04-242-2/+3
| | | | | | ... and add a redirect for the old URL. llvm-svn: 359052
* [Docs] Add missing leading slashJonas Devlieghere2019-04-231-5/+5
| | | | llvm-svn: 359005
* [Docs] Add 301 redirects for old URLsJonas Devlieghere2019-04-232-0/+8
| | | | llvm-svn: 359004
* [Docs] Move API docs to the front pageJonas Devlieghere2019-04-222-6/+7
| | | | | | | | | | | This moves the links to the C++ and Python API docs up to the main page. As of now the links are still broken [1], but at least this will prevent the additional frustration of searching for the links only to find out they're broken. [1] http://lists.llvm.org/pipermail/lldb-dev/2019-April/014992.html llvm-svn: 358928
* [Docs] Add more info about building the docsJonas Devlieghere2019-04-191-15/+27
| | | | | | Including the C++ and Python reference. llvm-svn: 358777
* [Docs] Make Doxygen functionalJonas Devlieghere2019-04-194-36/+11
| | | | | | | | | This fixes the doxygen configuration to be functional again. I removed the customer header and footer, as well as the no-longer-existent style sheet. I also widened the scope of the documentation, from just the public API to include the private interfaces as well. llvm-svn: 358773
* [Docs] Add LLDB botsJonas Devlieghere2019-04-182-0/+21
| | | | llvm-svn: 358693
* Don't abort() in lldb_assert and document why.Adrian Prantl2019-03-292-1/+104
| | | | | | | | rdar://problem/49356014 Differential Revision: https://reviews.llvm.org/D59911 llvm-svn: 357268
* Pass ConstString by value (NFC)Adrian Prantl2019-03-061-2/+2
| | | | | | | | | | | | | | | | | My apologies for the large patch. With the exception of ConstString.h itself it was entirely produced by sed. ConstString has exactly one const char * data member, so passing a ConstString by reference is not any more efficient than copying it by value. In both cases a single pointer is passed. But passing it by value makes it harder to accidentally return the address of a local object. (This fixes rdar://problem/48640859 for the Apple folks) Differential Revision: https://reviews.llvm.org/D59030 llvm-svn: 355553
* Mention predicting exception catch at throw siteJim Ingham2019-02-261-0/+21
| | | | llvm-svn: 354914
* Add LLDB website and documentation in reStructuredText for SphinxJonas Devlieghere2019-01-3024-1/+7657
| | | | | | | | | | | | | | | | | | | | | | | | | The current LLDB website is written in HTML which is hard to maintain. We have quite a bit of HTML code checked in which can make it hard to differentiate between documentation written by us and documentation generated by a tool. In line with the other LLVM projects, I propose generating the documentation with Sphix. I think text/rst files provide a lower barrier for new or casual contributors to fix or update. This patch adds a copy of the LLDB website and documentation in reStructuredText. It also adds a new ninja target `docs-lldb-html` when -DLLVM_ENABLE_SPHINX:BOOL is enabled. This is the first step in having the website and documentation being generated from the repository, rather than having the output checked-in under the www folder. During the hopefully short transition period, please also update the reStructuredText files when modifying the website. Differential revision: https://reviews.llvm.org/D55376 llvm-svn: 352644
* Adjust documentation for git migration.James Y Knight2019-01-291-51/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes most references to the paths: llvm.org/svn/ llvm.org/git/ llvm.org/viewvc/ github.com/llvm-mirror/ github.com/llvm-project/ reviews.llvm.org/diffusion/ to instead point to https://github.com/llvm/llvm-project. This is *not* a trivial substitution, because additionally, all the checkout instructions had to be migrated to instruct users on how to use the monorepo layout, setting LLVM_ENABLE_PROJECTS instead of checking out various projects into various subdirectories. I've attempted to not change any scripts here, only documentation. The scripts will have to be addressed separately. Additionally, I've deleted one document which appeared to be outdated and unneeded: lldb/docs/building-with-debug-llvm.txt Differential Revision: https://reviews.llvm.org/D57330 llvm-svn: 352514
* Add a description of the similar packets defined in theJason Molenda2018-12-161-3/+18
| | | | | | | | | | | gdb-remote serial protocol documentation, call out the incompatability of lldb's vFile:open: packet as it stands today. Need to think about whether to change lldb's enum values (breaking any existing lldb-server's out there) or create a different packet and abandon vFile:open: at least for a while. llvm-svn: 349316
* Clarify a few minor details.Jason Molenda2018-12-161-7/+8
| | | | llvm-svn: 349313
* Update the vFile:open: description to note that the flagsJason Molenda2018-12-151-1/+3
| | | | | | | | | | in the packet are lldb enum values, not the open(2) oflags -- forgot about that wrinkle. Also added a comment to File.h noting that the existing values cannot be modified or we'll have a compatibilty break with any alternative platform implementations, or older versions of lldb-server. llvm-svn: 349282
OpenPOWER on IntegriCloud