diff --git a/do-clang-format.py b/do-clang-format.py index b20401efa5ff5400c4e4c623a52675fe55d4f887..ddd30febd49f8b72993974a5f4752ed11d53dd3f 100755 --- a/do-clang-format.py +++ b/do-clang-format.py @@ -1,9 +1,22 @@ #!/usr/bin/env python3 + +# +# (c) Copyright 2020 CORSIKA Project, corsika-project@lists.kit.edu +# +# This software is distributed under the terms of the GNU General Public +# Licence version 3 (GPL Version 3). See file LICENSE for a full version of +# the license. +# + """ Run clang-format with the style file in the CORSIKA repository. -By default it finds new files and files with modifications with respect to the current master and prints the filenames which need clang-formatting. Returns 1 if there are files which need modifications and 0 otherwise, so it can be used as a test. +By default it finds new files and files with modifications with respect +to the current master and prints the filenames which need clang-formatting. +Returns 1 if there are files which need modifications and 0 otherwise, +so it can be used as a test. """ + import argparse import subprocess as subp import os diff --git a/do-copyright.py b/do-copyright.py index b2da9fc14923dc3c4776274e64ded4d9317230ed..3aff3bf32a7cd313d3afe4c9ceb88b831364755e 100755 --- a/do-copyright.py +++ b/do-copyright.py @@ -1,5 +1,22 @@ #!/usr/bin/env python3 +# +# (c) Copyright 2020 CORSIKA Project, corsika-project@lists.kit.edu +# +# This software is distributed under the terms of the GNU General Public +# Licence version 3 (GPL Version 3). See file LICENSE for a full version of +# the license. +# + +""" +Script to crawl all files (hpp,inl,cpp) in a directory structure and +check if there is an initial comment block within each file that +resembles the CORSIKA 8 copyright notice. + +Exceptions can be specified in `excludeDirs` and `excludedFiles`. +""" + + import os import sys, getopt import re diff --git a/documentation/conf.py b/documentation/conf.py index d281602e9bc083acc9046491a7bfcb952303b945..34cc559889877ed699886b3e4fa8d2b0db6672f6 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -1,3 +1,15 @@ +# +# (c) Copyright 2020 CORSIKA Project, corsika-project@lists.kit.edu +# +# This software is distributed under the terms of the GNU General Public +# Licence version 3 (GPL Version 3). See file LICENSE for a full version of +# the license. +# + +""" +Readthedocs script to build documentation remotely. +""" + import sys import subprocess, os