freedomofpress / freedomofpress/kernel-builder
Document various version environment variables
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
At https://github.com/freedomofpress/kernel-builder/pull/34#pullrequestreview-1529288306 @rocodes wrote:
Slight nit is it could be good to have a bit more documentation for our future selves (specifically, that setting
LINUX_MAJOR_VERSIONoverridesLINUX_VERSION, were both to be set inbuild-kernel.sh), but not worth a hold-up. Thank you for these changes!
Contributor guide
No contributing guide indexed for this repository
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
Read build-kernel.sh and inspect how LINUX_VERSION and LINUX_MAJOR_VERSION are set and used. Update the documentation to state that setting LINUX_MAJOR_VERSION overrides LINUX_VERSION when both are configured, then verify the wording covers the version environment variables mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100