diff mbox series

contributor-guide/submit-changes.rst: suggest to remove the git signature

Message ID 20241223-patch-no-signature-v1-1-b59c3641943f@bootlin.com
State Under Review
Headers show
Series contributor-guide/submit-changes.rst: suggest to remove the git signature | expand

Commit Message

Antonin Godard Dec. 23, 2024, 2:33 p.m. UTC
By default when sending patches Git adds the git version at the bottom
of the patch, which is not necessary in most cases. Suggest to remove it
when configuring Git when sending patches.

Suggested-By: Jaekyu Lee <jaekyu.lee@lge.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Following discussion on: https://lists.openembedded.org/g/openembedded-core/topic/106323318
---
 documentation/contributor-guide/submit-changes.rst | 7 +++++++
 1 file changed, 7 insertions(+)


---
base-commit: c4bc09f61621938086be377653121d6b4e62b570
change-id: 20241223-patch-no-signature-afc5e4e51709

Best regards,
diff mbox series

Patch

diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 7dc8da7aebccd896bcb341e515891dfef2792fa5..85ca987df219c1ffdd9f9cbe78fa34a780e17e43 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -65,6 +65,13 @@  use to identify your commits::
    git config --global user.name "Ada Lovelace"
    git config --global user.email "ada.lovelace@gmail.com"
 
+By default, Git adds a signature line at the end of patches containing the Git
+version. We suggest to remove it as it doesn't add useful information.
+
+Remove it with the following command::
+
+   git config --global format.signature ""
+
 Clone the Git repository for the component to modify
 ----------------------------------------------------