doc: mention the pointer size constraint #5900
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisd8088
approved these changes
Nov 1, 2024
docs/spec.md
Outdated
| * Values MUST NOT contain return or newline characters. | ||
| * Pointer files MUST be stored in Git with their executable bit matching that | ||
| of the replaced file. | ||
| * Pointer files must be less than 1024 bytes in size. |
Member
There was a problem hiding this comment.
Thank you very much for adding this key bit of documentation!
The only thing I can think we might expand on here is to clarify that this maximum includes any Git LFS pointer extension lines as well, maybe just by saying something like:
Suggested change
| * Pointer files must be less than 1024 bytes in size. | |
| * Pointer files must be less than 1024 bytes in size, including any pointer extension lines. |
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.
chrisd8088
approved these changes
Nov 4, 2024
Member
chrisd8088
left a comment
chrisd8088
left a comment
There was a problem hiding this comment.
Thanks very much for this!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.