Skip to content

Commit ea3d9f4

Browse files
committed
doc: mention the pointer size constraint
We check in a variety of places that our pointer files are less than 1 KiB in size. Because this is a limitation, let's document it in the spec so that users can easily understand the constraint.
1 parent a577e33 commit ea3d9f4

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/spec.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ only a pointer file is written.
1919
* Values MUST NOT contain return or newline characters.
2020
* Pointer files MUST be stored in Git with their executable bit matching that
2121
of the replaced file.
22+
* Pointer files must be less than 1024 bytes in size.
2223
* Pointer files are unique: that is, there is exactly one valid encoding for a
2324
pointer file.
2425

0 commit comments

Comments
 (0)