diff --git a/dev-scripts/build-debian-pkg b/dev-scripts/build-debian-pkg index e98fd091b..50e0c4dfd 100755 --- a/dev-scripts/build-debian-pkg +++ b/dev-scripts/build-debian-pkg @@ -1,5 +1,5 @@ #!/bin/bash - +# # Build TinyPilot Debian packages. # # Usage: diff --git a/dev-scripts/check-all b/dev-scripts/check-all index b450fdcf6..a66581b18 100755 --- a/dev-scripts/check-all +++ b/dev-scripts/check-all @@ -1,4 +1,8 @@ #!/bin/bash +# +# Executes all check scripts. +# +# It only skips `check-debian-pkg`, because that one has special prerequisites. # Exit on first failure. set -e diff --git a/dev-scripts/check-bash b/dev-scripts/check-bash index f26d99b01..bcd57037f 100755 --- a/dev-scripts/check-bash +++ b/dev-scripts/check-bash @@ -1,5 +1,5 @@ #!/bin/bash - +# # Run tests and static analysis on bash scripts. # Exit on first failure. diff --git a/dev-scripts/check-for-init-py-files b/dev-scripts/check-for-init-py-files index fc694fba7..0851578d8 100755 --- a/dev-scripts/check-for-init-py-files +++ b/dev-scripts/check-for-init-py-files @@ -1,5 +1,5 @@ #!/bin/bash - +# # Test if __init__.py file exists in directory containing .py files. # Exit on first failure. diff --git a/dev-scripts/check-javascript b/dev-scripts/check-javascript index fd3058e13..3502cb319 100755 --- a/dev-scripts/check-javascript +++ b/dev-scripts/check-javascript @@ -1,4 +1,6 @@ #!/bin/bash +# +# Runs tests and static analysis on JavaScript files. # Exit on first failure. set -e diff --git a/dev-scripts/check-python b/dev-scripts/check-python index f018e6ff1..b07c3367d 100755 --- a/dev-scripts/check-python +++ b/dev-scripts/check-python @@ -1,4 +1,6 @@ #!/bin/bash +# +# Runs tests and static analysis on Python files. # Exit on first failure. set -e diff --git a/dev-scripts/check-sql b/dev-scripts/check-sql index 0e9decb76..473737291 100755 --- a/dev-scripts/check-sql +++ b/dev-scripts/check-sql @@ -1,5 +1,5 @@ #!/bin/bash - +# # Checks for SQL script anti-patterns. # Exit on first failure. diff --git a/dev-scripts/check-style b/dev-scripts/check-style index 11c61b4e6..fee1638bb 100755 --- a/dev-scripts/check-style +++ b/dev-scripts/check-style @@ -1,5 +1,5 @@ #!/bin/bash - +# # Checks formatting for non-Python files. # Exit on first failure. diff --git a/dev-scripts/check-trailing-newline b/dev-scripts/check-trailing-newline index 0d200ef49..5619b6cc4 100755 --- a/dev-scripts/check-trailing-newline +++ b/dev-scripts/check-trailing-newline @@ -1,5 +1,5 @@ #!/bin/bash - +# # Verify that all text files end in a trailing newline. # Exit on first failing command. diff --git a/dev-scripts/check-trailing-whitespace b/dev-scripts/check-trailing-whitespace index 443652eb6..98f1d2185 100755 --- a/dev-scripts/check-trailing-whitespace +++ b/dev-scripts/check-trailing-whitespace @@ -1,5 +1,5 @@ #!/bin/bash - +# # Check for trailing whitespace # Exit on first failing command. diff --git a/dev-scripts/decode-edid b/dev-scripts/decode-edid index fb21b9f35..d93045699 100755 --- a/dev-scripts/decode-edid +++ b/dev-scripts/decode-edid @@ -1,5 +1,5 @@ #!/bin/bash - +# # Decode the EDID from the TinyPilot install defaults. # This script facilitates debugging the EDID and creates helpful logs of EDID diff --git a/dev-scripts/device/install-from-source b/dev-scripts/device/install-from-source index a05b41359..8afd3e823 100755 --- a/dev-scripts/device/install-from-source +++ b/dev-scripts/device/install-from-source @@ -1,5 +1,5 @@ #!/bin/bash - +# # Installs the local directory's version of TinyPilot's code onto the current # system. # diff --git a/dev-scripts/dump-logs b/dev-scripts/dump-logs index 36afac521..4bf1ccd45 100755 --- a/dev-scripts/dump-logs +++ b/dev-scripts/dump-logs @@ -1,8 +1,8 @@ #!/bin/bash - +# # The canonical way to dump logs is through the script below, # but this file is here for backwards compatibility. - +# # Without this file, we have no way of giving users a dump logs command # that will work regardless of TinyPilot version. diff --git a/dev-scripts/enable-git-hooks b/dev-scripts/enable-git-hooks index 1b1b040c4..6174318cc 100755 --- a/dev-scripts/enable-git-hooks +++ b/dev-scripts/enable-git-hooks @@ -1,5 +1,5 @@ #!/bin/bash - +# # Enables all git hooks for this project. # Exit on first failure. diff --git a/dev-scripts/enable-mock-scripts b/dev-scripts/enable-mock-scripts index e5d353674..c46e7c8e6 100755 --- a/dev-scripts/enable-mock-scripts +++ b/dev-scripts/enable-mock-scripts @@ -1,5 +1,5 @@ #!/bin/bash - +# # Creates a symlink from /opt/tinypilot-privileged/scripts to dev-scripts/mock-scripts # to facilitate development on non-TinyPilot systems. diff --git a/dev-scripts/enable-multiarch-docker b/dev-scripts/enable-multiarch-docker index e39b20c98..e3f68fff4 100755 --- a/dev-scripts/enable-multiarch-docker +++ b/dev-scripts/enable-multiarch-docker @@ -1,5 +1,5 @@ #!/bin/bash - +# # Configure Docker to support multiarch builds, allowing it to use QEMU to build # images targeting different CPU architectures. diff --git a/dev-scripts/enable-passwordless-sudo b/dev-scripts/enable-passwordless-sudo index 39a8c3ba8..984e76aa5 100755 --- a/dev-scripts/enable-passwordless-sudo +++ b/dev-scripts/enable-passwordless-sudo @@ -1,10 +1,10 @@ #!/bin/bash # # Enable passwordless sudo for paths that TinyPilot requires. - +# # Note: If you run with passwordless sudo enabled globally for your user # account, you don't need to run this script. - +# # In production, TinyPilot has permission to run an allowlist of paths with sudo # permissions. For developers who don't have passwordless sudo enabled globally # for their user account, certain TinyPilot functionality will fail waiting on a diff --git a/dev-scripts/fix-style b/dev-scripts/fix-style index 0bd51939b..fff41dd60 100755 --- a/dev-scripts/fix-style +++ b/dev-scripts/fix-style @@ -1,5 +1,5 @@ #!/bin/bash - +# # Fixes formatting for non-Python files. # Exit on first failure. diff --git a/dev-scripts/serve-dev b/dev-scripts/serve-dev index 5e0688f2e..16028c408 100755 --- a/dev-scripts/serve-dev +++ b/dev-scripts/serve-dev @@ -1,4 +1,6 @@ #!/bin/bash +# +# Starts the backend server in development mode. # Exit on first failure. set -e