doc: use recommended shebang approach in documentation code block #17751

pull hackerrdave wants to merge 1 commits into bitcoin:master from hackerrdave:docs-shebang changing 1 files +1 −1

hackerrdave commented at 12:40 AM on December 16, 2019: contributor

Documentation update to use recommended shebang approach mentioned in the developer notes
fanquake added the label Docs on Dec 16, 2019
hackerrdave force-pushed on Dec 16, 2019
promag commented at 1:32 AM on December 17, 2019: member

Have you searched for similar places were this change could be applied?
hackerrdave commented at 1:50 AM on December 17, 2019: contributor

@promag Yea, the only other place I believe that this change could be applied is: https://github.com/bitcoin/bitcoin/blob/master/test/lint/lint-shell.sh#L54

I'll add that change as well
hackerrdave force-pushed on Dec 17, 2019
fanquake commented at 1:57 AM on December 17, 2019: member

Please squash your commits.
hackerrdave force-pushed on Dec 17, 2019
in test/lint/lint-shell.sh:53 in e5e6c52781 outdated
```
  50 | @@ -51,7 +51,7 @@ do
  51 |      echo
  52 |      echo "$descriptor"
  53 |      # Use #!/bin/bash as gitian-builder/bin/gbuild does to complete a script.
```
laanwj commented at 9:09 AM on December 17, 2019:

pleas update the comment as well

hackerrdave commented at 2:52 PM on December 17, 2019:

updated comment

hebasto commented at 4:55 PM on December 17, 2019:

#17751 (review)
hackerrdave force-pushed on Dec 17, 2019

in test/lint/lint-shell.sh:54 in 8dea322688 outdated

  49 | @@ -50,8 +50,8 @@ for descriptor in $(git ls-files -- 'contrib/gitian-descriptors/*.yml')
  50 |  do
  51 |      echo
  52 |      echo "$descriptor"
  53 | -    # Use #!/bin/bash as gitian-builder/bin/gbuild does to complete a script.
  54 | -    SCRIPT=$'#!/bin/bash\n'$(yq -r .script "$descriptor")
  55 | +    # Use #!/usr/bin/env bash to complete script with preferred shebang approach.
  56 | +    SCRIPT=$'#!/usr/bin/env bash\n'$(yq -r .script "$descriptor")

hebasto commented at 4:52 PM on December 17, 2019:

Please do not change these lines as it is intended to mimic the way gitian-builder/bin/gbuild does: #17361 (review)

... and the comment says so ;)

hackerrdave commented at 5:16 PM on December 17, 2019:

ah gotcha! Thank you for the clarification - will remove this change

hebasto changes_requested
use preferred shebang approach for documentation 6094222de7
hackerrdave force-pushed on Dec 17, 2019
hebasto approved
hebasto commented at 7:07 PM on December 20, 2019: member

ACK 6094222de7820d235e6e8c66e589aa71db08c077, I have reviewed the code, and it looks OK, I agree it can be merged.
MarcoFalke referenced this in commit 0cda557340 on Dec 20, 2019
MarcoFalke merged this on Dec 20, 2019
MarcoFalke closed this on Dec 20, 2019
sidhujag referenced this in commit 54ccaf1dad on Dec 20, 2019
jasonbcox referenced this in commit be4866e55d on Nov 9, 2020
sidhujag referenced this in commit 886f68fdd9 on Nov 10, 2020
PastaPastaPasta referenced this in commit bee6af3f12 on Jun 27, 2021
PastaPastaPasta referenced this in commit 2ac390ff91 on Jun 28, 2021
PastaPastaPasta referenced this in commit aaec072d05 on Jun 29, 2021
PastaPastaPasta referenced this in commit e4e943b007 on Jul 1, 2021
PastaPastaPasta referenced this in commit 0fa5479a5c on Jul 1, 2021
PastaPastaPasta referenced this in commit b5141f33cd on Jul 14, 2021
PastaPastaPasta referenced this in commit 693f054f19 on Jul 14, 2021
DrahtBot locked this on Feb 15, 2022

Contributors

Labels