docs: use "programmable debugger" description consistently

Replace the old "Scriptable debugger library" and
"Debugger-as-a-library" taglines with the one we're using on GitHub,
"Programmable debugger". Make up for it by emphasizing that drgn can
also be used as a library a tiny bit more in the README.

Signed-off-by: Omar Sandoval <osandov@osandov.com>
This commit is contained in:
Omar Sandoval 2022-08-19 01:21:32 -07:00
parent 5b6a8c27a9
commit ca373fe38a
6 changed files with 15 additions and 12 deletions

View File

@ -38,9 +38,11 @@ scripting in Python. For example, you can debug the Linux kernel:
Although other debuggers like `GDB <https://www.gnu.org/software/gdb/>`_ have
scripting support, drgn aims to make scripting as natural as possible so that
debugging feels like coding. This makes it well-suited for introspecting the
complex, inter-connected state in large programs. It is also designed as a
library that can be used to build debugging and introspection tools; see the
official `tools <https://github.com/osandov/drgn/tree/main/tools>`_.
complex, inter-connected state in large programs.
Additionally, drgn is designed as a library that can be used to build debugging
and introspection tools; see the official `tools
<https://github.com/osandov/drgn/tree/main/tools>`_.
drgn was developed at `Meta <https://opensource.fb.com/>`_ for debugging the
Linux kernel (as an alternative to the `crash

View File

@ -36,7 +36,7 @@ html_static_path = ["_static"]
html_theme = "alabaster"
html_theme_options = {
"description": "Debugger-as-a-library",
"description": "Programmable debugger",
"logo": "logo.png",
"logo_name": True,
"logo_text_align": "center",

View File

@ -2,9 +2,9 @@
# SPDX-License-Identifier: GPL-3.0-or-later
"""
Scriptable debugger library
Programmable debugger
drgn is a scriptable debugger. It is built on top of Python, so if you
drgn is a programmable debugger. It is built on top of Python, so if you
don't know at least a little bit of Python, go learn it first.
drgn supports an interactive mode and a script mode. Both are simply a

View File

@ -75,7 +75,7 @@ def main() -> None:
python_version = ".".join(str(v) for v in sys.version_info[:3])
libkdumpfile = f'with{"" if drgn._with_libkdumpfile else "out"} libkdumpfile'
version = f"drgn {drgn.__version__} (using Python {python_version}, elfutils {drgn._elfutils_version}, {libkdumpfile})"
parser = argparse.ArgumentParser(prog="drgn", description="Scriptable debugger")
parser = argparse.ArgumentParser(prog="drgn", description="Programmable debugger")
program_group = parser.add_argument_group(
title="program selection",

View File

@ -25,10 +25,11 @@
/**
* @mainpage
*
* libdrgn implements the core of <a
* href="https://github.com/osandov/drgn">drgn</a>, a debugger-as-a-library. It
* implements the main drgn abstractions: @ref Programs, @ref Types, and @ref
* Objects. See <a href="modules.html">Modules</a> for detailed documentation.
* libdrgn provides the functionality of the <a
* href="https://github.com/osandov/drgn">drgn</a> programmable debugger as a
* library. It implements the main drgn abstractions: @ref Programs, @ref Types,
* and @ref Objects. See <a href="modules.html">Modules</a> for detailed
* documentation.
*/
/** Major version of drgn. */

View File

@ -448,7 +448,7 @@ setup(
python_requires=">=3.6",
author="Omar Sandoval",
author_email="osandov@osandov.com",
description="Scriptable debugger library",
description="Programmable debugger",
long_description=long_description,
long_description_content_type="text/x-rst",
url="https://github.com/osandov/drgn",