From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Tue, 26 Apr 2022 12:55:58 +0000 (+0200)
Subject: docs: say 'git ls-files' instead of 'git-ls-files'
X-Git-Tag: v13~20^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=397dcb2b2a4cbe231859ba532a80777d896cf0d2;p=thirdparty%2Fmkosi.git

docs: say 'git ls-files' instead of 'git-ls-files'

The version with the hyphen hasn't been in $PATH for years, let's not
confuse our younger users.
---

diff --git a/man/mkosi.1 b/man/mkosi.1
index 3182a29ee..e32d7ccb4 100644
--- a/man/mkosi.1
+++ b/man/mkosi.1
@@ -969,8 +969,8 @@ Configures how the source file tree (as configured with
 the first phase of the build.
 Takes one of \f[C]copy-all\f[R] (to copy all files from the source
 tree), \f[C]copy-git-cached\f[R] (to copy only those files
-\f[C]git-ls-files --cached\f[R] lists), \f[C]copy-git-others\f[R] (to
-copy only those files \f[C]git-ls-files --others\f[R] lists),
+\f[C]git ls-files --cached\f[R] lists), \f[C]copy-git-others\f[R] (to
+copy only those files \f[C]git ls-files --others\f[R] lists),
 \f[C]mount\f[R] to bind mount the source tree directly.
 Defaults to \f[C]copy-git-cached\f[R] if a \f[C]git\f[R] source tree is
 detected, otherwise \f[C]copy-all\f[R].
diff --git a/mkosi.md b/mkosi.md
index 89e47e22c..aee6de1f9 100644
--- a/mkosi.md
+++ b/mkosi.md
@@ -965,8 +965,8 @@ a machine ID.
   `BuildSources=`) is transferred into the container image during the
   first phase of the build. Takes one of `copy-all` (to copy all files
   from the source tree), `copy-git-cached` (to copy only those files
-  `git-ls-files --cached` lists), `copy-git-others` (to copy only
-  those files `git-ls-files --others` lists), `mount` to bind mount
+  `git ls-files --cached` lists), `copy-git-others` (to copy only
+  those files `git ls-files --others` lists), `mount` to bind mount
   the source tree directly. Defaults to `copy-git-cached` if a `git`
   source tree is detected, otherwise `copy-all`. When you specify
   `copy-git-more`, it is the same as `copy-git-cached`, except it also
diff --git a/mkosi/__init__.py b/mkosi/__init__.py
index 0ed19f95b..e800c0fd1 100644
--- a/mkosi/__init__.py
+++ b/mkosi/__init__.py
@@ -3624,7 +3624,7 @@ def copy_git_files(src: Path, dest: Path, *, source_file_transfer: SourceFileTra
     c = run(["git", "-C", src, "submodule", "status", "--recursive"], stdout=PIPE, text=True, user=uid)
     submodules = {x.split()[1] for x in c.stdout.splitlines()}
 
-    # workaround for git-ls-files returning the path of submodules that we will
+    # workaround for git ls-files returning the path of submodules that we will
     # still parse
     files -= submodules
 
diff --git a/mkosi/backend.py b/mkosi/backend.py
index d7717cce6..12cee5e9e 100644
--- a/mkosi/backend.py
+++ b/mkosi/backend.py
@@ -194,9 +194,9 @@ class SourceFileTransfer(enum.Enum):
     def doc(cls) -> Dict[SourceFileTransfer, str]:
         return {
             cls.copy_all: "normal file copy",
-            cls.copy_git_cached: "use git-ls-files --cached, ignoring any file that git itself ignores",
-            cls.copy_git_others: "use git-ls-files --others, ignoring any file that git itself ignores",
-            cls.copy_git_more: "use git-ls-files --cached, ignoring any file that git itself ignores, but include the .git/ directory",
+            cls.copy_git_cached: "use git ls-files --cached, ignoring any file that git itself ignores",
+            cls.copy_git_others: "use git ls-files --others, ignoring any file that git itself ignores",
+            cls.copy_git_more: "use git ls-files --cached, ignoring any file that git itself ignores, but include the .git/ directory",
             cls.mount: "bind mount source files into the build image",
         }