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

Jump to bottom

Documentation is confusing #394

Closed
alk opened this issue Aug 23, 2015 · 8 comments
Closed

Documentation is confusing #394

alk opened this issue Aug 23, 2015 · 8 comments
Assignees
@alk
Labels
Priority-Medium Status-Fixed Type-Defect

Comments

@alk
Copy link
Contributor

alk commented Aug 23, 2015

Originally reported on Google Code with ID 391

I found the documentation at 

http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile.html

to be quite confusing. You write:

env CPUPROFILE=/tmp/mybin.prof /usr/local/bin/my_binary_compiled_with_libprofiler_so

pprof --text /bin/ls ls.prof

What you mean is:

env CPUPROFILE=/tmp/mybin.prof /path/to/mybin

pprof --text /path/to/mybin mybin.prof

As a new and quite busy user of your tool, I spent half an hour reading your and other
pages until I figured this out. It would be very much appreciated if the documentation
is made more consistent and more clear.

Reported by oleg.alexandrov on 2012-01-10 18:36:22
@alk alk self-assigned this Aug 23, 2015
@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Correction:

env CPUPROFILE=/tmp/mybin.prof /path/to/mybin

pprof --text /path/to/mybin /tmp/mybin.prof

Reported by oleg.alexandrov on 2012-01-10 18:37:43

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Hmm, I'm not sure I agree the old wording was confusing, but it's easy enough to change.
I've changed it to use /bin/ls as the example binary everywhere in the cpu-profile
doc.

The other docs, for heap-profile and leak-checker, did not seem to have the same issue,
so I've left them unchanged.

This will all be in the next release.

Reported by csilvers on 2012-01-13 18:59:12

  • Status changed: Started
  • Labels added: Type-Defect, Priority-Medium

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Thank you. I do not see any updates in
http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile.html

Consistency is great.

However, using /bin/ls as an example may be unfortunate, since of
course it is not linked with -lprof so if the user tries to literally
profile /bin/ls it won't work.

I like more the use of "path/to/mybin mybin.conf" as opposed to
"/bin/ls ls.conf", but what's more important is of course consistency.

Reported by oleg.alexandrov on 2012-01-13 22:06:13

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Yes, sorry, I haven't pushed the changes to svn yet.  Will do so when I get a chance,
though it may be a few days (or weeks...)

Reported by csilvers on 2012-01-13 22:33:56

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

This should be improved in perftools 1.10, just released.

Reported by csilvers on 2012-01-31 19:18:27

  • Status changed: Fixed

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

The documentation  at

http://google-perftools.googlecode.com/svn/trunk/doc/cpuprofile.html

did not change.

Reported by oleg.alexandrov on 2012-02-01 04:29:03

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Sorry, such urls are obsolete (I don't know how to get google code to redirect them).
 Everything now lives at gperftools.googlecode.com, and the changes are reflected at
   http://gperftools.googlecode.com/svn/trunk/doc/cpuprofile.html

Reported by csilvers on 2012-02-01 18:33:07

@alk
Copy link
Contributor Author

alk commented Aug 23, 2015 

Thanks, it is much better.

It is still a bit funny that one would ever link the system /bin/ls
with gperf, but at least things are now consistent.

On Tue, Jan 31, 2012 at 8:28 PM, Oleg Alexandrov
<oleg.alexandrov@gmail.com> wrote:

Reported by oleg.alexandrov on 2012-02-02 00:36:07

@alk alk closed this as completed Aug 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alk alk

Labels
Priority-Medium Status-Fixed Type-Defect
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alk