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 /binary_search_tool/sysroot_wrapper | |
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 'binary_search_tool/sysroot_wrapper')
-rw-r--r-- | binary_search_tool/sysroot_wrapper/README | 28 | ||||
-rw-r--r-- | binary_search_tool/sysroot_wrapper/README.md | 35 |
2 files changed, 35 insertions, 28 deletions
diff --git a/binary_search_tool/sysroot_wrapper/README b/binary_search_tool/sysroot_wrapper/README deleted file mode 100644 index 599d700d..00000000 --- a/binary_search_tool/sysroot_wrapper/README +++ /dev/null @@ -1,28 +0,0 @@ -This is a set of scripts to use when triaging compiler problem by using -the bisecting functionality included in the sysroot_wrapper.hardened. -The only script that you need to create for your triaging problem is the -test_script.sh (The ones in this directory are here only as an example). - -Before running the binary searcher tool you will need to run the setup script: - -./sysroot_wrapper/setup.sh ${board} ${remote_ip} ${package} - -This setup script will ensure your $BISECT_DIR is properly populated and -generate a common variable script for the convenience of the scripts in -./sysroot_wrapper - -To run the binary searcher tool with these scripts, execute it like this: - -./binary_search_state.py --get_initial_items=./sysroot_wrapper/get_initial_items.sh --switch_to_good=./sysroot_wrapper/switch_to_good.sh --switch_to_bad=./sysroot_wrapper/switch_to_bad.sh --test_script=./sysroot_wrapper/test_script.sh --noincremental --file_args 2>&1 | tee /tmp/binary_search.log - -Finally once done you will want to run the cleanup script: - -./sysroot_wrapper/cleanup.sh - -For more information on how to use the sysroot_wrapper to do object file -triaging see: - -https://sites.google.com/a/google.com/chromeos-toolchain-team-home2/home/team-tools-and-scripts/bisecting-compiler-problems - - - diff --git a/binary_search_tool/sysroot_wrapper/README.md b/binary_search_tool/sysroot_wrapper/README.md new file mode 100644 index 00000000..89904a0b --- /dev/null +++ b/binary_search_tool/sysroot_wrapper/README.md @@ -0,0 +1,35 @@ +# Sysroot wrapper + +This is a set of scripts to use when triaging compiler problem by using +the bisecting functionality included in the `sysroot_wrapper.hardened`. +The only script that you need to create for your triaging problem is the +`test_script.sh` (The ones in this directory are here only as an example). + +Before running the binary searcher tool you will need to run the setup script: + +``` +./sysroot_wrapper/setup.sh ${board} ${remote_ip} ${package} +``` + +This setup script will ensure your `$BISECT_DIR` is properly populated and +generate a common variable script for the convenience of the scripts in +`./sysroot_wrapper` + +To run the binary searcher tool with these scripts, execute it like this: + +``` +./binary_search_state.py \ + --get_initial_items=./sysroot_wrapper/get_initial_items.sh \ + --switch_to_good=./sysroot_wrapper/switch_to_good.sh \ + --switch_to_bad=./sysroot_wrapper/switch_to_bad.sh \ + --test_script=./sysroot_wrapper/test_script.sh \ + --noincremental \ + --file_args \ + 2>&1 | tee /tmp/binary_search.log +``` + +Finally once done you will want to run the cleanup script: +`./sysroot_wrapper/cleanup.sh` + +For more information on how to use the `sysroot_wrapper` to do object file +triaging see: https://sites.google.com/a/google.com/chromeos-toolchain-team-home2/home/team-tools-and-scripts/bisecting-compiler-problems |