tools: add codespell makefile target (interactive spell checker)

- doc: fix typos
nodiscc · Jul 13, 2023 · ddecb2c · ddecb2c
1 parent 2268409
commit ddecb2c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -22,6 +22,7 @@ install_buildenv:
 clean:
 	sudo lb clean --all
 	make -f Makefile.extra clean
+	rm -rf .venv
 
 build:
 	# Build the live system/ISO image
@@ -140,6 +141,14 @@ BUILDDIR      = doc/html  # répertoire destination (html)
 doc_html:
 	source .venv/bin/activate && sphinx-build -c doc/md -b html doc/md doc/html
 
+.PHONY: codespell # manual - run interactive spell checker
+codespell:
+	python3 -m venv .venv && \
+	source .venv/bin/activate && \
+    pip3 install codespell && \
+	codespell --write-changes --interactive 3 --uri-ignore-words-list '*' \
+	--skip '*.venv/*,./.git/*,./doc/md/packages/*'
+
 #####
 
 .PHONY: help # generate list of targets with descriptions

diff --git a/config/includes.chroot/etc/apt/apt.conf.d/50unattended-upgrades b/config/includes.chroot/etc/apt/apt.conf.d/50unattended-upgrades
@@ -48,7 +48,7 @@ Unattended-Upgrade::Package-Blacklist {
     // The following matches all packages starting with linux-
 //  "linux-";
 
-    // Use $ to explicitely define the end of a package name. Without
+    // Use $ to explicitly define the end of a package name. Without
     // the $, "libc6" would match all of them.
 //  "libc6$";
 //  "libc6-dev$";

diff --git a/config/includes.chroot/etc/sysctl.d/custom.conf b/config/includes.chroot/etc/sysctl.d/custom.conf
@@ -40,7 +40,7 @@ net.ipv4.conf.all.secure_redirects = 0
 # Ignore any ICMP ECHO requests (ping)
 net.ipv4.icmp_echo_ignore_all = 1
 
-# Ignore all ICMP ECHO and TIMESTAMP requests received vai broadcast/multicast
+# Ignore all ICMP ECHO and TIMESTAMP requests received via broadcast/multicast
 net.ipv4.icmp_echo_ignore_broadcasts = 1
 
 # Limit the amount of traffic the system uses for ICMP.

diff --git a/doc/gen_package_lists.py b/doc/gen_package_lists.py
@@ -36,7 +36,7 @@ def get_package_metadata(package):
 
 
 def package_to_markdown(package, short_desc, long_desc, screenshot_url, pdo_url, version, pkg_type):
-	'''format package metdata to markdown
+	'''format package metadata to markdown
 	returns: markdown string'''
 	installed_icon = '![](green.png)'
 	optional_icon = '![](grey.png)'

diff --git a/doc/md/download-and-installation.md b/doc/md/download-and-installation.md
@@ -82,7 +82,7 @@ A live system runs entirely in memory and allows you to use the operating system
 
 No changes to the Live filesystem are kept after reboot, (eg. files in user directories), the system will reset to it's original state when the computer is powered off/rebooted. Changes to files/directory on other drives (external/USB drive, existing fixed disk...) attached to the computer _will_ be kept - save your work there if you need to keep your changes.
 
-The screen will lock after 5 minutes of inactivity during the live session. The passord to unlock it is `live`.
+The screen will lock after 5 minutes of inactivity during the live session. The password to unlock it is `live`.
 
 See **[Usage](usage.md)**