devtools: avoid config backup during test build setup

Message ID 20191216162242.1898285-1-thomas@monjalon.net (mailing list archive)
State Superseded, archived
Headers
Series devtools: avoid config backup during test build setup |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon Dec. 16, 2019, 4:22 p.m. UTC
  The config options are updated with sed and the short inline option.
In FreeBSD, the suffix argument of the inline option is mandatory.
In order to avoid creating a backup file when using sed inline,
the argument is set as an empty suffix.

The short option '-i' does not expect '=' before the suffix argument,
so it understands '=' as the file suffix.
As a consequence, a backup file named '.config=' was created
in the build directory.

Removing the '=' sign while keeping an empty suffix
avoids creating a backup file.

Fixes: 4a4a20c4775b ("devtools: support FreeBSD")
Cc: olivier.matz@6wind.com
Cc: stable@dpdk.org

Reported-by: Ali Alnubani <alialnu@mellanox.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---

This patch does not work on FreeBSD.
Does it mean the equal sign is required on FreeBSD?
This is not what I see on the documentation:
https://www.freebsd.org/cgi/man.cgi?query=sed&sektion=&n=1

---
 devtools/test-build.sh | 76 +++++++++++++++++++++---------------------
 1 file changed, 38 insertions(+), 38 deletions(-)
  

Comments

Bruce Richardson Dec. 16, 2019, 4:40 p.m. UTC | #1
On Mon, Dec 16, 2019 at 05:22:42PM +0100, Thomas Monjalon wrote:
> The config options are updated with sed and the short inline option.
> In FreeBSD, the suffix argument of the inline option is mandatory.
> In order to avoid creating a backup file when using sed inline,
> the argument is set as an empty suffix.
> 
> The short option '-i' does not expect '=' before the suffix argument,
> so it understands '=' as the file suffix.
> As a consequence, a backup file named '.config=' was created
> in the build directory.
> 
> Removing the '=' sign while keeping an empty suffix
> avoids creating a backup file.
> 
> Fixes: 4a4a20c4775b ("devtools: support FreeBSD")
> Cc: olivier.matz@6wind.com
> Cc: stable@dpdk.org
> 
> Reported-by: Ali Alnubani <alialnu@mellanox.com>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> 
> This patch does not work on FreeBSD.
> Does it mean the equal sign is required on FreeBSD?
> This is not what I see on the documentation:
> https://www.freebsd.org/cgi/man.cgi?query=sed&sektion=&n=1
> 
> ---

It appears it is needed, which is why the "=" was added in the first place.
See commit: 4a4a20c4775b ("devtools: support FreeBSD"), by Olivier

Is having the backup file a big issue?

Regards,
/Bruce
  
Thomas Monjalon Dec. 16, 2019, 4:47 p.m. UTC | #2
16/12/2019 17:40, Bruce Richardson:
> On Mon, Dec 16, 2019 at 05:22:42PM +0100, Thomas Monjalon wrote:
> > The config options are updated with sed and the short inline option.
> > In FreeBSD, the suffix argument of the inline option is mandatory.
> > In order to avoid creating a backup file when using sed inline,
> > the argument is set as an empty suffix.
> > 
> > The short option '-i' does not expect '=' before the suffix argument,
> > so it understands '=' as the file suffix.
> > As a consequence, a backup file named '.config=' was created
> > in the build directory.
> > 
> > Removing the '=' sign while keeping an empty suffix
> > avoids creating a backup file.
> > 
> > Fixes: 4a4a20c4775b ("devtools: support FreeBSD")
> > Cc: olivier.matz@6wind.com
> > Cc: stable@dpdk.org
> > 
> > Reported-by: Ali Alnubani <alialnu@mellanox.com>
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> > 
> > This patch does not work on FreeBSD.
> > Does it mean the equal sign is required on FreeBSD?
> > This is not what I see on the documentation:
> > https://www.freebsd.org/cgi/man.cgi?query=sed&sektion=&n=1
> > 
> > ---
> 
> It appears it is needed, which is why the "=" was added in the first place.
> See commit: 4a4a20c4775b ("devtools: support FreeBSD"), by Olivier
> 
> Is having the backup file a big issue?

No it's not a big issue.
But I really would like to know how to have a common behaviour on BSD an Linux
for a thing as simple as "sed -i" !
And why the mandatory "=" is not documented on FreeBSD?

It cannot be so much broken. We probably miss something...
  
