Skip to content

Preserve empty lines in generated shell scripts #2463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openipc-ai merged 4 commits into from
Sep 20, 2026
Merged

Preserve empty lines in generated shell scripts #2463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b1d4334
Update strip-shell-comments.awk
usa- Sep 20, 2026
e216397
Merge branch 'master' into preserve-empty-lines
usa- Sep 20, 2026
7a02ff0
Address review comments
usa- Sep 20, 2026
7898f78
Merge branch 'master' into preserve-empty-lines
openipc-ai Sep 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/scripts/test_strip_shell_comments.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ else
ok "plain and indented comment lines are dropped"
fi

# #2386: blank lines stay, so the shipped script keeps its paragraph breaks.
printf '#!/bin/sh\necho one\n\necho two\n' > "$WORK/blank.sh"
if [ "$(strip "$WORK/blank.sh" | wc -l)" = 4 ]; then
ok "blank lines survive"
else
bad "a blank line was dropped"
fi

live=$(grep -c LIVE "$WORK/fixture.out")
if [ "$live" = 6 ]; then
ok "heredoc bodies, multi-line strings and continuations are left alone (6/6)"
Expand Down
5 changes: 3 additions & 2 deletions general/scripts/strip-shell-comments.awk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Drop whole-line comments and blank lines from a POSIX shell script.
# Drop whole-line comments from a POSIX shell script.
# Keep blank lines to preserve readability. See #2386.
#
# Comments are worth writing and worth keeping in the tree, but every byte of
# them is also flashed to an 8MB camera. sysupgrade alone reached 52KB, 57% of
Expand Down Expand Up @@ -104,7 +105,7 @@ BEGIN { nd = 0; sq = 0; dq = 0; cont = 0; prev_cont = 0 }
next
}

if (/^[ \t]*$/) next
if (/^[ \t]*$/) { print; next }
Comment thread
usa- marked this conversation as resolved.
Comment thread
usa- marked this conversation as resolved.
Comment thread
openipc-ai marked this conversation as resolved.

code = code_of($0)
if (code ~ /^[ \t]*$/) next # the line was only a comment
Expand Down
Loading