Skip to content

Commit

Permalink
README.md: add hint about inlining
Browse files Browse the repository at this point in the history
  • Loading branch information
maruel committed May 13, 2019
1 parent 8ca5dd2 commit 9609257
Showing 1 changed file with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
panicparse
==========
# panicparse

Parses panic stack traces, densifies and deduplicates goroutines with similar
stack traces. Helps debugging crashes and deadlocks in heavily parallelized
Expand All @@ -13,8 +12,7 @@ panicparse helps make sense of Go crash dumps:
![Screencast](https://raw.githubusercontent.com/wiki/maruel/panicparse/parse.gif "Screencast")


Features
--------
## Features

* >50% more compact output than original stack dump yet more readable.
* Exported symbols are bold, private symbols are darker.
Expand All @@ -31,14 +29,12 @@ Features
* Works on Windows.


Installation
------------
## Installation

go get github.com/maruel/panicparse/cmd/pp


Usage
-----
## Usage

### Piping a stack trace from another process

Expand Down Expand Up @@ -97,8 +93,21 @@ To dump to a file then parse, pass the file path of a stack trace
pp stack.txt


Tips
----
## Tips

### Disable inlining

Starting with go1.11, the toolchain starts to inline more often. This causes
traces to be less informative. You can use the following to help diagnosing
issues:

go install -gcflags '-N -l' ./foo
foo |& pp

or

go test -gcflags '-N -l' |& pp


### GOTRACEBACK

Expand Down

0 comments on commit 9609257

Please sign in to comment.