Update docs for 0.8 release

Author: wesleywiser

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.8.0] - 2020-10-01
+### Added
+- `analyzeme`: Profiling data can now be constructed directly from memory without having to touch the filesystem ([GH-123])
+- `summarize`: A new "Time" column shows the total amount of time spent executing the query including sub-queries ([GH-109])
+
+### Changed
+- `crox`: Event argument data is now included in the output file ([GH-108])
+- `measureme`: Trace data is now recorded into a single file instead of three files ([GH-132])
+- `mmview`: Do not panic when there are no events ([GH-119])
+- `summarize`: Time spent in incremental result cache loading and query blocking now counts toward self-time for the query ([GH-104])
+- `summarize`: Improve support for loading trace files created by programs other than rustc ([GH-116])
+- `summarize`: Only show the "Cache hits", "Blocked Time" and "Incremental load time" columns if that data is present in the trace ([GH-116])
+
 ## [0.7.1] - 2020-01-02
 ### Changed
 - `measureme`: Fix compilation error on big endian systems ([GH-103])
@@ -51,6 +64,7 @@
 
 ## [0.2.0] - 2019-04-10
 
+[0.8.0]: https://github.com/rust-lang/measureme/releases/tag/0.8.0
 [0.7.1]: https://github.com/rust-lang/measureme/releases/tag/0.7.1
 [0.7.0]: https://github.com/rust-lang/measureme/releases/tag/0.7.0
 [0.6.0]: https://github.com/rust-lang/measureme/releases/tag/0.6.0
@@ -79,3 +93,10 @@
 [GH-98]: https://github.com/rust-lang/measureme/pull/98
 [GH-101]: https://github.com/rust-lang/measureme/pull/101
 [GH-103]: https://github.com/rust-lang/measureme/pull/103
+[GH-104]: https://github.com/rust-lang/measureme/pull/104
+[GH-108]: https://github.com/rust-lang/measureme/pull/108
+[GH-109]: https://github.com/rust-lang/measureme/pull/109
+[GH-116]: https://github.com/rust-lang/measureme/pull/116
+[GH-119]: https://github.com/rust-lang/measureme/pull/119
+[GH-123]: https://github.com/rust-lang/measureme/pull/123
+[GH-132]: https://github.com/rust-lang/measureme/pull/132

crox/Readme.md

@@ -19,7 +19,7 @@ $ cargo rustc -- -Z self-profile
 $ # Install crox if you haven't done so yet.
 $ cargo install --git https://github.com/rust-lang/measureme crox
 
-$ crox {crate name}-{pid}
+$ crox {crate name}-{pid}.mm_profdata
 ```
 
 3. Open Chrome

flamegraph/README.md

@@ -15,7 +15,7 @@ $ cd regex
 
 $ cargo rustc -- -Z self-profile
 
-$ flamegraph regex-{pid}
+$ flamegraph regex-{pid}.mm_profdata
 
 $ open rustc.svg
 ```

stack_collapse/README.md

@@ -15,7 +15,7 @@ $ cd regex
 
 $ cargo rustc -- -Z self-profile
 
-$ stack_collapse regex-{pid}
+$ stack_collapse regex-{pid}.mm_profdata
 
 $ ../path/to/FlameGraph/flamegraph.pl out.stacks_folded > rustc.svg
 

summarize/Readme.md

@@ -29,15 +29,16 @@ $ cargo +nightly rustc -- -Z self-profile
 ```
 
 The commands above will run `rustc` with the flag that enables profiling. You should now
-have three files in your directory named `pid-{pid}.events`, `pid-{pid}.string_data` and
-`pid-{pid}.string_index`, which contain the profiler data. (If you just got a
-`regex.profile_events.json` file instead, your compiler is too old.)
+have a file in your directory named `regex-{pid}.mm_profdata` which contains the profiler data. (If
+you got three files instead, you will need to use an older version of the `summarize` tool such as
+the `0.7.1` release to read the data:
+`cargo install --git https://github.com/rust-lang/measureme --tag 0.7.1 summarize`)
 
 You can now use the `summarize` tool we installed in the previous section to view the
 contents of these files:
 
 ```bash
-$ summarize summarize id-{pid}
+$ summarize summarize regex-{pid}.mm_profdata
 +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
 | Item                   | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
 +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
@@ -92,7 +93,7 @@ as before: (with regex as example)
 $ git clone https://github.com/rust-lang/regex.git
 $ cd regex
 $ cargo +mytoolchain rustc -- -Z self-profile
-$ summarize summarize pid-{pid}
+$ summarize summarize regex-{pid}.mm_profdata
 +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
 | Item                   | Self time | % of total time | Item count | Cache hits | Blocked time | Incremental load time |
 +------------------------+-----------+-----------------+------------+------------+--------------+-----------------------+
@@ -146,7 +147,7 @@ The `diff` sub command allows you to compare the performance of two different pr
 The output is a table like that of the `summarize` sub command but it instead shows the differences in each metric.
 
 ```bash
-$ summarize diff base-profile changed-profile
+$ summarize diff base-profile.mm_profdata changed-profile.mm_profdata
 +---------------------------+--------------+------------+------------+--------------+-----------------------+
 | Item                      | Self Time    | Item count | Cache hits | Blocked time | Incremental load time |
 +---------------------------+--------------+------------+------------+--------------+-----------------------+