git_reference_normalize_name should be deprecated
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 10.6k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
We shouldn't have any functions that make the user predict how big a buffer they need and then resize it and try again if they're wrong. git_reference_normalize_name does this dance with the user. We've replaced other occurrences of this with functions that use git_buf instead.
We should deprecate git_reference_normalize_name and replace it with a function that uses git_buf instead.
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 by locating the declaration and implementation of git_reference_normalize_name, then inspect related uses of git_buf in the library for the intended replacement pattern. Done means the old function is deprecated and a replacement using git_buf is available without requiring callers to predict buffer sizes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100