docs: file mode is silently converted to decimal in Ignition output (not documented)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 974
- Forks
- 296
- Avg merge
- 6d 14h
- Merged PRs (30d)
- 9
Description
Created originally in Butane by @hariprakazz: https://github.com/coreos/butane/issues/733
Butane accepts mode: 0644 (octal, as written) but the generated Ignition JSON stores it as 420 (decimal) — e.g. mode: 0644 → "mode": 420. Nothing in the docs mentions this conversion, so anyone hand-writing or diffing Ignition output has to discover it by testing. Repro: any .bu file with a storage.files entry setting mode, run through butane --strict.
Happy to submit a docs PR adding a short note (and example) to docs/config.md or docs/specs.md if that's the right place — let me know which.
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
Check docs/config.md and docs/specs.md to determine where file-mode behavior is documented; reproduce the example with a .bu file containing a storage.files mode and run it through butane --strict. Done means the chosen documentation explains the octal-to-decimal conversion and includes an example such as 0644 becoming 420.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100