Merge "process: add new section History"

This commit is contained in:
Jenkins
2015-04-16 17:16:47 +00:00
committed by Gerrit Code Review
2 changed files with 25 additions and 1 deletions

View File

@@ -373,3 +373,20 @@ references are unavailable. Examples of what you could include are:
EC2 docs)
* Anything else you feel it is worthwhile to refer to
History
=======
Optional section for liberty intended to be used each time the spec
is updated to describe new design, API or any database schema
updated. Useful to let reader understand what's happened along the
time.
.. list-table:: Revisions
:header-rows: 1
* - Release Name
- Description
* - Liberty
- Introduced

View File

@@ -17,6 +17,12 @@ import docutils.core
import testtools
# Used for new sections introduced during a release.
# - "History" introduced in Liberty should be
# mandatory for M.
OPTIONAL_SECTIONS = ("History",)
class TestTitles(testtools.TestCase):
def _get_title(self, section_tree):
section = {
@@ -40,7 +46,8 @@ class TestTitles(testtools.TestCase):
return titles
def _check_titles(self, filename, expect, actual):
missing_sections = [x for x in expect.keys() if x not in actual.keys()]
missing_sections = [x for x in expect.keys() if (
x not in actual.keys()) and (x not in OPTIONAL_SECTIONS)]
extra_sections = [x for x in actual.keys() if x not in expect.keys()]
msgs = []