Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add a tutorial for pystack core #181

Open
wants to merge 1 commit into
base: tutorial
Choose a base branch
from

Conversation

PistachioCannoli
Copy link

@PistachioCannoli PistachioCannoli commented May 21, 2024

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.

…rough a core dump configuration, then uses a python script to invoke a dump with stdlib sigabrt, and then utilizes pystack to trace the error.

Signed-off-by: PistachioCannoli <[email protected]>
@godlygeek godlygeek changed the title added a tutorial for the core subcommand. The tutorial walks users th… docs: Add a tutorial for pystack core May 21, 2024
@sarahmonod sarahmonod changed the base branch from main to tutorial May 21, 2024 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant