diff options
Diffstat (limited to 'scripts/difftool/README.md')
| -rw-r--r-- | scripts/difftool/README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/scripts/difftool/README.md b/scripts/difftool/README.md new file mode 100644 index 00000000..a06f725f --- /dev/null +++ b/scripts/difftool/README.md @@ -0,0 +1,42 @@ +# Difftool + +This directory contains tools to compare build artifacts from two separate +build invocations as a way of gauging build correctness and debugging +potential problems with build systems under development. + +# Usage + +Use of these tools requires a multistep process: + +1. Build using legacy build system: + ``` + $ m libc + ``` +2. Collect results to a tmp directory. + ``` + $ ./collect.py out/combined-aosp_flame.ninja \ + out/target/product/flame/obj/libc.so \ + /tmp/legacyFiles + ``` +3. Build using the new build system: + ``` + $ USE_BAZEL_ANALYSIS=1 m libc + ``` +4. Collect results to a tmp directory. + ``` + $ ./collect.py out/combined-aosp_flame.ninja \ + out/target/product/flame/obj/libc.so \ + /tmp/newFiles + ``` +5. Run comparative analysis on the two tmp directories. (See + documentation of difftool.py for exact usage.) + ``` + $ ./difftool.py /tmp/legacyFiles \ + out/target/product/flame/obj/libc.so \ + /tmp/newFiles \ + out/target/product/flame/obj/libc.so + ``` + +Use `./collect.py -h` or `./difftool.py -h` for full usage information of +these subtools. + |