Skip to content

Commit

Permalink
Merge pull request #1369 from sh92/fixDocs
Browse files Browse the repository at this point in the history
Fix docs about stats option
  • Loading branch information
undingen authored Sep 19, 2016
2 parents 75562e5 + 30e8e53 commit 70993f0
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Pyston-specific flags:
<dt>-v</dt>
<dd>Increase verbosity by 1</dd>

<dt>-s</dt>
<dt>-T</dt>
<dd>Print out the internal stats at exit.</dd>

<dt>-n</dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/TIPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Pyston's primary reason _raison d'être_ is to have better performance than CPyt

### Counters & timers

We have a number of counters and timers that were manually written and inserted into the program. To display the results of a run, use the `-s` flag. The result of timer counters is displayed in microseconds.
We have a number of counters and timers that were manually written and inserted into the program. To display the results of a run, use the `-T` flag. The result of timer counters is displayed in microseconds.

There's two types of timers in the code. The first are `StatCounter`s. They are just counters where we log the time elapsed manually, measured using a `Timer`. The second are `STAT_TIMER`s, which pause the parent `STAT_TIMER` when they are nested.

Expand Down
2 changes: 1 addition & 1 deletion src/core/stats.h
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ struct Stats {
//
// The current convention for stat names is underscore_case, such as `num_cxa_throw`,
// though at some point we'd like to move to a period-delimited convention.
// (Run `./pyston -s` to see the list of current stats we log.)
// (Run `./pyston -T` to see the list of current stats we log.)
// For single stats, usually `num_foo` is a decent name. If there are many stats in a
// single category, you can drop the `num_`.
// If a stat name is a prefix of another, the event it is counting should be a superset.
Expand Down

0 comments on commit 70993f0

Please sign in to comment.