Mercurial > hg
annotate CONTRIBUTING @ 36958:644a02f6b34f
util: prefer "bytesio" to "stringio"
The io.BytesIO and io.StringIO types enforce the type of
data being operated on. On Python 2, we use cStringIO.StringIO(),
which is lax about mixing types. On Python 3, we actually use
io.BytesIO. Ideally, we'd use io.BytesIO on Python 2. But I believe
its performance is poor compared to cString.StringIO().
Anyway, we canonically define our pycompat type as "stringio."
That name is misleading, especially on Python 3.
This commit renames the canonical symbols to "bytesio."
"stringio" is preserved as an alias for API compatibility. There
are a lot of callers in the repo and I hesitate to take away the
old name. I also don't feel like changing everything at this time.
But at least new callers can use a "proper" name.
Differential Revision: https://phab.mercurial-scm.org/D2868
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Wed, 14 Mar 2018 11:52:35 -0700 |
parents | a492610a2fc1 |
children |
rev | line source |
---|---|
30084
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
1 Our full contribution guidelines are in our wiki, please see: |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
2 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
3 https://www.mercurial-scm.org/wiki/ContributingChanges |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
4 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
5 If you just want a checklist to follow, you can go straight to |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
6 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
7 https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
8 |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
9 If you can't run the entire testsuite for some reason (it can be |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
10 difficult on Windows), please at least run `contrib/check-code.py` on |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
11 any files you've modified and run `python contrib/check-commit` on any |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
12 commits you've made (for example, `python contrib/check-commit |
a492610a2fc1
contributing: add new file with a pointer to the wiki
Augie Fackler <augie@google.com>
parents:
diff
changeset
|
13 273ce12ad8f1` will report some style violations on a very old commit). |