docs: Add a tutorial for pystack core
#181
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The tutorial walks users through a core dump configuration, then uses a python script to invoke a dump with stdlib SIGABRT, and then utilizes pystack to trace the error.
*Issue number of the reported bug or feature request: #53 *
Describe your changes
Wrote a tutorial page which guides users through a stack trace with pystack's core subcommand. The tutorial starts by introducing the concept, then configures the core dump settings such as size and output location. Afterwards, it uses a test script written which follows a series of asserts, if an assert is thrown, stdlib abort is called to interrupt the program, causing a core dump. Finally, the tutorial uses the core subcommand to trace the specific python stack then uses the --native flag to show the native C frames to assess the error.
Testing performed
Tested in an environment which copied the documentation structure of memray, but I reverted all memray dependencies prior to committing my changes.