patches and low-level development discussion
 help / color / mirror / code / Atom feed
* [PATCH v2] Remove bashisms from spectrum shell scripts
@ 2022-11-09  6:22 Henri Rosten
  2022-11-09 13:03 ` Alyssa Ross
  0 siblings, 1 reply; 3+ messages in thread
From: Henri Rosten @ 2022-11-09  6:22 UTC (permalink / raw)
  To: devel; +Cc: Henri Rosten

This commit removes bashisms from spectrum shell scripts. This change is
needed to be able to use the scripts from POSIX-compliant shells which
are not bash compatible - such as dash.

Signed-off-by: Henri Rosten <henri.rosten@unikie.com>
---
 Documentation/scripts/undocumented-uuids.sh |  7 ++++++-
 scripts/format-uuid.sh                      | 15 ++++++++++++++-
 scripts/make-gpt.sh                         |  7 +++----
 3 files changed, 23 insertions(+), 6 deletions(-)

diff --git a/Documentation/scripts/undocumented-uuids.sh b/Documentation/scripts/undocumented-uuids.sh
index 34c2d22..fa21366 100755
--- a/Documentation/scripts/undocumented-uuids.sh
+++ b/Documentation/scripts/undocumented-uuids.sh
@@ -1,14 +1,19 @@
 #!/bin/sh -eu
 # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+# SPDX-FileCopyrightText: 2022 Unikie
 # SPDX-License-Identifier: EUPL-1.2+
 
+trap 'rm -f -- "$documented_uuids"' EXIT
+
 cd "$(dirname "$0")/../.."
 
 PATTERN='\b[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}\b'
 UUID_REFERENCE_PATH=Documentation/uuid-reference.adoc
 
+documented_uuids=$(mktemp)
+grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u >$documented_uuids
 git ls-files -coz --exclude-standard |
     grep -Fxvz "$UUID_REFERENCE_PATH" |
     xargs -0 git grep -Ehio --no-index --no-line-number "$PATTERN" -- |
     sort -u |
-    comm -23 - <(grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u)
+    comm -23 - $documented_uuids
diff --git a/scripts/format-uuid.sh b/scripts/format-uuid.sh
index fa07eb9..6758088 100755
--- a/scripts/format-uuid.sh
+++ b/scripts/format-uuid.sh
@@ -1,6 +1,19 @@
 #!/bin/sh -eu
 #
 # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
+# SPDX-FileCopyrightText: 2022 Unikie
 # SPDX-License-Identifier: EUPL-1.2+
 
-printf "%s\n" "${1:0:8}-${1:8:4}-${1:12:4}-${1:16:4}-${1:20}"
+substr () {
+    str=$1
+    beg=$2
+    end=$3
+    echo $str | cut -c $beg-$end
+}
+
+u1=$(substr $1 1 8)
+u2=$(substr $1 9 12)
+u3=$(substr $1 13 16)
+u4=$(substr $1 17 20)
+u5=$(substr $1 21 32)
+printf "%s\n" "$u1-$u2-$u3-$u4-$u5"
diff --git a/scripts/make-gpt.sh b/scripts/make-gpt.sh
index 56076d3..351aa69 100755
--- a/scripts/make-gpt.sh
+++ b/scripts/make-gpt.sh
@@ -1,6 +1,7 @@
 #!/bin/sh -eu
 #
 # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
+# SPDX-FileCopyrightText: 2022 Unikie
 # SPDX-License-Identifier: EUPL-1.2+
 #
 # usage: make-gpt.sh GPT_PATH PATH:PARTTYPE[:PARTUUID]...
@@ -38,7 +39,7 @@ scriptsDir="$(dirname "$0")"
 out="$1"
 shift
 
-nl=$'\n'
+nl='\n'
 table="label: gpt"
 
 # Keep 1MiB free at the start, and 1MiB free at the end.
@@ -51,9 +52,7 @@ done
 
 rm -f "$out"
 truncate -s "$gptBytes" "$out"
-sfdisk "$out" <<EOF
-$table
-EOF
+printf "$table" | sfdisk "$out"
 
 n=0
 for partition; do
-- 
2.25.1




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] Remove bashisms from spectrum shell scripts
  2022-11-09  6:22 [PATCH v2] Remove bashisms from spectrum shell scripts Henri Rosten
@ 2022-11-09 13:03 ` Alyssa Ross
  2022-11-09 13:30   ` Henri Rosten
  0 siblings, 1 reply; 3+ messages in thread
From: Alyssa Ross @ 2022-11-09 13:03 UTC (permalink / raw)
  To: Henri Rosten; +Cc: devel

[-- Attachment #1: Type: text/plain, Size: 3341 bytes --]

On Wed, Nov 09, 2022 at 08:22:51AM +0200, Henri Rosten wrote:
> This commit removes bashisms from spectrum shell scripts. This change is
> needed to be able to use the scripts from POSIX-compliant shells which
> are not bash compatible - such as dash.
>
> Signed-off-by: Henri Rosten <henri.rosten@unikie.com>

Thanks for v2!  I think we're almost there.

> ---
>  Documentation/scripts/undocumented-uuids.sh |  7 ++++++-
>  scripts/format-uuid.sh                      | 15 ++++++++++++++-
>  scripts/make-gpt.sh                         |  7 +++----
>  3 files changed, 23 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/scripts/undocumented-uuids.sh b/Documentation/scripts/undocumented-uuids.sh
> index 34c2d22..fa21366 100755
> --- a/Documentation/scripts/undocumented-uuids.sh
> +++ b/Documentation/scripts/undocumented-uuids.sh
> @@ -1,14 +1,19 @@
>  #!/bin/sh -eu
>  # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
> +# SPDX-FileCopyrightText: 2022 Unikie
>  # SPDX-License-Identifier: EUPL-1.2+
>
> +trap 'rm -f -- "$documented_uuids"' EXIT
> +

I think this should go immediately after the directory is created,
rather than before.

>  cd "$(dirname "$0")/../.."
>
>  PATTERN='\b[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}\b'
>  UUID_REFERENCE_PATH=Documentation/uuid-reference.adoc
>
> +documented_uuids=$(mktemp)
> +grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u >$documented_uuids
>  git ls-files -coz --exclude-standard |
>      grep -Fxvz "$UUID_REFERENCE_PATH" |
>      xargs -0 git grep -Ehio --no-index --no-line-number "$PATTERN" -- |
>      sort -u |
> -    comm -23 - <(grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u)
> +    comm -23 - $documented_uuids

documented_uuids could contain spaces etc, so I'd like this to be quoted.

> diff --git a/scripts/format-uuid.sh b/scripts/format-uuid.sh
> index fa07eb9..6758088 100755
> --- a/scripts/format-uuid.sh
> +++ b/scripts/format-uuid.sh
> @@ -1,6 +1,19 @@
>  #!/bin/sh -eu
>  #
>  # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
> +# SPDX-FileCopyrightText: 2022 Unikie
>  # SPDX-License-Identifier: EUPL-1.2+
>
> -printf "%s\n" "${1:0:8}-${1:8:4}-${1:12:4}-${1:16:4}-${1:20}"
> +substr () {
> +    str=$1
> +    beg=$2
> +    end=$3
> +    echo $str | cut -c $beg-$end
> +}
> +
> +u1=$(substr $1 1 8)
> +u2=$(substr $1 9 12)
> +u3=$(substr $1 13 16)
> +u4=$(substr $1 17 20)
> +u5=$(substr $1 21 32)
> +printf "%s\n" "$u1-$u2-$u3-$u4-$u5"

This one looks good now, thanks.

> diff --git a/scripts/make-gpt.sh b/scripts/make-gpt.sh
> index 56076d3..351aa69 100755
> --- a/scripts/make-gpt.sh
> +++ b/scripts/make-gpt.sh
> @@ -1,6 +1,7 @@
>  #!/bin/sh -eu
>  #
>  # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
> +# SPDX-FileCopyrightText: 2022 Unikie
>  # SPDX-License-Identifier: EUPL-1.2+
>  #
>  # usage: make-gpt.sh GPT_PATH PATH:PARTTYPE[:PARTUUID]...
> @@ -38,7 +39,7 @@ scriptsDir="$(dirname "$0")"
>  out="$1"
>  shift
>
> -nl=$'\n'
> +nl='\n'
>  table="label: gpt"
>
>  # Keep 1MiB free at the start, and 1MiB free at the end.
> @@ -51,9 +52,7 @@ done
>
>  rm -f "$out"
>  truncate -s "$gptBytes" "$out"
> -sfdisk "$out" <<EOF
> -$table
> -EOF
> +printf "$table" | sfdisk "$out"

I put a suggestion for this one in the other email I just sent. :)

>
>  n=0
>  for partition; do

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] Remove bashisms from spectrum shell scripts
  2022-11-09 13:03 ` Alyssa Ross
@ 2022-11-09 13:30   ` Henri Rosten
  0 siblings, 0 replies; 3+ messages in thread
From: Henri Rosten @ 2022-11-09 13:30 UTC (permalink / raw)
  To: Alyssa Ross; +Cc: devel

On Wed, Nov 09, 2022 at 01:03:31PM +0000, Alyssa Ross wrote:
> On Wed, Nov 09, 2022 at 08:22:51AM +0200, Henri Rosten wrote:
> > This commit removes bashisms from spectrum shell scripts. This change is
> > needed to be able to use the scripts from POSIX-compliant shells which
> > are not bash compatible - such as dash.
> >
> > Signed-off-by: Henri Rosten <henri.rosten@unikie.com>
> 
> Thanks for v2!  I think we're almost there.
> 
> > ---
> >  Documentation/scripts/undocumented-uuids.sh |  7 ++++++-
> >  scripts/format-uuid.sh                      | 15 ++++++++++++++-
> >  scripts/make-gpt.sh                         |  7 +++----
> >  3 files changed, 23 insertions(+), 6 deletions(-)
> >
> > diff --git a/Documentation/scripts/undocumented-uuids.sh b/Documentation/scripts/undocumented-uuids.sh
> > index 34c2d22..fa21366 100755
> > --- a/Documentation/scripts/undocumented-uuids.sh
> > +++ b/Documentation/scripts/undocumented-uuids.sh
> > @@ -1,14 +1,19 @@
> >  #!/bin/sh -eu
> >  # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
> > +# SPDX-FileCopyrightText: 2022 Unikie
> >  # SPDX-License-Identifier: EUPL-1.2+
> >
> > +trap 'rm -f -- "$documented_uuids"' EXIT
> > +
> 
> I think this should go immediately after the directory is created,
> rather than before.
> 

Fixed in v3.

> >  cd "$(dirname "$0")/../.."
> >
> >  PATTERN='\b[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}\b'
> >  UUID_REFERENCE_PATH=Documentation/uuid-reference.adoc
> >
> > +documented_uuids=$(mktemp)
> > +grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u >$documented_uuids
> >  git ls-files -coz --exclude-standard |
> >      grep -Fxvz "$UUID_REFERENCE_PATH" |
> >      xargs -0 git grep -Ehio --no-index --no-line-number "$PATTERN" -- |
> >      sort -u |
> > -    comm -23 - <(grep -Eio "$PATTERN" "$UUID_REFERENCE_PATH" | sort -u)
> > +    comm -23 - $documented_uuids
> 
> documented_uuids could contain spaces etc, so I'd like this to be quoted.
>

Thanks, this is now fixed in v3. Also, I notice the 
Documentation/uuid-reference.adoc was moved to 
Documentation/appendices/uuid-reference.adoc. Fixed the 
uuid-reference.adoc path used in this script in v3 too.

> > diff --git a/scripts/format-uuid.sh b/scripts/format-uuid.sh
> > index fa07eb9..6758088 100755
> > --- a/scripts/format-uuid.sh
> > +++ b/scripts/format-uuid.sh
> > @@ -1,6 +1,19 @@
> >  #!/bin/sh -eu
> >  #
> >  # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
> > +# SPDX-FileCopyrightText: 2022 Unikie
> >  # SPDX-License-Identifier: EUPL-1.2+
> >
> > -printf "%s\n" "${1:0:8}-${1:8:4}-${1:12:4}-${1:16:4}-${1:20}"
> > +substr () {
> > +    str=$1
> > +    beg=$2
> > +    end=$3
> > +    echo $str | cut -c $beg-$end
> > +}
> > +
> > +u1=$(substr $1 1 8)
> > +u2=$(substr $1 9 12)
> > +u3=$(substr $1 13 16)
> > +u4=$(substr $1 17 20)
> > +u5=$(substr $1 21 32)
> > +printf "%s\n" "$u1-$u2-$u3-$u4-$u5"
> 
> This one looks good now, thanks.
> 
> > diff --git a/scripts/make-gpt.sh b/scripts/make-gpt.sh
> > index 56076d3..351aa69 100755
> > --- a/scripts/make-gpt.sh
> > +++ b/scripts/make-gpt.sh
> > @@ -1,6 +1,7 @@
> >  #!/bin/sh -eu
> >  #
> >  # SPDX-FileCopyrightText: 2021-2022 Alyssa Ross <hi@alyssa.is>
> > +# SPDX-FileCopyrightText: 2022 Unikie
> >  # SPDX-License-Identifier: EUPL-1.2+
> >  #
> >  # usage: make-gpt.sh GPT_PATH PATH:PARTTYPE[:PARTUUID]...
> > @@ -38,7 +39,7 @@ scriptsDir="$(dirname "$0")"
> >  out="$1"
> >  shift
> >
> > -nl=$'\n'
> > +nl='\n'
> >  table="label: gpt"
> >
> >  # Keep 1MiB free at the start, and 1MiB free at the end.
> > @@ -51,9 +52,7 @@ done
> >
> >  rm -f "$out"
> >  truncate -s "$gptBytes" "$out"
> > -sfdisk "$out" <<EOF
> > -$table
> > -EOF
> > +printf "$table" | sfdisk "$out"
> 
> I put a suggestion for this one in the other email I just sent. :)
>

Thanks, this is also fixed in v3.

> >
> >  n=0
> >  for partition; do





^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-11-09 13:30 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-09  6:22 [PATCH v2] Remove bashisms from spectrum shell scripts Henri Rosten
2022-11-09 13:03 ` Alyssa Ross
2022-11-09 13:30   ` Henri Rosten

Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).