Skip to contentSkip to conversation

libxfs-apply: support filterdiff >= 0.4.2 only

PATCH In review Dave Chinner 3 participants 3 messages Jul 13, 2021 – Jan 11, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 libxfs-apply: support filterdiff >= 0.4.2 only

From: Dave Chinner <[email protected]>

We currently require filterdiff v0.3.4 as a minimum for handling git based patches. This was the first version to handle git diff metadata well enough to do patch reformatting. It was, however, very buggy and required several workarounds to get it to do what we needed.

However, these bugs have been fixed and on a machine with v0.4.2, the workarounds result in libxfs-apply breaking and creating corrupt patches. Rather than try to carry around workarounds for a broken filterdiff version and one that just works, just increase the minimum required version to 0.4.2 and remove all the workarounds for the bugs in 0.3.4.

---
 tools/libxfs-apply | 42 +++++++++++++++++-------------------------
 1 file changed, 17 insertions(+), 25 deletions(-)
tools/libxfs-apply +17 -25
index 9271db380198..097a695f942b 100755
@@ -30,21 +30,22 @@ fail()
 	exit
 }
 
-# filterdiff 0.3.4 is the first version that handles git diff metadata (almost)
-# correctly. It just doesn't work properly in prior versions, so those versions
-# can't be used to extract the commit message prior to the diff. Hence just
-# abort and tell the user to upgrade if an old version is detected. We need to
+# filterdiff didn't start handling git diff metadata correctly until some time
+# after 0.3.4. The handling in 0.3.4 was buggy and broken, requiring working
+# around that bugs to use it. Now that 0.4.2 has fixed all those bugs, the
+# work-arounds for 0.3.4 do not work. Hence set 0.4.2 as the minimum required
+# version and tell the user to upgrade if an old version is detected. We need to
 # check against x.y.z version numbers here.
 _version=`filterdiff --version | cut -d " " -f 5`
 _major=`echo $_version | cut -d "." -f 1`
 _minor=`echo $_version | cut -d "." -f 2`
 _patch=`echo $_version | cut -d "." -f 3`
 if [ $_major -eq 0 ]; then
-	if [ $_minor -lt 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -lt 4 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
 	fi
-	if [ $_minor -eq 3 -a $_patch -le 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -eq 4 -a $_patch -lt 2 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
 	fi
 fi
 
@@ -158,8 +159,7 @@ filter_kernel_patch()
 			--addoldprefix=a/fs/xfs/ \
 			--addnewprefix=b/fs/xfs/ \
 			$_patch | \
-		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,'
 
 
 	rm -f $_libxfs_files
@@ -187,8 +187,7 @@ filter_xfsprogs_patch()
 			--addoldprefix=a/ \
 			--addnewprefix=b/ \
 			$_patch | \
-		sed -e 's, [ab]\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/\(\/dev\/null\), \1,'
 
 	rm -f $_libxfs_files
 }
@@ -209,30 +208,23 @@ fixup_header_format()
 	local _diff=`mktemp`
 	local _new_hdr=$_hdr.new
 
-	# there's a bug in filterdiff that leaves a line at the end of the
-	# header in the filtered git show output like:
-	#
-	# difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
-	# split the header on that (convenient!)
-	sed -e /^difflib/q $_patch > $_hdr
+	# Split the header on the first ^diff --git line (convenient!)
+	sed -e /^diff/q $_patch > $_hdr
 	cat $_patch | awk '
-		BEGIN { difflib_seen = 0; index_seen = 0 }
-		/^difflib/ { difflib_seen++; next }
+		BEGIN { diff_seen = 0; index_seen = 0 }
+		/^diff/ { diff_seen++; next }
 		/^index/ { if (++index_seen == 1) { next } }
-		// { if (difflib_seen) { print $0 } }' > $_diff
+		// { if (diff_seen) { print $0 } }' > $_diff
 
 	# the header now has the format:
 	# commit 0d5a75e9e23ee39cd0d8a167393dcedb4f0f47b2
 	# Author: Eric Sandeen <[email protected]>
 	# Date:   Wed Jun 1 17:38:15 2016 +1000
-	# 
+	#
 	#     xfs: make several functions static
 	#....
 	#     Signed-off-by: Dave Chinner <[email protected]>
 	#
-	#difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
 	# We want to format it like a normal patch with a line to say what repo
 	# and commit it was sourced from:
 	#
Signature · 1 line
2.31.1
#1 lore raw
Quoted 8 lines · Dave Chinner

From: Dave Chinner <[email protected]>

We currently require filterdiff v0.3.4 as a minimum for handling git based patches. This was the first version to handle git diff metadata well enough to do patch reformatting. It was, however, very buggy and required several workarounds to get it to do what we needed.

Quoted 8 lines

However, these bugs have been fixed and on a machine with v0.4.2, the workarounds result in libxfs-apply breaking and creating corrupt patches. Rather than try to carry around workarounds for a broken filterdiff version and one that just works, just increase the minimum required version to 0.4.2 and remove all the workarounds for the bugs in 0.3.4.

I had missed this, sorry. I'm using it now, seems to work fine.

Darrick is still on the older version, so we probably need to come to agreement on requiring something newer. Thanks for working through this!

-Eric

Quoted 96 lines
---
  tools/libxfs-apply | 42 +++++++++++++++++-------------------------
  1 file changed, 17 insertions(+), 25 deletions(-)
tools/libxfs-apply +17 -25
index 9271db380198..097a695f942b 100755
@@ -30,21 +30,22 @@ fail()
  	exit
  }
 