Bruce Richardson Dec. 16, 2019, 4:59 p.m. UTC | #3
On Mon, Dec 16, 2019 at 05:47:03PM +0100, Thomas Monjalon wrote:
> 16/12/2019 17:40, Bruce Richardson:
> > On Mon, Dec 16, 2019 at 05:22:42PM +0100, Thomas Monjalon wrote:
> > > The config options are updated with sed and the short inline option.
> > > In FreeBSD, the suffix argument of the inline option is mandatory.
> > > In order to avoid creating a backup file when using sed inline,
> > > the argument is set as an empty suffix.
> > > 
> > > The short option '-i' does not expect '=' before the suffix argument,
> > > so it understands '=' as the file suffix.
> > > As a consequence, a backup file named '.config=' was created
> > > in the build directory.
> > > 
> > > Removing the '=' sign while keeping an empty suffix
> > > avoids creating a backup file.
> > > 
> > > Fixes: 4a4a20c4775b ("devtools: support FreeBSD")
> > > Cc: olivier.matz@6wind.com
> > > Cc: stable@dpdk.org
> > > 
> > > Reported-by: Ali Alnubani <alialnu@mellanox.com>
> > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > > ---
> > > 
> > > This patch does not work on FreeBSD.
> > > Does it mean the equal sign is required on FreeBSD?
> > > This is not what I see on the documentation:
> > > https://www.freebsd.org/cgi/man.cgi?query=sed&sektion=&n=1
> > > 
> > > ---
> > 
> > It appears it is needed, which is why the "=" was added in the first place.
> > See commit: 4a4a20c4775b ("devtools: support FreeBSD"), by Olivier
> > 
> > Is having the backup file a big issue?
> 
> No it's not a big issue.
> But I really would like to know how to have a common behaviour on BSD an Linux
> for a thing as simple as "sed -i" !
> And why the mandatory "=" is not documented on FreeBSD?
> 
> It cannot be so much broken. We probably miss something...
> 
I think FreeBSD just requires a space between the -i and the ''. Testing
that seems to work for me on BSD. I assume it also should work on Linux.

/Bruce
  
Thomas Monjalon Dec. 16, 2019, 5:45 p.m. UTC | #4
16/12/2019 17:59, Bruce Richardson:
> On Mon, Dec 16, 2019 at 05:47:03PM +0100, Thomas Monjalon wrote:
> > 16/12/2019 17:40, Bruce Richardson:
> > > On Mon, Dec 16, 2019 at 05:22:42PM +0100, Thomas Monjalon wrote:
> > > > The config options are updated with sed and the short inline option.
> > > > In FreeBSD, the suffix argument of the inline option is mandatory.
> > > > In order to avoid creating a backup file when using sed inline,
> > > > the argument is set as an empty suffix.
> > > > 
> > > > The short option '-i' does not expect '=' before the suffix argument,
> > > > so it understands '=' as the file suffix.
> > > > As a consequence, a backup file named '.config=' was created
> > > > in the build directory.
> > > > 
> > > > Removing the '=' sign while keeping an empty suffix
> > > > avoids creating a backup file.
> > > > 
> > > > Fixes: 4a4a20c4775b ("devtools: support FreeBSD")
> > > > Cc: olivier.matz@6wind.com
> > > > Cc: stable@dpdk.org
> > > > 
> > > > Reported-by: Ali Alnubani <alialnu@mellanox.com>
> > > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > > > ---
> > > > 
> > > > This patch does not work on FreeBSD.
> > > > Does it mean the equal sign is required on FreeBSD?
> > > > This is not what I see on the documentation:
> > > > https://www.freebsd.org/cgi/man.cgi?query=sed&sektion=&n=1
> > > > 
> > > > ---
> > > 
> > > It appears it is needed, which is why the "=" was added in the first place.
> > > See commit: 4a4a20c4775b ("devtools: support FreeBSD"), by Olivier
> > > 
> > > Is having the backup file a big issue?
> > 
> > No it's not a big issue.
> > But I really would like to know how to have a common behaviour on BSD an Linux
> > for a thing as simple as "sed -i" !
> > And why the mandatory "=" is not documented on FreeBSD?
> > 
> > It cannot be so much broken. We probably miss something...
> > 
> I think FreeBSD just requires a space between the -i and the ''. Testing
> that seems to work for me on BSD. I assume it also should work on Linux.

Thanks Bruce, I will send a v2.
  

Patch

