Skip to content

Commit

Permalink
[doc] Updated warning about MINOR/PATCH support.
Browse files Browse the repository at this point in the history
  • Loading branch information
DePierre committed Jan 30, 2017
1 parent aa56037 commit f214206
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
8 changes: 3 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,6 @@ Current support
+ wapiti (2.x.x) (XML report)


*Warning*: PTP relies on the fact that the supported tools are following `semantic version <http://semver.org/>`_
(except observed otherwise). In other words, when the supported tools increment their MINOR version and/or their PATCH
version, they do not break compatibility with the previous version. Based on that fact, PTP supposes that it supports
all version of a tool, as long as the MAJOR version has not been incremented (or an issue is created to report a broken
support). We might change our mind if it appears that the supported tools keep breaking their backward-compatibility.
*Warning*: Since v0.4, PTP relies on the fact that the supported tools are following `semantic version <http://semver.org/>`_
(except observed otherwise). In other words, as long as the tool doesn't update its MAJOR version, PTP will assume that
it can parse its report, reducing the maintenance cost on our side.
10 changes: 3 additions & 7 deletions docs/source/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,9 @@ complex parsing.

.. warning::

PTP relies on the fact that the supported tools are following `semantic version <http://semver.org/>`_ (except
observed otherwise). In other words, when the supported tools increment their MINOR version and/or their PATCH
version, they do not break compatibility with the previous version.

Based on that fact, PTP supposes that it supports all version of a tool, as long as the MAJOR version has not been
incremented (or an issue is created to report a broken support). We might change our mind if it appears that the
supported tools keep breaking their backward-compatibility.
Since v0.4, PTP relies on the fact that the supported tools are following `semantic version <http://semver.org/>`_
(except observed otherwise). In other words, as long as the tool doesn't update its MAJOR version, PTP will assume
that it can parse its report, reducing the maintenance cost on our side.

============
Installation
Expand Down

0 comments on commit f214206

Please sign in to comment.