Development

• API Changes
  • April 2019
  • Python 3.6 Required
  • Typing
  • Public / Protected Namespace
  • Command documentation
  • New mechanism for delayed lookups
  • Example
• Testing
  • Summary
  • Unit tests
  • Type checking
  • Code sanitization
  • Testing with vmcores
  • Test everything
• Crash API Reference
  • crash package
• GDB
  • Python contexts within GDB
• Patterns
  • Optional error handling

Documentation is automatically built from the python code for the user guide, command help text, and API reference.

There are several make targets to assist in your development efforts:

• make or make all – Start fresh, build the python code and documentation, and then run the standalone test suite.

• make doc – Build all documentation (html, text, and man page).

• make doc-help – Build only the documentation required for help text

• make doc-html – Build the user manual

• make man – Build the man page

For testing, see the Testing section.

To develop a command, see the crash.commands API.

Indices and tables

• Index

• Module Index

• Search Page