Skip to content

Use "profiles" and "scenarios" terminology consistently. #1177

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

Conversation

nnethercote
Copy link
Contributor

Specifically:

  • Rename the --builds and --runs options as --profiles and
    --scenarios, respectively. The old option names are still available
    as aliases, for backward compatibility.
  • Replace the use of "profile kinds" and "scenario kinds" (and
    variations) with just "profiles" and "scenarios". Note that this
    required renaming the PerfTool::Profile variant as
    PerfTool::ProfileTool to avoid a collision with the new Profile
    type.
  • Fix various inconsistencies in the docs.

Specifically:
- Rename the `--builds` and `--runs` options as `--profiles` and
  `--scenarios`, respectively. The old option names are still available
  as aliases, for backward compatibility.
- Replace the use of "profile kinds" and "scenario kinds" (and
  variations) with just "profiles" and "scenarios". Note that this
  required renaming the `PerfTool::Profile` variant as
  `PerfTool::ProfileTool` to avoid a collision with the new `Profile`
  type.
- Fix various inconsistencies in the docs.
Copy link
Member

@rylev rylev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've been meaning to do this for a while! Have you run things locally and tried to make sure nothing has broken?

@nnethercote
Copy link
Contributor Author

I have done some local testing of bench_local, profile_local, and loading the "compare" page on the site. Plus the CI actions passed, which test a bunch of things. It's possible that some breakage will fall through the gaps, though.

@Mark-Simulacrum
Copy link
Member

I'll go ahead and merge, and if there's any fall out we can fix that up. I think this looks pretty good though.

@Mark-Simulacrum Mark-Simulacrum merged commit 9a9d1a8 into rust-lang:master Feb 18, 2022
@nnethercote nnethercote deleted the use-profiles-scenarios-consistently branch February 19, 2022 03:20
@nnethercote
Copy link
Contributor Author

One nice thing about this change is that "runs" was being used in two ways: in some places it meant what we now call "scenarios", and in other places it refers to how many times a benchmark is run. Only the latter meaning now remains.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants