Skip to content

docs: add some verbiage for benchmark test rules#12121

Merged
jmarantz merged 7 commits into
envoyproxy:masterfrom
pgenera:benchmark-docs
Jul 22, 2020
Merged

docs: add some verbiage for benchmark test rules#12121
jmarantz merged 7 commits into
envoyproxy:masterfrom
pgenera:benchmark-docs

Conversation

@pgenera
Copy link
Copy Markdown
Contributor

@pgenera pgenera commented Jul 16, 2020

Commit Message: Add documentation about benchmark test bazel rules.
Additional Description: I'm trying to communicate that envoy_cc_benchmark_binary is for humans measuring performance, and envoy_benchmark_test is for machines running CI builds.
Risk Level: None. Documentation only.
Testing: automated spell check.
Release Notes: N/A

pgenera added 2 commits July 15, 2020 23:59
Signed-off-by: Phil Genera <pgenera@google.com>
Signed-off-by: Phil Genera <pgenera@google.com>
@pgenera pgenera marked this pull request as ready for review July 16, 2020 00:16
@pgenera
Copy link
Copy Markdown
Contributor Author

pgenera commented Jul 16, 2020

Hey @antoniovicente, do you think this will help the next time someone is confused by the difference between a benchmark_binary and benchmark_test rule?

Copy link
Copy Markdown
Contributor

@antoniovicente antoniovicente left a comment

Choose a reason for hiding this comment

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

Thanks for improving this documentation, the benchmark/test duality has caused a fair bit of confusion.

Comment thread test/README.md
Comment thread test/README.md Outdated
Comment thread bazel/envoy_test.bzl Outdated
pgenera added 2 commits July 21, 2020 18:29
Signed-off-by: Phil Genera <pgenera@google.com>
Signed-off-by: Phil Genera <pgenera@google.com>
Comment thread test/benchmark/main.cc Outdated
pgenera added 2 commits July 21, 2020 20:20
Signed-off-by: Phil Genera <pgenera@google.com>
Signed-off-by: Phil Genera <pgenera@google.com>
Comment thread test/benchmark/main.cc Outdated
Signed-off-by: Phil Genera <pgenera@google.com>
@jmarantz jmarantz merged commit 1267241 into envoyproxy:master Jul 22, 2020
@pgenera pgenera deleted the benchmark-docs branch July 22, 2020 16:12
KBaichoo pushed a commit to KBaichoo/envoy that referenced this pull request Jul 30, 2020
Commit Message: Add documentation about benchmark test bazel rules.
Additional Description: I'm trying to communicate that envoy_cc_benchmark_binary is for humans measuring performance, and envoy_benchmark_test is for machines running CI builds.
Risk Level: None. Documentation only.
Testing: automated spell check.
Release Notes: N/A

Signed-off-by: Phil Genera <pgenera@google.com>
Signed-off-by: Kevin Baichoo <kbaichoo@google.com>
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