CONTRIBUTING

util: improve iterfile so it chooses code path wisely

We have performance concerns on "iterfile" as it is 4X slower on normal
files. While modern systems have the nice property that reading a "fast"
(on-disk) file cannot be interrupted and should be made use of.

This patch dumps the related knowledge in comments. And "iterfile" chooses
code paths wisely:

  1. If it's CPython 3, or PyPY, use the fast path.
  2. If fp is a normal file, use the fast path.
  3. If fp is not a normal file and CPython version >= 2.7.4, use the same
     workaround (4x slower) as before.
  4. If fp is not a normal file and CPython version < 2.7.4, use another
     workaround (2x slower but may block longer then necessary) which
     basically re-invents the buffer + readline logic in Python.

This will give us good confidence on both correctness and performance
dealing with EINTR in iterfile(fp) for all known supported Python versions.

Our full contribution guidelines are in our wiki, please see:

https://www.mercurial-scm.org/wiki/ContributingChanges

If you just want a checklist to follow, you can go straight to

https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist

If you can't run the entire testsuite for some reason (it can be
difficult on Windows), please at least run `contrib/check-code.py` on
any files you've modified and run `python contrib/check-commit` on any
commits you've made (for example, `python contrib/check-commit
273ce12ad8f1` will report some style violations on a very old commit).