git: c117bc4a90 - main - fdp-primer: Include context in the git format-patch for users to use
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Fri, 26 Jun 2026 19:07:48 UTC
The branch main has been updated by bcr:
URL: https://cgit.FreeBSD.org/doc/commit/?id=c117bc4a9077cec38ccd1fd86a38ad4e942c1b21
commit c117bc4a9077cec38ccd1fd86a38ad4e942c1b21
Author: Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2026-06-26 18:11:05 +0000
Commit: Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2026-06-26 19:07:21 +0000
fdp-primer: Include context in the git format-patch for users to use
The quick start section did not instruct the reader to include context
in the git format-patch example. This is not ideal as it makes reviewing
easier. Include this information with a bit of explanation below it.
Event: Halifax Hackathon 202606
Location: A different chair than obiwac's
Reviewed by: lwhsu
Differential Revision: https://reviews.freebsd.org/D57891
---
documentation/content/en/books/fdp-primer/overview/_index.adoc | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
index 4abdb3f084..7f3cca1aa9 100644
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -309,10 +309,12 @@ Make sure that all required files are included, then commit the change to your l
[source,shell]
....
% git commit
-% git format-patch origin/main
+% git format-patch -U999999 origin/main
....
+
-Patch generated with `git format-patch` will include author identity and email addresses,
+The `-U999999` parameter adds as much context to the patch as possible which makes reviewing easier.
+
+A patch file is generated as a result of `git format-patch` in the local directory which will include author identity and email addresses,
making it easier for developers to apply (with `git am`) and give proper credit.
+
[IMPORTANT]