summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Herlant <aerostitch@debian.org>2019-11-10 14:17:24 -0800
committerJoseph Herlant <aerostitch@debian.org>2019-11-10 14:17:24 -0800
commit9692e7a56a215dc9336be19553c0a41c4516c483 (patch)
treeaa04647469e614fb4fead9006bfd0e8bfde8241b
parent209c55f43319430fa8fbd088b300e570f19f2d6f (diff)
downloadnavit-aerostitch/checkstylexml.tar.gz
update:doc:Specify a minimum version needed for checkstyle outside of gradleaerostitch/checkstylexml
-rw-r--r--docs/development/programming_guidelines.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/development/programming_guidelines.rst b/docs/development/programming_guidelines.rst
index c04f8daab..66dc257a4 100644
--- a/docs/development/programming_guidelines.rst
+++ b/docs/development/programming_guidelines.rst
@@ -206,4 +206,8 @@ For the Java code we follow the Google coding conventions from Google Java Style
This style is enforced by using Checkstyle. Its definition file can be found at the root of the repository:
`checkstyle.xml <https://github.com/navit-gps/navit/blob/trunk/checkstyle.xml>`_
+.. note::
+
+ Checkstyle 8.25 minimum is required if you want to run checkstyle without using gradle.
+
Please add yourself to the list of authors, if you make a significant change.