diff --git a/devtools/test-build.sh b/devtools/test-build.sh
index 52305fbb8c..8b6e484a8e 100755
--- a/devtools/test-build.sh
+++ b/devtools/test-build.sh
@@ -141,82 +141,82 @@  config () # <directory> <target> <options>
 		echo 'Customize configuration'
 		# Built-in options (lowercase)
 		! echo $3 | grep -q '+default' || \
-		sed -ri="" 's,(RTE_MACHINE=")native,\1default,' $1/.config
+		sed -ri'' 's,(RTE_MACHINE=")native,\1default,' $1/.config
 		echo $3 | grep -q '+next' || \
-		sed -ri=""           's,(NEXT_ABI=)y,\1n,' $1/.config
+		sed -ri''           's,(NEXT_ABI=)y,\1n,' $1/.config
 		! echo $3 | grep -q '+shared' || \
-		sed -ri=""         's,(SHARED_LIB=)n,\1y,' $1/.config
+		sed -ri''         's,(SHARED_LIB=)n,\1y,' $1/.config
 		! echo $3 | grep -q '+debug' || ( \
-		sed -ri=""  's,(RTE_LOG_DP_LEVEL=).*,\1RTE_LOG_DEBUG,' $1/.config
-		sed -ri=""           's,(_DEBUG.*=)n,\1y,' $1/.config
-		sed -ri=""  's,(_STAT)([S_].*=|=)n,\1\2y,' $1/.config
-		sed -ri="" 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config )
+		sed -ri'' 's,(RTE_LOG_DP_LEVEL=).*,\1RTE_LOG_DEBUG,' $1/.config
+		sed -ri''           's,(_DEBUG.*=)n,\1y,' $1/.config
+		sed -ri''  's,(_STAT)([S_].*=|=)n,\1\2y,' $1/.config
+		sed -ri'' 's,(TEST_PMD_RECORD_.*=)n,\1y,' $1/.config )
 
 		# Automatic configuration
 		test "$DPDK_DEP_NUMA" != n || \
-		sed -ri=""             's,(NUMA.*=)y,\1n,' $1/.config
-		sed -ri=""    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
-		sed -ri=""             's,(BYPASS=)n,\1y,' $1/.config
+		sed -ri''             's,(NUMA.*=)y,\1n,' $1/.config
+		sed -ri''    's,(LIBRTE_IEEE1588=)n,\1y,' $1/.config
+		sed -ri''             's,(BYPASS=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ARCHIVE" != y || \
-		sed -ri=""       's,(RESOURCE_TAR=)n,\1y,' $1/.config
+		sed -ri''       's,(RESOURCE_TAR=)n,\1y,' $1/.config
 		test "$DPDK_DEP_BPF" != y || \
-		sed -ri=""         's,(PMD_AF_XDP=)n,\1y,' $1/.config
+		sed -ri''         's,(PMD_AF_XDP=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ISAL" != y || \
-		sed -ri=""           's,(PMD_ISAL=)n,\1y,' $1/.config
+		sed -ri''           's,(PMD_ISAL=)n,\1y,' $1/.config
 		test "$DPDK_DEP_MLX" != y || \
-		sed -ri=""           's,(MLX._PMD=)n,\1y,' $1/.config
+		sed -ri''           's,(MLX._PMD=)n,\1y,' $1/.config
 		test "$DPDK_DEP_NFB" != y || \
-		sed -ri=""            's,(NFB_PMD=)n,\1y,' $1/.config
+		sed -ri''            's,(NFB_PMD=)n,\1y,' $1/.config
 		test "$DPDK_DEP_SZE" != y || \
-		sed -ri=""       's,(PMD_SZEDATA2=)n,\1y,' $1/.config
+		sed -ri''       's,(PMD_SZEDATA2=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ZLIB" != y || \
-		sed -ri=""          's,(BNX2X_PMD=)n,\1y,' $1/.config
+		sed -ri''          's,(BNX2X_PMD=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ZLIB" != y || \
-		sed -ri=""           's,(PMD_ZLIB=)n,\1y,' $1/.config
+		sed -ri''           's,(PMD_ZLIB=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ZLIB" != y || \
-		sed -ri=""   's,(COMPRESSDEV_TEST=)n,\1y,' $1/.config
+		sed -ri''   's,(COMPRESSDEV_TEST=)n,\1y,' $1/.config
 		test "$DPDK_DEP_PCAP" != y || \
-		sed -ri=""               's,(PCAP=)n,\1y,' $1/.config
+		sed -ri''               's,(PCAP=)n,\1y,' $1/.config
 		test -z "$ARMV8_CRYPTO_LIB_PATH" || \
