Synopsis
git format-patch [<options>] <range>
git format-patch -1 <commit>Description
The git format-patch command produces one mailbox-formatted patch file per commit in a range, ready to be applied with git am or sent with git send-email. Each patch includes the commit message, author, date, and the diff. Patches are numbered (0001-..., 0002-...) so they apply in order.
This is the format the Linux kernel and many open source projects use for code review on mailing lists. Even projects that use pull requests sometimes accept patches via email, and format-patch is the standard producer.
Dans l'usage quotidien, git format-patch s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git format-patch --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.
Comprendre comment git format-patch interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git format-patch aide à éviter les trois.
Options courantes
| Option | Description |
|---|---|
-<n> | Generate patches for the last n commits. |
-o <dir> | Write patches to a directory. |
--cover-letter | Generate a 0000 cover letter for the series. |
-v <n>, --reroll-count=<n> | Mark patches as the n-th iteration. |
--subject-prefix=<prefix> | Custom subject prefix (default PATCH). |
--to=<addr> / --cc=<addr> | Add recipients in headers. |
--thread | Add In-Reply-To headers. |
Exemples
git format-patch -3
# Patches for the last 3 commits, in CWD
git format-patch -o ../patches main..feature
# Patches from main to feature, into ../patches/
git format-patch --cover-letter -v2 origin/main
# Versioned series with a cover letter
git format-patch --subject-prefix="PATCH myproj" -1 HEAD
# Custom subject for a project-specific listErreurs fréquentes
Generating patches against the wrong base produces apply failures for reviewers — pick the right upstream. Without --cover-letter, a multi-patch series has no introduction; reviewers appreciate one. Reroll without -v creates ambiguity about which version is being reviewed.
Commandes liées
git am, git send-email, git request-pull, git range-diff