From dde3bc9f5aa0247bc5e03b8523ff79e0b15e8eee Mon Sep 17 00:00:00 2001 From: Austin Bingham Date: Thu, 29 Jul 2021 19:19:36 +0200 Subject: [PATCH] Added a note about committing before running exec. --- docs/source/tutorials/intro/index.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/tutorials/intro/index.rst b/docs/source/tutorials/intro/index.rst index 2cf83d02..c9657f06 100644 --- a/docs/source/tutorials/intro/index.rst +++ b/docs/source/tutorials/intro/index.rst @@ -307,6 +307,18 @@ This should produce no output. 10 seconds to run and Cosmic Ray finds 1000 mutations, a full ``exec`` will take 10 x 1000 = 10,000 seconds, or about 2.7 hours. +Committing before `exec` +------------------------ + +If you're using revision control with your code (you are, right?!), you should consider committing your changes before +running `exec`. While it's not strictly necessary to do this in simple cases, it's often important to commit if +you're using tools like `cr-http-workers` that rely on fetching code from a repository. + +Also, while Cosmic Ray is designed to be robust in the face of exceptions and crashes, there is always the possibility +that Cosmic Ray won't correctly undo a mutation. Remember, it makes mutations directly on disk, so if a mutation is +not correctly undone, and if you haven't committed your changes prior to testing, you run the risk of introducing +a mutation into you code accidentally. + Reporting the results =====================