summaryrefslogtreecommitdiff
path: root/doc/HOWTO_RELEASE.rst.txt
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-06-22 17:28:09 -0600
committerCharles Harris <charlesr.harris@gmail.com>2015-06-22 17:28:09 -0600
commit7576ae2fde08452e3bc1e45a254856773b2012fc (patch)
tree3530c5b52333bc10a414a0031b2b51a71ab32a4d /doc/HOWTO_RELEASE.rst.txt
parent949df02d9477bd368837cc667bce3a8c23eb8413 (diff)
downloadnumpy-7576ae2fde08452e3bc1e45a254856773b2012fc.tar.gz
DOC: Revise doc/HOWTO_RELEASE.rst.txt a bit to read better.
[ci skip]
Diffstat (limited to 'doc/HOWTO_RELEASE.rst.txt')
-rw-r--r--doc/HOWTO_RELEASE.rst.txt15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/HOWTO_RELEASE.rst.txt b/doc/HOWTO_RELEASE.rst.txt
index 1847fd866..a88e4db47 100644
--- a/doc/HOWTO_RELEASE.rst.txt
+++ b/doc/HOWTO_RELEASE.rst.txt
@@ -261,13 +261,14 @@ There are three steps to the process.
2. If the C_API_VERSION in the first step has changed, or if the hash of
the API has changed, the cversions.txt file needs to be updated. To check
the hash, run the script numpy/core/cversions.py and note the api hash that
- is printed. If that hash does not match the last hash in cversions.txt the
- hash has changed. Using both the appropriate C_API_VERSION and hash, add a
- new entry to numpy/core/code_generators/cversions.txt. If the API version
- was not changed, but the hash differs, you will need to comment out the
- previous entry for that API version. For instance, in NumPy 1.9 annotations
- were added, which changed the hash, but the API was the same as in 1.8. The
- hash serves as a check for API changes, but it is not definitive.
+ is printed. If that hash does not match the last hash in
+ numpy/core/code_generators/cversions.txt the hash has changed. Using both
+ the appropriate C_API_VERSION and hash, add a new entry to cversions.txt.
+ If the API version was not changed, but the hash differs, you will need to
+ comment out the previous entry for that API version. For instance, in NumPy
+ 1.9 annotations were added, which changed the hash, but the API was the
+ same as in 1.8. The hash serves as a check for API changes, but it is not
+ definitive.
If steps 1 and 2 are done correctly, compiling the release should not give
a warning "API mismatch detect at the beginning of the build.