diff options
author | George Burgess IV <gbiv@google.com> | 2019-03-05 16:56:49 -0800 |
---|---|---|
committer | chrome-bot <chrome-bot@chromium.org> | 2019-03-08 03:11:12 -0800 |
commit | 00050c97025ac8ea0999f5c3d1f26e3af7aac9ff (patch) | |
tree | 92fdab294ad808725c42fee4524bf709d45e8f0c /crosperf | |
parent | d03481305c1de7f35da0d7b120585859e7b96da0 (diff) | |
download | toolchain-utils-00050c97025ac8ea0999f5c3d1f26e3af7aac9ff.tar.gz |
Swap READMEs to markdown
Suggested by vapier@ in I7daf1cbe93f8809e469698d7772a6c68baf9e194
This ignores README.chromium, since I'm unsure if that's a special name
that some tool somewhere relies on.
I skimmed over all of these in gitiles (as you can probably tell by the
35 patch sets :) ) and fixed the issues that jumped out at me. I'm sure
that some remain somewhere, but I think I got the majority of them.
An attempt has been made to make all files roughly follow the rules
here:
https://github.com/google/styleguide/blob/gh-pages/docguide/style.md
Note that not all of them have super meaningful introductions with
ToCs/etc, but the rest should be relatively consistent with that guide.
BUG=None
TEST=Manual inspection
Change-Id: I158048d972d49966e3b8ff1e07e5429928edb339
Reviewed-on: https://chromium-review.googlesource.com/1504893
Commit-Ready: George Burgess <gbiv@chromium.org>
Tested-by: George Burgess <gbiv@chromium.org>
Reviewed-by: George Burgess <gbiv@chromium.org>
Diffstat (limited to 'crosperf')
-rw-r--r-- | crosperf/experiment_files/README.md (renamed from crosperf/experiment_files/README) | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/crosperf/experiment_files/README b/crosperf/experiment_files/README.md index d9c96870..8c1fe200 100644 --- a/crosperf/experiment_files/README +++ b/crosperf/experiment_files/README.md @@ -1,16 +1,20 @@ +# Experiment files + To use these experiment files, replace the board, remote and images placeholders and run crosperf on them. Further information about crosperf: https://sites.google.com/a/google.com/chromeos-toolchain-team-home2/home/team-tools-and-scripts/crosperf-cros-image-performance-comparison-tool -The final experiment file should look something like the following (but with +The final experiment file should look something like the following (but with different actual values for the fields): +``` board: lumpy remote: 123.45.67.089 # Add images you want to test: + my_image { chromeos_image: /usr/local/chromeos/src/build/images/lumpy/chromiumos_test_image.bin } @@ -21,14 +25,15 @@ vanilla_image { } # Paste experiment benchmarks here. Example, I pasted -# page_cycler_v2.morejs here. +# `page_cycler_v2.morejs` here. -# This experiment just runs a short autotest which measures the performance of -# Telemetry's page_cycler_v2.morejs. In addition, it profiles +# This experiment just runs a short autotest which measures the performance +# of Telemetry's `page_cycler_v2.morejs`. In addition, it profiles cycles. -perg_args: record -e cycles +perf_args: record -e cycles benchmark: page_cycler_v2.morejs { suite: telemetry_Crosperf iterations: 1 } +``` |