summary refs log tree commit diff stats
diff options
context:
space:
mode:
authortoonn <toonn@toonn.io>2018-10-14 20:52:11 +0200
committertoonn <toonn@toonn.io>2019-06-18 13:26:21 +0200
commit2c0f1112150af11c1ece2ac889ddf12d643fff04 (patch)
tree2fcc5fcfa083d4e6b50a270c1955988db0d40a65
parent88b4d3747072db6e39fb44fff6055ba842b3203f (diff)
downloadranger-2c0f1112150af11c1ece2ac889ddf12d643fff04.tar.gz
Document ## convention and $$ sed range
-rw-r--r--Makefile1
-rwxr-xr-xranger/data/scope.sh4
2 files changed, 5 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 0c2dbe46..4daf0b46 100644
--- a/Makefile
+++ b/Makefile
@@ -116,6 +116,7 @@ test_py: test_pylint test_flake8 test_doctest test_pytest test_other
 
 test_shellcheck:
 	@echo "Running shellcheck..."
+	# The $ for the range needs to be escaped because of make.
 	sed '2,$$s/^\( *\)#/\1/' ./ranger/data/scope.sh | shellcheck -a -
 
 test_other:
diff --git a/ranger/data/scope.sh b/ranger/data/scope.sh
index 6ff5e3c3..6217af70 100755
--- a/ranger/data/scope.sh
+++ b/ranger/data/scope.sh
@@ -11,6 +11,10 @@ IFS=$'\n'
 ## This script is considered a configuration file and must be updated manually.
 ## It will be left untouched if you upgrade ranger.
 
+## Because of some automated testing we do on the script #'s for comments need
+## to be doubled up. Code that is commented out, because it's an alternative for
+## example, gets only one #.
+
 ## Meanings of exit codes:
 ## code | meaning    | action of ranger
 ## -----+------------+-------------------------------------------