refactor: miscellaneous fixes to visualizations
This change introduces some minor refactoring work to both
visualization scripts, namely:
- Comments reflowed to reach 80 characters per line
- Fixes to the category names for more recent versions of Tokei
- GNUPlot scripts no longer require a fixed number of columns
- Whitespace inconsistency fixes
SLOC-specific changes:
- Updated extended color palette to prevent color cycling
- Search directories can now be passed via arguments
- Parent directories no longer include their children's stats
Change-Id: I3f0ecb849a97f1f8008423772ddde4ca8c4771c2
Signed-off-by: Chris Kay <chris.kay@arm.com>
Co-authored-by: Weronika Wiesiolek <weronika.wiesiolek@arm.com>
diff --git a/script/graphs/README.rst b/script/graphs/README.rst
index f9db4a1..0860cb2 100644
--- a/script/graphs/README.rst
+++ b/script/graphs/README.rst
@@ -6,35 +6,41 @@
All scripts produce a PNG graph on stdout and the data on stderr.
-Test Runs by category
----------------------
+Tests by Category
+-----------------
The script `categorize-tests.bash`, and its associated awk and plot scripts,
-generate a stacked bar chart with bars representing groups of tests (l1 l2,
-etc.) and segments of the bars representing types. `categorize-tests.bash`
+generate a stacked bar chart with bars representing groups of tests (L1 L2,
+etc.) and segments of the bars representing types. ``categorize-tests.bash``
accepts an argument to filter the tests included with grep.
-For example, the following will produce a graph of the juno-specific tests:
+For example, the following will produce a graph of the Juno-specific tests:
+
+.. code-block::
bash categorize-tests.bash juno > juno-tests.png 2> juno-tests.txt
Lines of Code by Module
-----------------------
-The script `sloc-viz.bash`, and its associated plot script, generate a stacked
-bar chart where each bar is a module and the bars' segments represent programming
-languages (or documentation languages). This script will produce a graph for
-whatever directory it's run within, and has special logic that includes more
-detail when run from the Trusted Firmware - A project's root directory.
+The script ``sloc-viz.bash``, and its associated plot script, generate a stacked
+bar chart where each bar is a module and the bars' segments represent
+programming languages (or documentation languages). This script will produce a
+graph for whatever directory it's run within, and has special logic that
+includes more detail when run from the Trusted Firmware - A project's root
+directory.
This script has additional requirements:
+
* ``tokei`` - a quick source lines of code counting tool
* ``jq`` - a JSON query language for the command line, version 1.6 or later
as the ``--jsonargs`` option is required
-For example, when run from the root of TF-A, the following commandline will graph
-sloc of TF-A:
+For example, when run from the root of TF-A, the following command line will
+graph SLOC of TF-A:
+
+.. code-block::
bash ../<this-repo>/script/graph/sloc-viz.bash > sloc.png 2> sloc.tsv
-*Copyright (c) 2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2021-2022, Arm Limited. All rights reserved.*