Skip to content

Fix command name inconsistency: align CLI and docs to use xconf - #1

Merged
guoweikang merged 2 commits into
mainfrom
copilot/update-command-name-in-cli
Feb 10, 2026
Merged

Fix command name inconsistency: align CLI and docs to use xconf#1
guoweikang merged 2 commits into
mainfrom
copilot/update-command-name-in-cli

Conversation

Copilot AI commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

The binary was named xconf in Cargo.toml, but all CLI help text and documentation referenced rkconf, causing user confusion.

Changes

  • CLI command name (src/cli/commands.rs): Updated clap attribute from name = "rkconf" to name = "xconf"
  • Documentation: Replaced all rkconf references with xconf across:
    • README.md (15 occurrences)
    • MENUCONFIG_GUIDE.md (1 occurrence)
    • docs/USAGE.md (6 occurrences)
    • docs/API.md (2 occurrences)

All command help text now correctly displays:

$ xconf --help
Usage: xconf <COMMAND>

Commands:
  parse       Parse a Kconfig file and display the AST
  menuconfig  Interactive menu configuration (TUI)
  generate    Generate configuration files
  ...
Original prompt

Problem: Inconsistent command naming

Currently, the binary is named xconf in Cargo.toml, but all documentation and CLI help text refers to rkconf. This creates confusion for users.

Required Changes

1. Update CLI command name in code

File: xtask/xconfig/src/cli/commands.rs

  • Line 8: Change #[command(name = "rkconf")] to #[command(name = "xconf")]

2. Update all documentation references

File: xtask/xconfig/README.md

Replace all occurrences of rkconf with xconf:

  • Line 90: rkconf saveconfigxconf saveconfig
  • Line 102: rkconf saveconfigxconf saveconfig
  • Line 105-122: All rkconf commands → xconf
  • Line 247: rkconf oldconfigxconf oldconfig
  • Line 252: rkconf oldconfigxconf oldconfig
  • Line 256: rkconf generatexconf generate
  • Line 266: rkconf generatexconf generate
  • Line 269: rkconf parsexconf parse
  • Line 279: rkconf parsexconf parse
  • Line 282: rkconf menuconfigxconf menuconfig
  • Line 288: rkconf menuconfigxconf menuconfig
  • Line 300: rkconf defconfigxconf defconfig

File: xtask/xconfig/MENUCONFIG_GUIDE.md

  • Line 68: rkconf menuconfigxconf menuconfig

File: xtask/xconfig/docs/USAGE.md

Replace all occurrences:

  • Line 12: "The rkconf binary" → "The xconf binary"
  • Line 18: rkconf parsexconf parse
  • Line 27: rkconf parsexconf parse
  • Line 33: rkconf defconfigxconf defconfig
  • Line 39: rkconf menuconfigxconf menuconfig
  • Line 45: rkconf generatexconf generate

File: xtask/xconfig/docs/API.md

  • Line 366: "The CLI is accessed through the rkconf binary" → "The CLI is accessed through the xconf binary"
  • Line 369: rkconf <command>xconf <command>

File: scripts/make/config.mk

  • Line 13: Update help text if it mentions rkconf to use xconf

3. Update installation instructions

Ensure all references in README files mention xconf as the installed command.

Testing

After changes, verify:

cd xtask/xconfig
cargo build --release
./target/release/xconf --help  # Should show "xconf" as the command name

Acceptance Criteria

  • All documentation uses xconf consistently
  • CLI help text shows xconf as the command name
  • No references to rkconf remain in user-facing documentation
  • The binary continues to work correctly with the new name

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

… code

Co-authored-by: guoweikang <18571063+guoweikang@users.noreply.github.com>
Copilot AI changed the title [WIP] Update CLI command name from rkconf to xconf Fix command name inconsistency: align CLI and docs to use xconf Feb 10, 2026
Copilot AI requested a review from guoweikang February 10, 2026 07:21
@guoweikang
guoweikang marked this pull request as ready for review February 10, 2026 07:45
@guoweikang
guoweikang merged commit b5e836f into main Feb 10, 2026
2 of 7 checks passed
@guoweikang
guoweikang deleted the copilot/update-command-name-in-cli branch March 10, 2026 07:48
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.

2 participants