diff options
| author | John L. Villalovos <john.l.villalovos@intel.com> | 2015-09-17 14:30:45 -0700 |
|---|---|---|
| committer | John L. Villalovos <john.l.villalovos@intel.com> | 2015-09-17 14:32:24 -0700 |
| commit | 09668d4ba2dd7d4fdbe40938459a894cd5a62478 (patch) | |
| tree | e0b04b05c6daacb22de28f646a8198efe6c4ead6 /ironic/api | |
| parent | 548d73502f72df98500c79d9ec351d83ee8c9ede (diff) | |
| download | ironic-09668d4ba2dd7d4fdbe40938459a894cd5a62478.tar.gz | |
Help patch authors to remember to update version docs
Move note about updating the doc file so it is directly above line they
will change when adding a new version.
Change-Id: I03bd5952f77280022ccebc05274f246639895e30
Diffstat (limited to 'ironic/api')
| -rw-r--r-- | ironic/api/controllers/v1/versions.py | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/ironic/api/controllers/v1/versions.py b/ironic/api/controllers/v1/versions.py index f41d3314b..d6c0cfbe5 100644 --- a/ironic/api/controllers/v1/versions.py +++ b/ironic/api/controllers/v1/versions.py @@ -18,8 +18,7 @@ BASE_VERSION = 1 # Here goes a short log of changes in every version. # Refer to doc/source/webapi/v1.rst for a detailed explanation of what -# each version contains, and don't forget to update it when introducing -# a new version. +# each version contains. # # v1.0: corresponds to Juno API, not supported since Kilo # v1.1: API at the point in time when versioning support was added, @@ -56,7 +55,9 @@ MINOR_10_UNRESTRICTED_NODE_NAME = 10 MINOR_11_ENROLL_STATE = 11 MINOR_12_RAID_CONFIG = 12 -# When adding another version, update MINOR_MAX_VERSION +# When adding another version, update MINOR_MAX_VERSION and also update +# doc/source/webapi/v1.rst with a detailed explanation of what the version has +# changed. MINOR_MAX_VERSION = MINOR_12_RAID_CONFIG # String representations of the minor and maximum versions |