docs: explain --reference with --prepare and parameters - #911
Open
Solaris-star wants to merge 1 commit into
Open
docs: explain --reference with --prepare and parameters#911Solaris-star wants to merge 1 commit into
Solaris-star wants to merge 1 commit into
Conversation
Document that --reference is a separate baseline command (not a parameter selector) and show how multi --prepare interacts with a reference plus parameterized benchmarks. Signed-off-by: Solaris-star <820622658@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Users combining
--referencewith--prepareand--parameter-listoften try to select a parameterized variant as the reference (e.g.--reference 'echo a (delay = 0.4)'or--reference 'delay = 0.4'). That fails because--referenceis a separate command string, and a single shared--preparewith{param}is not substituted for the reference (it has no parameters).Changes
--reference/--reference-name--prepareexample (reference prepare first)How tested
src/benchmark/scheduler.rs(reference is a separateCommandprepended before parameterized commands)src/benchmark/mod.rsprepare selection (values[self.number]when N prepares; single prepare reuses the same template with each command's parameters)src/options.rsvalidation message: prepare count must be 1 or N including a potential referenceCloses #847