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

Add module level docs to flamegraph #15

Open
jonhoo opened this issue Feb 2, 2019 · 2 comments
Open

Add module level docs to flamegraph #15

jonhoo opened this issue Feb 2, 2019 · 2 comments
Labels
docs Updating or improving documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jonhoo
Copy link
Owner

jonhoo commented Feb 2, 2019

There's a lot of useful info at the top of flamegraph.pl that we should incorporate into the (currently non-existant) docs for the flamegraph module. FlameGraph also has a history that it'd be worthwhile to refer to.

@jonhoo jonhoo added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers docs Updating or improving documentation labels Feb 2, 2019
@AnderEnder
Copy link
Contributor

@jonhoo,
Maybe it is better to incorporate this information into cli flamegraph help, e.g. AnderEnder@c1533a5

@jonhoo
Copy link
Owner Author

jonhoo commented Mar 16, 2019

I think I'd probably want the information in both. And the subset to show in each place is probably slightly different. For example, history probably only makes sense on the library, and the same with description of the folded stack format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Updating or improving documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants