summaryrefslogtreecommitdiffstats
path: root/lldb/tools
diff options
context:
space:
mode:
authorJonas Devlieghere <jonas@devlieghere.com>2019-11-20 14:53:37 -0800
committerJonas Devlieghere <jonas@devlieghere.com>2019-11-21 10:04:11 -0800
commitbb775bee21258f93cd5844b3540c0ec2569c1e22 (patch)
treef8ceb0e649607db96cfd4e0ca46e3f6fb4a022c4 /lldb/tools
parentf1a9a83232230e1c848a91270ebe0d4089f0a803 (diff)
downloadbcm5719-llvm-bb775bee21258f93cd5844b3540c0ec2569c1e22.tar.gz
bcm5719-llvm-bb775bee21258f93cd5844b3540c0ec2569c1e22.zip
[Docs] Generate the LLDB man page with Sphinx
This patch replaces the existing out-of-date man page for lldb and replaces it with an RST file from which sphinx generates the actual troff file. This is similar to how man pages are generated for the rest of the LLVM utilities. The man page is generated by building the `docs-lldb-man` target. Differential revision: https://reviews.llvm.org/D70514
Diffstat (limited to 'lldb/tools')
-rw-r--r--lldb/tools/driver/Options.td4
1 files changed, 3 insertions, 1 deletions
diff --git a/lldb/tools/driver/Options.td b/lldb/tools/driver/Options.td
index 4ea98ee48fa..485c0d44bc8 100644
--- a/lldb/tools/driver/Options.td
+++ b/lldb/tools/driver/Options.td
@@ -5,6 +5,8 @@ class S<string name>: Separate<["--", "-"], name>;
class R<list<string> prefixes, string name>
: Option<prefixes, name, KIND_REMAINING_ARGS>;
+// Please keep this in sync with the man page in docs/man/lldb.rst
+
// Attaching options.
def grp_attach : OptionGroup<"attaching">, HelpText<"ATTACHING">;
@@ -117,7 +119,7 @@ def: Flag<["-"], "Q">,
def one_line_on_crash: Separate<["--", "-"], "one-line-on-crash">,
MetaVarName<"<command>">,
- HelpText<"When in batch mode, tells the debugger to source this file of lldb commands if the target crashes.">,
+ HelpText<"When in batch mode, tells the debugger to run this one-line lldb command if the target crashes.">,
Group<grp_command>;
def: Separate<["-"], "k">,
Alias<one_line_on_crash>,
OpenPOWER on IntegriCloud