Permalink
Browse files

Document the purpose of the two indentation scripts in ./contrib/util…

…ities.
  • Loading branch information...
1 parent 980e1c5 commit 1bf651aba790afb16d21b4cd0f2d417b2a153f79 @bangerth bangerth committed Oct 29, 2016
Showing with 41 additions and 0 deletions.
  1. +28 −0 contrib/utilities/check_indentation.sh
  2. +13 −0 contrib/utilities/indent
@@ -1,4 +1,32 @@
#!/bin/sh
+## ---------------------------------------------------------------------
+##
+## Copyright (C) 2014 - 2016 by the deal.II authors
+##
+## This file is part of the deal.II library.
+##
+## The deal.II library is free software; you can use it, redistribute
+## it, and/or modify it under the terms of the GNU Lesser General
+## Public License as published by the Free Software Foundation; either
+## version 2.1 of the License, or (at your option) any later version.
+## The full text of the license can be found in the file LICENSE at
+## the top level of the deal.II distribution.
+##
+## ---------------------------------------------------------------------
+
+#
+# This is a script that is used by the continuous integration servers
+# to make sure that the currently checked out version of a git repository
+# satisfies our indentation standards.
+#
+# It does so by running the 'indent' script (located in the current
+# directory), calling 'git diff' to show what differences exist between
+# the correctly indented code and what is in the git index (which is
+# typically what is in the last commit), and then running a command
+# that either returns success or failure, depending on whether or not
+# there are differences. The continuous integration services return
+# a failure code for a pull request if this script returns a failure.
+#
if [ "${TRAVIS_PULL_REQUEST}" = "false" ]; then
echo "Running indentation test on master merge."
@@ -14,6 +14,19 @@
##
## ---------------------------------------------------------------------
+#
+# This script indents all source files of deal.II according to our
+# usual code formatting standards. It is used to ensure that our
+# code base looks uniform, as uniformity helps make code easier to
+# read.
+#
+# The script needs to be executed as
+# ./contrib/utilities/indent
+# from the top-level directory of the source tree, or via
+# make indent
+# from a build directory.
+#
+
if test ! -d source -o ! -d include -o ! -d examples ; then
echo "*** This script must be run from the top-level directory of deal.II."
exit 1

0 comments on commit 1bf651a

Please sign in to comment.