Skip to contentSkip to conversation

patch.py: use --absolute-git-dir instead of --show-toplevel to retrieve gitdir

PATCH New Julien Stephan 1 participant 2 messages Aug 24, 2023

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 patch.py: use --absolute-git-dir instead of --show-toplevel to retrieve gitdir

[YOCTO #14141]

Currently the gitdir is manually constructed using git rev-parse --show-toplevel and appending .git. This is most of the time correct but not always: .git can be a file with the following content:

gitdir: <some_folder>

This is the case for submodules, so when using devtool modify on a recipe using submodules *and* patching files inside one of the submodules, do_patch fails with the following error:

ERROR: Error executing a python function in exec_func_python() autogenerated:

The stack trace of python calls that resulted in this exception/failure was:
File: 'exec_func_python() autogenerated', lineno: 2, function: <module>

     0001:
 *** 0002:patch_do_patch(d)
     0003:

File: '<..>/poky/meta/classes-global/patch.bbclass', lineno: 157, function: patch_do_patch
0153: except Exception as exc:
0154: bb.utils.remove(process_tmpdir, True)
0155: bb.fatal("Importing patch '%s' with striplevel '%s'\n%s" % (parm['patchname'], parm['striplevel'], repr(exc).replace("\\n", "\n")))
0156: try:
*** 0157: resolver.Resolve()
0158: except bb.BBHandledException as e:
0159: bb.utils.remove(process_tmpdir, True)
0160: bb.fatal("Applying patch '%s' on target directory '%s'\n%s" % (parm['patchname'], patchdir, repr(e).replace("\\n", "\n")))
0161:
File: '<..>/poky/meta/lib/oe/patch.py', lineno: 769, function: Resolve

     0765:    def Resolve(self):
     0766:        olddir = os.path.abspath(os.curdir)
     0767:        os.chdir(self.patchset.dir)
     0768:        try:

*** 0769: self.patchset.Push()
0770: except Exception:
0771: import sys
0772: os.chdir(olddir)
0773: raise
File: '<..>/poky/meta/lib/oe/patch.py', lineno: 274, function: Push
0270: else:
0271: next = 0
0272:
0273: bb.note("applying patch %s" % self.patches[next])
*** 0274: ret = self._applypatch(self.patches[next], force)
0275:
0276: self._current = next
0277: return ret
0278:
File: '<..>/poky/meta/lib/oe/patch.py', lineno: 556, function: _applypatch
0552: if os.path.lexists(hooks_dir_backup):
0553: raise Exception("Git hooks backup directory already exists: %s" % hooks_dir_backup)
0554: if os.path.lexists(hooks_dir):
0555: shutil.move(hooks_dir, hooks_dir_backup)

 *** 0556:        os.mkdir(hooks_dir)
     0557:        commithook = os.path.join(hooks_dir, 'commit-msg')
     0558:        applyhook = os.path.join(hooks_dir, 'applypatch-msg')
     0559:        with open(commithook, 'w') as f:

0560: # NOTE: the formatting here is significant; if you change it you'll also need to
Exception: NotADirectoryError: [Errno 20] Not a directory: '<..>/build/tmp/work/core2-64-poky-linux/vulkan-samples/git/devtooltmp-n87_zx1i/workdir/git/third_party/spdlog/.git/hooks'

Using git rev-parse --absolute-git-dir instead of git rev-parse --show-toplevel ensure we get the correct gitdir

---
Changes from v1:
* create gitdir variable instead of modifying reporoot directly since reporoot is used in other places

 meta/lib/oe/patch.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
meta/lib/oe/patch.py +4 -1
index 5990896fdc5..ff9afc9df9f 100644
@@ -547,7 +547,10 @@ class GitApplyTree(PatchTree):
         reporoot = (runcmd("git rev-parse --show-toplevel".split(), self.dir) or '').strip()
         if not reporoot:
             raise Exception("Cannot get repository root for directory %s" % self.dir)
-        hooks_dir = os.path.join(reporoot, '.git', 'hooks')
+        gitdir = (runcmd("git rev-parse --absolute-git-dir".split(), self.dir) or '').strip()
+        if not gitdir:
+            raise Exception("Cannot get gitdir for directory %s" % self.dir)
+        hooks_dir = os.path.join(gitdir, 'hooks')
         hooks_dir_backup = hooks_dir + '.devtool-orig'
         if os.path.lexists(hooks_dir_backup):
             raise Exception("Git hooks backup directory already exists: %s" % hooks_dir_backup)

--
2.41.0

#1 lore raw

PATCH v2 2/2 vulkan-samples: convert debugfix.patch to git format patch

devtool modify on vulkan-samples fails to apply the debugfix.patch because it is not in one of git's known formats.

Here is the error:
ERROR: Applying patch 'debugfix.patch' on target directory '<..>/build/tmp/work/core2-64-poky-linux/vulkan-samples/git/devtooltmp-38uz7jyq/workdir/git' CmdError("sh -c 'git add -f -A .'", 0, 'stdout:
stderr: fatal: not a git repository (or any of the parent directories):
.git
')

Also, rename debugfix.patch to something more meaningfull

---
 ...n-samples-Fix-reproducibility-issue.patch} | 22 ++++++++++++++-----
 .../vulkan/vulkan-samples_git.bb              |  2 +-
 2 files changed, 18 insertions(+), 6 deletions(-)
 rename meta/recipes-graphics/vulkan/vulkan-samples/{debugfix.patch => 0001-vulkan-samples-Fix-reproducibility-issue.patch} (62%)
meta/recipes-graphics/vulkan/vulkan-samples/0001-vulkan-samples-Fix-reproducibility-issue.patch renamed from meta/recipes-graphics/vulkan/vulkan-samples/debugfix.patch +17 -5
similarity index 62%
rename from meta/recipes-graphics/vulkan/vulkan-samples/debugfix.patch
rename to meta/recipes-graphics/vulkan/vulkan-samples/0001-vulkan-samples-Fix-reproducibility-issue.patch
index d723fcc19ad..76090114211 100644
@@ -1,3 +1,8 @@
+From d998c753254649c7cf7c64e3fed78e41c11ad7ed Mon Sep 17 00:00:00 2001
+From: Richard Purdie <[email protected]>
+Date: Wed, 23 Aug 2023 09:38:37 +0200
+Subject: [PATCH] vulkan-samples: Fix reproducibility issue
+
 There is code to remove the prefix CMAKE_SOURCE_DIR from __FILENAME__ paths
 used for logging with LOGE() in the code. We need to make this match the value we use
 in the debug source remapping from CFLAGS
@@ -16,11 +21,16 @@ will currently change the output!
 Upstream-Status: Pending [needs to be discussed upstream]
 Signed-off-by: Richard Purdie <[email protected]>
 
-Index: git/bldsys/cmake/global_options.cmake
-===================================================================
---- git.orig/bldsys/cmake/global_options.cmake
-+++ git/bldsys/cmake/global_options.cmake
-@@ -47,7 +47,7 @@ set(CMAKE_CXX_STANDARD 14)
+Signed-off-by: Julien Stephan <[email protected]>
+---
+ bldsys/cmake/global_options.cmake | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/bldsys/cmake/global_options.cmake b/bldsys/cmake/global_options.cmake
+index b15c2da..d8952e5 100644
+--- a/bldsys/cmake/global_options.cmake
++++ b/bldsys/cmake/global_options.cmake
+@@ -62,7 +62,7 @@ set(CMAKE_CXX_STANDARD 14)
  set(CMAKE_DISABLE_SOURCE_CHANGES ON)
  set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
  
@@ -29,3 +39,5 @@ Index: git/bldsys/cmake/global_options.cmake
  add_definitions(-DROOT_PATH_SIZE=${ROOT_PATH_SIZE})
  
  set(CMAKE_C_FLAGS_DEBUG   "-DDEBUG=0 ${CMAKE_C_FLAGS_DEBUG}")
+--
+2.41.0
meta/recipes-graphics/vulkan/vulkan-samples_git.bb +1 -1
index 458d1405aee..66f1ef5e9df 100644
@@ -6,7 +6,7 @@ LICENSE = "Apache-2.0"
 LIC_FILES_CHKSUM = "file://LICENSE;md5=48aa35cefb768436223a6e7f18dc2a2a"
 
 SRC_URI = "gitsm://github.com/KhronosGroup/Vulkan-Samples.git;branch=main;protocol=https;lfs=0 \
-           file://debugfix.patch \
+           file://0001-vulkan-samples-Fix-reproducibility-issue.patch \
            file://0001-Do-not-use-LFS64-functions-on-linux-musl.patch;patchdir=third_party/spdlog \
            file://0001-Deprecate-u8string_view.patch;patchdir=third_party/spdlog \
            file://32bit.patch \
Signature · 1 line
2.41.0