From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 2/2] git-format-patch: Document format for binary patch
Date: Wed, 24 Mar 2021 19:30:27 +0700 [thread overview]
Message-ID: <20210324123027.29460-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20210324123027.29460-1-bagasdotme@gmail.com>
Document binary file patch formats that are different from text file
patch.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/git-format-patch.txt | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 247033f8fc..8de172b1f4 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -725,6 +725,28 @@ diff format is described as below:
include::diff-generate-patch.txt[]
+Binary Files
+~~~~~~~~~~~~
+For binary files, the diff format have some differences compared to text
+files:
+
+1. Object hashes in index header line (`index <hash>..<hash> <mode>`)
+ are always given in full form, as binary patch is designed to be
+ applied only to an exact copy of original file. This is to ensure
+ that such patch don't apply to file with similar name but different
+ hash.
+
+2. There are additional extended header lines specific to binary files:
+
+ GIT binary patch
+ delta <bytes>
+ literal <bytes>
+
+3. The diff body can be either delta or full (literal) content,
+ whichever is the smallest size. It is encoded with base85 algorithm,
+ and emitted in 64 characters each line. All but the last line in
+ the body are prefixed with `z`.
+
SEE ALSO
--------
linkgit:git-am[1], linkgit:git-send-email[1]
--
2.25.1
next prev parent reply other threads:[~2021-03-24 12:31 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-24 12:30 [PATCH 0/2] Diff format documentation for git-format-patch Bagas Sanjaya
2021-03-24 12:30 ` [PATCH 1/2] git-format-patch: Include diff-generate-patch documentation Bagas Sanjaya
2021-03-24 17:40 ` Junio C Hamano
2021-03-24 12:30 ` Bagas Sanjaya [this message]
2021-03-24 17:53 ` [PATCH 2/2] git-format-patch: Document format for binary patch Junio C Hamano
2021-03-25 6:22 ` Bagas Sanjaya
2021-03-25 18:25 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210324123027.29460-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).