diff --git a/specs/liberty-template.rst b/specs/liberty-template.rst index 59a8e0889..5fbb5b65e 100644 --- a/specs/liberty-template.rst +++ b/specs/liberty-template.rst @@ -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 diff --git a/tests/test_titles.py b/tests/test_titles.py index 46f86b9db..5a61c1e41 100644 --- a/tests/test_titles.py +++ b/tests/test_titles.py @@ -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 = []