-# filterdiff 0.3.4 is the first version that handles git diff metadata (almost)
-# correctly. It just doesn't work properly in prior versions, so those versions
-# can't be used to extract the commit message prior to the diff. Hence just
-# abort and tell the user to upgrade if an old version is detected. We need to
+# filterdiff didn't start handling git diff metadata correctly until some time
+# after 0.3.4. The handling in 0.3.4 was buggy and broken, requiring working
+# around that bugs to use it. Now that 0.4.2 has fixed all those bugs, the
+# work-arounds for 0.3.4 do not work. Hence set 0.4.2 as the minimum required
+# version and tell the user to upgrade if an old version is detected. We need to
  # check against x.y.z version numbers here.
  _version=`filterdiff --version | cut -d " " -f 5`
  _major=`echo $_version | cut -d "." -f 1`
  _minor=`echo $_version | cut -d "." -f 2`
  _patch=`echo $_version | cut -d "." -f 3`
  if [ $_major -eq 0 ]; then
-	if [ $_minor -lt 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -lt 4 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
  	fi
-	if [ $_minor -eq 3 -a $_patch -le 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -eq 4 -a $_patch -lt 2 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
  	fi
  fi
 
@@ -158,8 +159,7 @@ filter_kernel_patch()
  			--addoldprefix=a/fs/xfs/ \
  			--addnewprefix=b/fs/xfs/ \
  			$_patch | \
-		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,'
 
 
  	rm -f $_libxfs_files
@@ -187,8 +187,7 @@ filter_xfsprogs_patch()
  			--addoldprefix=a/ \
  			--addnewprefix=b/ \
  			$_patch | \
-		sed -e 's, [ab]\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/\(\/dev\/null\), \1,'
 
  	rm -f $_libxfs_files
  }
@@ -209,30 +208,23 @@ fixup_header_format()
  	local _diff=`mktemp`
  	local _new_hdr=$_hdr.new
 
-	# there's a bug in filterdiff that leaves a line at the end of the
-	# header in the filtered git show output like:
-	#
-	# difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
-	# split the header on that (convenient!)
-	sed -e /^difflib/q $_patch > $_hdr
+	# Split the header on the first ^diff --git line (convenient!)
+	sed -e /^diff/q $_patch > $_hdr
  	cat $_patch | awk '
-		BEGIN { difflib_seen = 0; index_seen = 0 }
-		/^difflib/ { difflib_seen++; next }
+		BEGIN { diff_seen = 0; index_seen = 0 }
+		/^diff/ { diff_seen++; next }
  		/^index/ { if (++index_seen == 1) { next } }
-		// { if (difflib_seen) { print $0 } }' > $_diff
+		// { if (diff_seen) { print $0 } }' > $_diff
 
  	# the header now has the format:
  	# commit 0d5a75e9e23ee39cd0d8a167393dcedb4f0f47b2
  	# Author: Eric Sandeen <[email protected]>
  	# Date:   Wed Jun 1 17:38:15 2016 +1000
-	#
+	#
  	#     xfs: make several functions static
  	#....
  	#     Signed-off-by: Dave Chinner <[email protected]>
  	#
-	#difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
  	# We want to format it like a normal patch with a line to say what repo
  	# and commit it was sourced from:
  	#
#2 lore raw
Quoted 16 lines · Eric Sandeen
Quoted 15 lines · Dave Chinner

From: Dave Chinner <[email protected]>

We currently require filterdiff v0.3.4 as a minimum for handling git based patches. This was the first version to handle git diff metadata well enough to do patch reformatting. It was, however, very buggy and required several workarounds to get it to do what we needed.

However, these bugs have been fixed and on a machine with v0.4.2, the workarounds result in libxfs-apply breaking and creating corrupt patches. Rather than try to carry around workarounds for a broken filterdiff version and one that just works, just increase the minimum required version to 0.4.2 and remove all the workarounds for the bugs in 0.3.4.

Quoted 7 lines
Quoted 1 line

I had missed this, sorry. I'm using it now, seems to work fine.

Darrick is still on the older version, so we probably need to come to agreement on requiring something newer. Thanks for working through this!

/me built 0.4.2 for his local systems and drops his objections. The plan is to update to Ubuntu 2022 in May, but we'll see how much of Ubuntu gets borg'd^Wsnapify'd in that timeframe.

--D

Quoted 91 lines

-Eric

Quoted 89 lines
---
  tools/libxfs-apply | 42 +++++++++++++++++-------------------------
  1 file changed, 17 insertions(+), 25 deletions(-)
tools/libxfs-apply +17 -25
index 9271db380198..097a695f942b 100755
@@ -30,21 +30,22 @@ fail()
  	exit
  }
