Scripts and tools: Use #!/usr/bin/env bash instead of #!/bin/bash. by vim88 · Pull Request #14831 · bitcoin/bitcoin

vim88 · 2018-11-28T20:49:20Z

As it was discussed in #13510, it is better to use #!/usr/bin/env bash instead of #!/bin/bash.

practicalswift · 2018-11-28T20:55:27Z

Concept ACK

Take a look at how test/lint/lint-python-shebang.sh enforces the expected shebang for Python scripts.

maflcko · 2018-11-28T20:55:52Z

I thought we had a linter to lint those, but maybe the linters aren't linting themselves.

fanquake · 2018-11-29T11:00:15Z

utACK 50ec1c8

Checked that this is the only occurrence of #!/bin/bash in the code.

In future, please try and preface your commit message, and write a more descriptive message. i.e scripts: Use #!/usr/bin/env bash over obsoleted #!/bin/bash.

ch4ot1c · 2018-11-29T18:02:58Z

This note could be added to developer-notes.md.

practicalswift · 2018-11-30T09:38:08Z

@vim88 Could include the dev notes commit from #14846 here and keep these related changes to one PR?

Also, what about adding this:

diff --git a/test/lint/lint-python-shebang.sh b/test/lint/lint-python-shebang.sh
index 4ff87f0bf..3a023fd80 100755
--- a/test/lint/lint-python-shebang.sh
+++ b/test/lint/lint-python-shebang.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# Shebang must use python3 (not python or python2)
+# Assert expected shebang lines

 export LC_ALL=C
 EXIT_CODE=0
@@ -10,4 +10,10 @@ for PYTHON_FILE in $(git ls-files -- "*.py"); do
         EXIT_CODE=1
     fi
 done
+for SHELL_FILE in $(git ls-files -- "*.sh"); do
+    if [[ $(head -n 1 "${SHELL_FILE}") != "#!/usr/bin/env bash" && $(head -n 1 "${SHELL_FILE}") != "#!/bin/sh" ]]; then
+        echo "Missing expected shebang \"#!/usr/bin/env bash\" or \"#!/bin/sh\" in ${SHELL_FILE}"
+        EXIT_CODE=1
+    fi
+done
 exit ${EXIT_CODE}

And then git mv test/lint/lint-python-shebang.sh test/lint/lint-shebang.sh.

That way we'll never have to think about this ever again :-)

vim88 · 2018-11-30T20:13:05Z

I agree that we should keep all these related changes in this PR.

vim88 · 2018-11-30T20:26:30Z

I commited here the DOC additions from #14846 about Scripts shebang to developer-notes.md.

I also added the linting part for Shell Scripts shebang. (Thanks @practicalswift!)

vim88 · 2018-11-30T20:59:21Z

It seems that the Travis CI build failed for "Lint", so the new linting part for Shell Scripts shebang works.

Missing expected shebang "#!/usr/bin/env bash" or "#!/bin/sh" in contrib/qos/tc.sh
Missing expected shebang "#!/usr/bin/env bash" or "#!/bin/sh" in src/qt/res/movies/makespinner.sh
^---- failure generated from test/lint/lint-shebang.sh

Should I add the shebangs to those two files in this PR?
Also, is #!/usr/bin/env bash or #!/bin/sh preffered?

practicalswift · 2018-12-01T18:46:25Z

@vim88 Add shebangs to tc.sh and makespinner.sh too. They should have #!/usr/bin/env bash since they use bash features.

vim88 · 2018-12-01T19:01:30Z

I added the missing #!/usr/bin/env bash shebang to contrib/qos/tc.sh and src/qt/res/movies/makespinner.sh.

practicalswift · 2018-12-01T23:15:58Z

utACK 114ff903b69513fbfb7a3fc7fd19e6ef6ffa5a7e, but please squash commits

…e #!/bin/bash, added linting for .sh files shebang and updated the Developer Notes.

vim88 · 2018-12-02T14:23:04Z

I squashed the commits.

practicalswift · 2018-12-02T16:44:59Z

utACK 688f665

dongcarl · 2018-12-03T02:33:53Z

Fantastic! utACK 688f665

fanquake · 2018-12-03T03:52:41Z

re-utACK 688f665

Empact · 2018-12-04T11:16:14Z

utACK 688f665

…ad of #!/bin/bash. 688f665 Scripts and tools & Docs: Used #!/usr/bin/env bash instead of obsolete #!/bin/bash, added linting for .sh files shebang and updated the Developer Notes. (vim88) Pull request description: As it was discussed in [bitcoin#13510](bitcoin#13510), it is better to use `#!/usr/bin/env bash` instead of `#!/bin/bash`. Tree-SHA512: 25f71eb9a6a0cdc91568b5c6863205c5fe095f77a69e633503a2ac7805bd9013af8538e538c0c666ce96a28e3f43ce7a8df5f08d4ff007723bb588d85674f2da

vim88 · 2018-12-06T17:20:45Z

Thank you all!

…sh instead of #!/bin/bash. 688f665 Scripts and tools & Docs: Used #!/usr/bin/env bash instead of obsolete #!/bin/bash, added linting for .sh files shebang and updated the Developer Notes. (vim88) Pull request description: As it was discussed in [bitcoin#13510](bitcoin#13510), it is better to use `#!/usr/bin/env bash` instead of `#!/bin/bash`. Tree-SHA512: 25f71eb9a6a0cdc91568b5c6863205c5fe095f77a69e633503a2ac7805bd9013af8538e538c0c666ce96a28e3f43ce7a8df5f08d4ff007723bb588d85674f2da

maflcko added Refactoring Scripts and tools labels Nov 28, 2018

vim88 mentioned this pull request Nov 29, 2018

Docs: Adds development guidelines about Scripts shebang to developer-notes.md. #14846

Closed

Scripts and tools & Docs: Used #!/usr/bin/env bash instead of obsolet…

688f665

…e #!/bin/bash, added linting for .sh files shebang and updated the Developer Notes.

vim88 force-pushed the proper_shebang branch from 114ff90 to 688f665 Compare December 2, 2018 14:21

laanwj merged commit 688f665 into bitcoin:master Dec 6, 2018

str4d mentioned this pull request Oct 27, 2020

Backport useful lints from upstream zcash/zcash#4829

Merged

bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021

Conversation

vim88 commented Nov 28, 2018

Uh oh!

practicalswift commented Nov 28, 2018

Uh oh!

maflcko commented Nov 28, 2018

Uh oh!

fanquake commented Nov 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ch4ot1c commented Nov 29, 2018

Uh oh!

practicalswift commented Nov 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vim88 commented Nov 30, 2018

Uh oh!

vim88 commented Nov 30, 2018

Uh oh!

vim88 commented Nov 30, 2018

Uh oh!

practicalswift commented Dec 1, 2018

Uh oh!

vim88 commented Dec 1, 2018

Uh oh!

practicalswift commented Dec 1, 2018

Uh oh!

vim88 commented Dec 2, 2018

Uh oh!

practicalswift commented Dec 2, 2018

Uh oh!

dongcarl commented Dec 3, 2018

Uh oh!

fanquake commented Dec 3, 2018

Uh oh!

Empact commented Dec 4, 2018

Uh oh!

vim88 commented Dec 6, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

fanquake commented Nov 29, 2018 •

edited

Loading

practicalswift commented Nov 30, 2018 •

edited

Loading