Better errors and docs when message_size > page_size/2
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 732
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the upper bound on message size is roughly half the page size.
If you insert something larger, you'll fail this this assertion.
We should:
- Document this limit in headers
- Catch this error early (when splinter is initialized), and print a useful error message, so users don't see the assert failure
Capturing this based on team discussion cc @ajhconway @gapisback
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the assertion in src/btree.c at the linked location, then trace the initialization path and relevant headers. Document the message-size limit in the appropriate headers and ensure initialization rejects oversized messages with a useful error instead of reaching the assertion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- databases
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100