Skip to content

Liozou/BugReporting.jl

This branch is 1 commit ahead of, 6 commits behind JuliaLang/BugReporting.jl:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

eed3925 · Oct 20, 2023
Dec 6, 2022
Feb 25, 2023
Mar 30, 2023
Oct 20, 2023
Oct 20, 2023
Apr 29, 2020
Apr 11, 2020
Oct 20, 2023
Dec 13, 2022

Repository files navigation

BugReporting.jl

This package implements Julia's --bug-report flag, simplyfing bug reporting by enabling users to easily generate and upload reports to help developers fix bugs.

    julia --bug-report=REPORT_TYPE[,REPORT_FLAG,...]

Currently, only the rr tool is supported to generate bug reports, but in the future other types of reports may be supported as well.

Available bug report types and flags

--bug-report=help

Print help message and exit.

--bug-report=rr

Run julia inside rr record and upload the recorded trace.

--bug-report=rr-local

Run julia inside rr record but do not upload the recorded trace. Useful for local debugging.

--bug-report=XXX,timeout=SECONDS

Generate a bug report, but limit the execution time of the debugged process to SECONDS seconds. This is useful for generating reports for hangs.

--bug-report=rr,chaos

Generate an rr trace, while enabling so-called chaos mode. This is useful for flushing out threading-related issues (refer to the rr documentation for more details).

Using the traces for local debugging

You can use this package also for debugging your own Julia code locally. Use --bug-report=rr-local to record a trace, and replay() to replay the latest trace.

For example, if you have a script in a project that you'd like to trace, run julia --bug-report=rr -- --project=foo run.jl.

About

Streamlines bug reporting for julia

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Julia 85.3%
  • Go 12.8%
  • Shell 1.9%