tree 5777e31c5c768f94426fcb4a1c47aa09918da96f
parent c436ffe44ded235afbeb71cff49d6e9cf4ca25fa
parent 480616c7c872a1bea7031dac0ae57da8ca40d106
author bors[bot] <26634292+bors[bot]@users.noreply.github.com> 1617202287 +0000
committer GitHub <noreply@github.com> 1617202287 +0000
gpgsig -----BEGIN PGP SIGNATURE-----
 
 wsBcBAABCAAQBQJgZIxvCRBK7hj4Ov3rIwAAdHIIABVuS6CtsO9GJURSJu2ICAc/
 EHacQQ3a8aYRExOVUjmbIbkTqWZcYSDCd8ZEt0csjA6YgIpqFZLcaE+3WCXsCy69
 atHCJtf5NqVwX9Sy7eWM3hGUKsAXGKIH9f3ztgxBlZZmJn7K2iTLzq71MAT+st/Q
 hMi9Y0FMa6R6sPk40I7I1kIhHKeGDdKnyZWgyJlv8PcXNBHCFTFFHJF56g7H6FUS
 7ktoKOaypLynnpCHltn/JrEv27RdJw8bSqc9ng9ZbWQi7iendg3sefT26D0OXfnA
 aOKqmdoRqgheAHz+Isz9ryVC9uvr241qgaJtUX7UNMPxlMcwkD2mCCDRnAW0WPA=
 =ZlO4
 -----END PGP SIGNATURE-----
 

Merge #281

281: Run Miri with more flag combinations, and add a Miri Tips doc. r=alistair23 a=jrvanwhy

[Rendered doc](https://github.com/jrvanwhy/libtock-rs/blob/miri-flags/doc/MiriTips.md)

This runs code under Miri with the `-Zmiri-symbolic-alignment-check` flag, as well as both with and without `-Zmiri-track-raw-pointers`. This identifies a lot of "gray area" behavior -- that may or may not become specified as undefined behavior in the future -- as undefined behavior.

I also added a tip on how to write tests that identify undefined behavior that Miri doesn't catch by default, such as having uninitialized values in local variables. The documentation tip will be used in the `libtock_unittest` crate as well as per-crate unit tests.

Co-authored-by: Johnathan Van Why <jrvanwhy@google.com>