-		sed -ri=""   's,(PMD_ARMV8_CRYPTO=)n,\1y,' $1/.config
+		sed -ri''   's,(PMD_ARMV8_CRYPTO=)n,\1y,' $1/.config
 		test "$DPDK_DEP_IPSEC_MB" != y || \
-		sed -ri=""       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
+		sed -ri''       's,(PMD_AESNI_MB=)n,\1y,' $1/.config
 		test "$DPDK_DEP_IPSEC_MB" != y || \
-		sed -ri=""      's,(PMD_AESNI_GCM=)n,\1y,' $1/.config
+		sed -ri''      's,(PMD_AESNI_GCM=)n,\1y,' $1/.config
 		test -z "$LIBSSO_SNOW3G_PATH" || \
-		sed -ri=""         's,(PMD_SNOW3G=)n,\1y,' $1/.config
+		sed -ri''         's,(PMD_SNOW3G=)n,\1y,' $1/.config
 		test -z "$LIBSSO_KASUMI_PATH" || \
-		sed -ri=""         's,(PMD_KASUMI=)n,\1y,' $1/.config
+		sed -ri''         's,(PMD_KASUMI=)n,\1y,' $1/.config
 		test -z "$LIBSSO_ZUC_PATH" || \
-		sed -ri=""            's,(PMD_ZUC=)n,\1y,' $1/.config
+		sed -ri''            's,(PMD_ZUC=)n,\1y,' $1/.config
 		test "$DPDK_DEP_SSL" != y || \
-		sed -ri=""            's,(PMD_CCP=)n,\1y,' $1/.config
+		sed -ri''            's,(PMD_CCP=)n,\1y,' $1/.config
 		test "$DPDK_DEP_SSL" != y || \
-		sed -ri=""        's,(PMD_OPENSSL=)n,\1y,' $1/.config
+		sed -ri''        's,(PMD_OPENSSL=)n,\1y,' $1/.config
 		test "$DPDK_DEP_SSL" != y || \
-		sed -ri=""            's,(QAT_SYM=)n,\1y,' $1/.config
+		sed -ri''            's,(QAT_SYM=)n,\1y,' $1/.config
 		test -z "$FLEXRAN_SDK" || \
-		sed -ri=""     's,(BBDEV_TURBO_SW=)n,\1y,' $1/.config
-		sed -ri=""           's,(SCHED_.*=)n,\1y,' $1/.config
+		sed -ri''     's,(BBDEV_TURBO_SW=)n,\1y,' $1/.config
+		sed -ri''           's,(SCHED_.*=)n,\1y,' $1/.config
 		test -z "$LIBMUSDK_PATH" || \
-		sed -ri=""   's,(PMD_MVSAM_CRYPTO=)n,\1y,' $1/.config
+		sed -ri''   's,(PMD_MVSAM_CRYPTO=)n,\1y,' $1/.config
 		test -z "$LIBMUSDK_PATH" || \
-		sed -ri=""          's,(MVPP2_PMD=)n,\1y,' $1/.config
+		sed -ri''          's,(MVPP2_PMD=)n,\1y,' $1/.config
 		test -z "$LIBMUSDK_PATH" || \
-		sed -ri=""         's,(MVNETA_PMD=)n,\1y,' $1/.config
+		sed -ri''         's,(MVNETA_PMD=)n,\1y,' $1/.config
 		test "$DPDK_DEP_ELF" != y || \
-		sed -ri=""            's,(BPF_ELF=)n,\1y,' $1/.config
+		sed -ri''            's,(BPF_ELF=)n,\1y,' $1/.config
 		test "$DPDK_DEP_JSON" != y || \
-		sed -ri=""          's,(TELEMETRY=)n,\1y,' $1/.config
+		sed -ri''          's,(TELEMETRY=)n,\1y,' $1/.config
 		build_config_hook $1 $2 $3
 
 		# Explicit enabler/disabler (uppercase)
 		for option in $(echo $3 | sed 's,[~+], &,g') ; do
 			pattern=$(echo $option | cut -c2-)
 			if echo $option | grep -q '^~' ; then
-				sed -ri="" "s,($pattern=)y,\1n," $1/.config
+				sed -ri'' "s,($pattern=)y,\1n," $1/.config
 			elif echo $option | grep -q '^+' ; then
-				sed -ri="" "s,($pattern=)n,\1y," $1/.config
+				sed -ri'' "s,($pattern=)n,\1y," $1/.config
 			fi
 		done
 	fi