-# filterdiff 0.3.4 is the first version that handles git diff metadata (almost)
-# correctly. It just doesn't work properly in prior versions, so those versions
-# can't be used to extract the commit message prior to the diff. Hence just
-# abort and tell the user to upgrade if an old version is detected. We need to
+# filterdiff didn't start handling git diff metadata correctly until some time
+# after 0.3.4. The handling in 0.3.4 was buggy and broken, requiring working
+# around that bugs to use it. Now that 0.4.2 has fixed all those bugs, the
+# work-arounds for 0.3.4 do not work. Hence set 0.4.2 as the minimum required
+# version and tell the user to upgrade if an old version is detected. We need to
  # check against x.y.z version numbers here.
  _version=`filterdiff --version | cut -d " " -f 5`
  _major=`echo $_version | cut -d "." -f 1`
  _minor=`echo $_version | cut -d "." -f 2`
  _patch=`echo $_version | cut -d "." -f 3`
  if [ $_major -eq 0 ]; then
-	if [ $_minor -lt 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -lt 4 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
  	fi
-	if [ $_minor -eq 3 -a $_patch -le 3 ]; then
-		fail "filterdiff $_version found. 0.3.4 or greater is required."
+	if [ $_minor -eq 4 -a $_patch -lt 2 ]; then
+		fail "filterdiff $_version found. 0.4.2 or greater is required."
  	fi
  fi
@@ -158,8 +159,7 @@ filter_kernel_patch()
  			--addoldprefix=a/fs/xfs/ \
  			--addnewprefix=b/fs/xfs/ \
  			$_patch | \
-		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/fs\/xfs\/\(\/dev\/null\), \1,'
  	rm -f $_libxfs_files
@@ -187,8 +187,7 @@ filter_xfsprogs_patch()
  			--addoldprefix=a/ \
  			--addnewprefix=b/ \
  			$_patch | \
-		sed -e 's, [ab]\/\(\/dev\/null\), \1,' \
-		    -e '/^diff --git/d'
+		sed -e 's, [ab]\/\(\/dev\/null\), \1,'
  	rm -f $_libxfs_files
  }
@@ -209,30 +208,23 @@ fixup_header_format()
  	local _diff=`mktemp`
  	local _new_hdr=$_hdr.new
-	# there's a bug in filterdiff that leaves a line at the end of the
-	# header in the filtered git show output like:
-	#
-	# difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
-	# split the header on that (convenient!)
-	sed -e /^difflib/q $_patch > $_hdr
+	# Split the header on the first ^diff --git line (convenient!)
+	sed -e /^diff/q $_patch > $_hdr
  	cat $_patch | awk '
-		BEGIN { difflib_seen = 0; index_seen = 0 }
-		/^difflib/ { difflib_seen++; next }
+		BEGIN { diff_seen = 0; index_seen = 0 }
+		/^diff/ { diff_seen++; next }
  		/^index/ { if (++index_seen == 1) { next } }
-		// { if (difflib_seen) { print $0 } }' > $_diff
+		// { if (diff_seen) { print $0 } }' > $_diff
  	# the header now has the format:
  	# commit 0d5a75e9e23ee39cd0d8a167393dcedb4f0f47b2
  	# Author: Eric Sandeen <[email protected]>
  	# Date:   Wed Jun 1 17:38:15 2016 +1000
-	#
+	#
  	#     xfs: make several functions static
  	#....
  	#     Signed-off-by: Dave Chinner <[email protected]>
  	#
-	#difflibxfs/xfs_alloc.c b/fs/xfs/libxfs/xfs_alloc.c
-	#
  	# We want to format it like a normal patch with a line to say what repo
  	# and commit it was sourced from:
  	#