JakeHillion/drgn
1
0
Fork 0
mirror of https://github.com/JakeHillion/drgn.git synced 2024-12-23 01:33:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
1487db5389
drgn/docs/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

43 lines
808 B
ReStructuredText
Raw Normal View History

Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension.
2019-04-04 09:27:23 +01:00
drgn
====
.. include:: ../README.rst
:start-after: start-introduction
:end-before: end-introduction
In addition to the main Python API, an experimental C library, ``libdrgn``, is
also available.
See the :doc:`installation` instructions. Then, start with the
:doc:`user_guide`.
License
-------
.. include:: ../README.rst
:start-after: start-license
:end-before: end-license
Acknowledgements
----------------
drgn is named after `this
<https://giraffesgiraffes.bandcamp.com/track/drgnfkr-2>`_ because dragons eat
`dwarves <http://dwarfstd.org/>`_.
Table of Contents
-----------------
.. toctree::
:maxdepth: 3
installation
user_guide
libdrgn: make program components pluggable Currently, programs can be created for three main use-cases: core dumps, the running kernel, and a running process. However, internally, the program memory, types, and symbols are pluggable. Expose that as a callback API, which makes it possible to use drgn in much more creative ways.
2019-05-10 07:53:16 +01:00
advanced_usage
Document with Sphinx drgn has pretty thorough in-program documentation, but it doesn't have a nice overview or introduction to the basic concepts. This commit adds that using Sphinx. In order to avoid documenting everything in two places, the libdrgn bindings have their docstrings generated from the API documentation. The alternative would be to use Sphinx's autodoc extension, but that's not as flexible and would also require building the extension to build the docs. The documentation for the helpers is generated using autodoc and a small custom extension.
2019-04-04 09:27:23 +01:00
api_reference
helpers
docs: document supported architectures and kernel versions Closes #287, closes #288. Signed-off-by: Omar Sandoval <osandov@osandov.com>
2023-07-19 21:45:28 +01:00
support_matrix
docs: add a writeup of an investigation using stack trace variables Signed-off-by: Omar Sandoval <osandov@osandov.com>
2021-06-09 09:52:10 +01:00
case_studies
docs: document how to get debugging symbols I couldn't find any good summaries of how to get debugging symbols on various distros, so I guess we'll have to maintain our own. Signed-off-by: Omar Sandoval <osandov@osandov.com>
2021-11-03 00:48:36 +00:00
getting_debugging_symbols
docs: add release highlights for 0.0.22 I've been posting these internally at Meta for previous releases, but I think others would find them useful, too. In the future, I'll write them up before cutting the release. Signed-off-by: Omar Sandoval <osandov@osandov.com>
2023-01-06 23:20:40 +00:00
release_highlights
Reference in New Issue Copy Permalink