add license header and module docstring removing not valid variable docstrings

1 files changed, 33 insertions, 11 deletions

diff --git a/src/globalvars.py b/src/globalvars.py
index f1f76ab..e18a589 100644
--- a/src/globalvars.py
+++ b/src/globalvars.py
@@ -1,37 +1,59 @@
+# Copyright 2018-2019 Florian Fischer <florian.fl.fischer@fau.de>
+#
+# This file is part of allocbench.
+#
+# allocbench is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# allocbench is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with allocbench.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Global variables for allocbench
+
+facts: Dict holding facts about the current benchmark run
+verbosity: Verbosity level -1: quiet, 0: status, 1: info, 2: stdout of subcommands, 3: debug info
+allocators: Dict holding the allocators to compare
+benchmarks: List of available benchmarks
+
+allocbenchdir: Root directory of allocbench
+srcdir: Directory of allocbench sources
+benchsrcdir: Source directory for all benchmarks
+allocsrcdir: Source directory for all benchmarks
+builddir: Path of the build directory
+allocbuilddir: Path of the allocators build directory
+resdir: Directory were the benchmark results are stored
+"""
+
 import inspect
 import os
 
 
-"""Dict holding facts about the current benchmark run"""
 facts = {}
 
-"""Verbosity level -1: quiet, 0: status, 1: info, 2: stdout of subcommands, 3: debug info"""
 verbosity = 0
 
-"""Dict holding the allocators to compare"""
 allocators = {}
 
-"""Directory of allocbench sources"""
 srcdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
 
-"""Source directory for all benchmarks"""
 benchsrcdir = os.path.join(srcdir, "benchmarks")
 
-"""Source directory for all benchmarks"""
 allocsrcdir = os.path.join(srcdir, "allocators")
 
-"""Root directory of allocbench"""
 allocbenchdir = os.path.dirname(srcdir)
 
-"""Path of the build directory"""
 builddir = os.path.join(allocbenchdir, "build")
 
-"""Path of the allocators build directory"""
 allocbuilddir = os.path.join(builddir, "allocators")
 
-"""Directory were the benchmark results are stored"""
 resdir = None
 
-"""List of available benchmarks"""
 benchmarks = [e[:-3] for e in os.listdir(os.path.join(allocbenchdir, benchsrcdir))
               if e[-3:] == ".py" and e != "__init__.py"]