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 /android_bench_suite | |
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 'android_bench_suite')
-rw-r--r-- | android_bench_suite/README.md | 49 | ||||
-rw-r--r-- | android_bench_suite/README.txt | 41 |
2 files changed, 49 insertions, 41 deletions
diff --git a/android_bench_suite/README.md b/android_bench_suite/README.md new file mode 100644 index 00000000..b539c7cd --- /dev/null +++ b/android_bench_suite/README.md @@ -0,0 +1,49 @@ +# `android_bench_suite` + +This is a Android Toolchain benchmark suite. + +Where to find this suite: + +This suite locates at google3, please create a google3 branch first, then run: + +``` +$ cd experimental/users/zhizhouy/benchtoolchain +``` + +Copy this directory to the place you want to put it. + +To use this suite: +1. Configure the basic envrionment in `env_setting` file. + +2. Run `./apply_patches.py`, which will: + + 1. Patch all the android benchmarks in the android tree. + Benchmark Panorama does not exist in android tree, so perftests/ + gets copied into the top-level of android tree. + + 2. Apply patch autotest.diff to `android_root/external/autotest`, which + includes all the test scripts for benchmarks. Copy testcases to + related autotest directory. + + If you have applied the patch partially and hope to discard the + patch, just run `discard_patches.py` + +3. Build and run benchmark on the device using ./run.py. You can either + use test configuration file (-t `test_config`), or set all the variables + manually. + +4. The raw results locate at `bench_result_*` in bench suite home + directory. + +5. The JSON format result will be generated for crosperf report. + +Utility tools: + +1. Autotest is a test framework located in android exteranl/autotest + Before first time running it, please run + `utils/build_externals.py` first to ensure all the environments + and tools needed are installed. + +2. Crosperf is a report generating tool in ChromeOS toolchain utilities. + Please look for it in chromium source: + `src/third_party/toolchain-utils/crosperf`. diff --git a/android_bench_suite/README.txt b/android_bench_suite/README.txt deleted file mode 100644 index 3d0cceb5..00000000 --- a/android_bench_suite/README.txt +++ /dev/null @@ -1,41 +0,0 @@ -This is a Android Toolchain benchmark suite. -=========================================== -Where to find this suite: - This suite locates at google3, please create a google3 branch first, - then run: - $cd experimental/users/zhizhouy/benchtoolchain - Copy this directory to the place you want to put it. - -To use this suite: - 1. Configure the basic envrionment in env_setting file. - - 2. Run ./apply_patches.py, which will: - 1) Patch all the android benchmarks in the android tree. - Benchmark Panorama does not exist in android tree, so perftests/ - gets copied into the top-level of android tree. - - 2) Apply patch autotest.diff to android_root/external/autotest, which - includes all the test scripts for benchmarks. Copy testcases to - related autotest directory. - - If you have applied the patch partially and hope to discard the - patch, just run discard_patches.py - - 3. Build and run benchmark on the device using ./run.py. You can either - use test configuration file (-t test_config), or set all the variables - manually. - - 4. The raw results locate at bench_result_* in bench suite home - directory. - - 5. The JSON format result will be generated for crosperf report. - -Utility tools: - 1. Autotest is a test framework located in android exteranl/autotest - Before first time running it, please run - utils/build_externals.py first to ensure all the environments - and tools needed are installed. - - 2. Crosperf is a report generating tool in ChromeOS toolchain utilities. - Please look for it in chromium source: - src/third_party/toolchain-utils/crosperf. |