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 /bestflags | |
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 'bestflags')
-rw-r--r-- | bestflags/README.md (renamed from bestflags/README) | 6 | ||||
-rw-r--r-- | bestflags/examples/omnetpp/README.md (renamed from bestflags/examples/omnetpp/README) | 25 |
2 files changed, 22 insertions, 9 deletions
diff --git a/bestflags/README b/bestflags/README.md index d9fc5ba6..c9f4397d 100644 --- a/bestflags/README +++ b/bestflags/README.md @@ -1,3 +1,5 @@ +# bestflags + There is a vast set of compiler flags that can be used to build Chrome for ChromeOS. This option space has not been explored before. This directory provides an infrastructure to build Chrome with certain flag combinations, test @@ -6,10 +8,10 @@ infrastructure supports plug-in modules that implement algorithms for searching in the N-Dimensional space of compiler flag combinations. Currently, three different algorithms are built, namely genetic algorithm, hill -climbing and negative flag iterative elimination. The module 'testing_batch.py' +climbing and negative flag iterative elimination. The module `testing_batch.py` contains the testing of these algorithms. -To run the script, type in python testing_batch.py. +To run the script, type in `python testing_batch.py`. For further information about the project, please refer to the design document at: diff --git a/bestflags/examples/omnetpp/README b/bestflags/examples/omnetpp/README.md index eba522fe..b4582d0d 100644 --- a/bestflags/examples/omnetpp/README +++ b/bestflags/examples/omnetpp/README.md @@ -1,23 +1,34 @@ +# `omnetpp` + This directory contains the omnetpp example in SPEC2006 benchmark. It also contains the json configuration file which includes the meta data information to run the experiment. -This directory contains a build file build_omnetpp which is used by the build +This directory contains a build file `build_omnetpp` which is used by the build module of the framework to compile the application. -This directory contains a test file test_omnetpp which is used by the test +This directory contains a test file `test_omnetpp` which is used by the test module of the framework to benchmark the optimization compilation. This directory contains a conf file which includes the set of optimization flags the experiment will try. To use this direction, first gives the file the executable permission. - chmod a+x build_bikjmp - chmod a+x test_bikjmp + +``` +chmod a+x build_bikjmp +chmod a+x test_bikjmp +``` Copy the SPEC2006 benchmark into this directory. -To run, invoke the example_algorithm.py in the parent directory. - python example_algorithms.py --file=examples/omnetpp/example.json +To run, invoke the `example_algorithm.py` in the parent directory. + +``` +python example_algorithms.py --file=examples/omnetpp/example.json +``` For help, - python example_algorithms.py --help
\ No newline at end of file + +``` +python example_algorithms.py --help +``` |