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.

Sign up for GitHub

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

Stabilize -Ztimings as --timings #10245

Merged
merged 7 commits into from
Feb 5, 2022
Merged

Stabilize -Ztimings as --timings #10245

merged 7 commits into from
Feb 5, 2022

Commits on Jan 31, 2022

  1. Remove -Ztimings=info 

    The text-based timing information emits many additional lines, creating
quite a bit of verbosity. Remove in favor of the HTML report, as
suggested at
rust-lang#10245 (comment) .

If we re-add text-based timing information in the future, it could come
in the form of a text-based report, or as a duration printed on the same
line as the crate it measures rather than a separate line.
    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    86bb4a0 View commit details
    Browse the repository at this point in the history

  2. Stabilize -Ztimings as --timings 

    The `-Ztimings` option has existed for years, and many people use it to
profile and optimize their builds. It's one of the common reasons people
use nightly cargo.

The machine-readable JSON output may warrant further careful inspection
before we commit to a stable format. However, for the human-readable
output we don't need to make any commitment about the exact output.

Add a `--timings` option, as the stable equivalent to `-Ztimings`.
Stabilize the `html` output format, and require `-Zunstable-options` for
the `json` output format.

Document the new option, and update the testsuite.
    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    c066918 View commit details
    Browse the repository at this point in the history

  3. Move timing reports to target/cargo-timings 

    This avoids dropping them wherever Cargo happens to run from, and
instead places them under the target directory.

This has the advantage, and disadvantage, that `cargo clean` will remove
them.
    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    e23f5f4 View commit details
    Browse the repository at this point in the history

  4. Make --timings require = if passing an argument 

    This avoids ambiguity between its optional argument and positional
arguments.
    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    c854247 View commit details
    Browse the repository at this point in the history

  5. Make --timings=html unstable, and only stabilize --timings

    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    81e1998 View commit details
    Browse the repository at this point in the history

  6. Fix typo: --timing -> --timings

    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    086e71d View commit details
    Browse the repository at this point in the history

  7. Move detailed --timings documentation from unstable docs to referen… 

    …ce docs
    @joshtriplett
    joshtriplett committed Jan 31, 2022
    Configuration menu
    Copy the full SHA
    85589e1 View commit details
    Browse the repository at this point in the history