Skip to content

docs: correct encrypted credentials filename - #4875

Open
carlozatl wants to merge 1 commit into
archlinux:masterfrom
carlozatl:docs/fix-credentials-filename
Open

carlozatl wants to merge 1 commit into
archlinux:masterfrom
carlozatl:docs/fix-credentials-filename

Conversation

@carlozatl

Copy link
Copy Markdown

PR Description

Fix an incorrect filename in the "Credentials configuration file encryption" section of README.md.

The documentation refers to user_configuration.json when describing how to load an encrypted credentials file using --creds. However, the correct filename is user_credentials.json, as indicated by the surrounding documentation and the USER_CREDS_FILE definition.

This PR changes only that filename.

Tests and Checks

  • I have tested the code.

Documentation-only change. Verified the filename against the implementation and reviewed the one-line diff. No runtime tests were performed.

AI Assistance

ChatGPT assisted with identifying and verifying the documentation error. Claude Chat independently reviewed the proposed correction and recommended limiting the change to the filename. I reviewed the final diff and source references before submission.

Correct the filename in the "Credentials configuration file encryption" section of `README.md`.

The instructions refer to an encrypted `user_configuration.json` file when describing the `--creds` argument. However, `--creds` accepts the credentials file, `user_credentials.json`, as also indicated by the surrounding documentation.

The implementation defines `USER_CREDS_FILE` as `user_credentials.json` in [`archinstall/lib/args.py`](https://github.com/archlinux/archinstall/blob/2c25540ad56b23922b9bbf44320b3154c0ecfd15/archinstall/lib/args.py#L101).mThis patch corrects that filename only.

Tests and Checks
I have tested the code. Documentation-only change. The source filename and final Markdown diff were reviewed. No runtime tests were performed.

ChatGPT assisted with source-code verification and drafting. Claude Chat independently reviewed the correction and its scope. I reviewed the final change and verified the source references before submission.
@carlozatl
carlozatl requested a review from Torxed as a code owner November 11, 2026 16:04

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant