[PATCH] doc: Mention dim cherry-pick command in getting started page
Javier Martinez Canillas
javierm at redhat.com
Thu Jul 7 09:51:23 UTC 2022
The dim tool supports a cherry-pick that is a glorified version of the git
command but adds additional metadata and checks if there are any follow-up
commits referencing the one being cherry-picked.
Let's document in the getting started page that the dim command should be
used instead of just git cherry-pick. That way people will be aware of it.
This is useful to avoid cherry-picking commits but miss existing fixes for
them, which would introduce unnecessary regressions in the target branch.
Signed-off-by: Javier Martinez Canillas <javierm at redhat.com>
---
getting-started.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/getting-started.rst b/getting-started.rst
index ea672497982d..44043fb2e5b3 100644
--- a/getting-started.rst
+++ b/getting-started.rst
@@ -71,6 +71,17 @@ rebasing) push out the new tree with::
This will also rebuild a new drm-tip integration tree. For historical reasons
there's shortcut for the drm-intel specific branches for most of these commands.
+If a commit that is already present in a branch has to be cherry-picked (e.g: a
+fix for drm-misc-fixes that is already in drm-misc-next), the dim tool must used
+as well instead of the git cherry-pick command. This can be done with:
+
+ $ dim cherry-pick <commit>
+
+This will not only cherry-pick the commit but also add some metadata such as the
+cherry-picked commit SHA-1 hash. Also checks if there were any following commits
+in that branch that referenced the cherry-picked commit. This is useful to avoid
+missing any follow-up fixes for the commit being cherry-picked.
+
Please note that if there is no specific command available from dim then you
can always use your every day tooling to get things done.
For example, if a wrong patch was applied or you need to update commit message
--
2.36.1
More information about the dim-tools
mailing list