osbuild / osbuild/image-builder
Are the docs for `KernelOptionsBootloader` correct?
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 77
- Forks
- 103
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 53
Description
When working on: https://github.com/teamsbc/distribution/issues/22 I noticed the KernelOptionsBootloader seem to be incorrectly documented. It talks about writing to grubenv but I think it does no such thing?
Setting its value to true actually omits writing the kernel arguments to either the bootloader configuration or before RPM installation (which is exactly what I needed, see related issue for details).
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
Locate the documentation and implementation for KernelOptionsBootloader, then compare the documented grubenv behavior with the behavior described in this issue. Read related issue 22 for context and update the documentation so it accurately explains what setting the value to true omits; done means the documented behavior matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100