Skip to content

Commit ee1fb21

Browse files
Copilotguoweikang
andcommitted
Update command name from rkconf to xconf across all documentation and code
Co-authored-by: guoweikang <18571063+guoweikang@users.noreply.github.com>
1 parent 206caf5 commit ee1fb21

5 files changed

Lines changed: 32 additions & 32 deletions

File tree

xtask/xconfig/MENUCONFIG_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The TUI (Terminal User Interface) menuconfig provides a modern, user-friendly in
6666
cd examples/sample_project
6767

6868
# Run menuconfig
69-
rkconf menuconfig
69+
xconf menuconfig
7070

7171
# The TUI will launch showing the configuration options
7272
# Use arrow keys to navigate, Space to toggle, Enter to open menus

xtask/xconfig/README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ EOF
8888
**Step 2: Generate configuration with defaults**
8989

9090
```bash
91-
rkconf saveconfig
91+
xconf saveconfig
9292
# Creates .config, auto.conf, and autoconf.h
9393
```
9494

@@ -106,7 +106,7 @@ cat .config
106106

107107
```bash
108108
# You added new options to Kconfig...
109-
rkconf oldconfig
109+
xconf oldconfig
110110

111111
# Output:
112112
# 🆕 New configuration options detected:
@@ -117,7 +117,7 @@ rkconf oldconfig
117117

118118
With auto-defaults:
119119
```bash
120-
rkconf oldconfig --auto-defaults
120+
xconf oldconfig --auto-defaults
121121
# Automatically applies default values to new options
122122
```
123123

@@ -132,7 +132,7 @@ use std::fs;
132132
fn main() {
133133
// Read the generated configuration
134134
let config = fs::read_to_string(".config")
135-
.expect("Run 'rkconf saveconfig' first");
135+
.expect("Run 'xconf saveconfig' first");
136136

137137
for line in config.lines() {
138138
let line = line.trim();
@@ -198,11 +198,11 @@ fn main() {
198198

199199
## 📚 Commands Reference
200200

201-
### `rkconf saveconfig`
201+
### `xconf saveconfig`
202202
Generate configuration files with default values from Kconfig.
203203

204204
```bash
205-
rkconf saveconfig [OPTIONS]
205+
xconf saveconfig [OPTIONS]
206206

207207
Options:
208208
-o, --output <FILE> Output .config path [default: .config]
@@ -212,14 +212,14 @@ Options:
212212

213213
**Example:**
214214
```bash
215-
rkconf saveconfig --output my.config --kconfig MyKconfig
215+
xconf saveconfig --output my.config --kconfig MyKconfig
216216
```
217217

218-
### `rkconf oldconfig`
218+
### `xconf oldconfig`
219219
Update existing configuration when Kconfig changes.
220220

221221
```bash
222-
rkconf oldconfig [OPTIONS]
222+
xconf oldconfig [OPTIONS]
223223

224224
Options:
225225
-c, --config <FILE> Input .config file [default: .config]
@@ -237,17 +237,17 @@ Options:
237237
**Example:**
238238
```bash
239239
# Interactive mode (prompts for new options)
240-
rkconf oldconfig
240+
xconf oldconfig
241241

242242
# Automatic mode (uses defaults for new options)
243-
rkconf oldconfig --auto-defaults
243+
xconf oldconfig --auto-defaults
244244
```
245245

246-
### `rkconf generate`
246+
### `xconf generate`
247247
Generate auto.conf and autoconf.h from existing .config.
248248

249249
```bash
250-
rkconf generate [OPTIONS]
250+
xconf generate [OPTIONS]
251251

252252
Options:
253253
-c, --config <FILE> Input .config file [default: .config]
@@ -257,14 +257,14 @@ Options:
257257

258258
**Example:**
259259
```bash
260-
rkconf generate --config production.config
260+
xconf generate --config production.config
261261
```
262262

263-
### `rkconf parse`
263+
### `xconf parse`
264264
Parse and validate Kconfig syntax (debugging tool).
265265

266266
```bash
267-
rkconf parse [OPTIONS]
267+
xconf parse [OPTIONS]
268268

269269
Options:
270270
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
@@ -273,14 +273,14 @@ Options:
273273

274274
**Example:**
275275
```bash
276-
rkconf parse --kconfig Kconfig
276+
xconf parse --kconfig Kconfig
277277
```
278278

279-
### `rkconf menuconfig`
279+
### `xconf menuconfig`
280280
Interactive terminal UI for configuration.
281281

282282
```bash
283-
rkconf menuconfig [OPTIONS]
283+
xconf menuconfig [OPTIONS]
284284

285285
Options:
286286
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
@@ -298,11 +298,11 @@ Options:
298298

299299
See [MENUCONFIG_GUIDE.md](MENUCONFIG_GUIDE.md) for detailed usage.
300300

301-
### `rkconf defconfig` *(Coming Soon)*
301+
### `xconf defconfig` *(Coming Soon)*
302302
Apply a defconfig file.
303303

304304
```bash
305-
rkconf defconfig <DEFCONFIG_FILE> [OPTIONS]
305+
xconf defconfig <DEFCONFIG_FILE> [OPTIONS]
306306

307307
Options:
308308
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
@@ -367,7 +367,7 @@ examples/sample_project/
367367
**Try it:**
368368
```bash
369369
cd examples/sample_project
370-
rkconf saveconfig
370+
xconf saveconfig
371371
cat .config
372372
```
373373

xtask/xconfig/docs/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,10 @@ Error type for Kconfig operations.
377377

378378
### Running Commands
379379

380-
The CLI is accessed through the `rkconf` binary:
380+
The CLI is accessed through the `xconf` binary:
381381

382382
```bash
383-
rkconf <command> [options]
383+
xconf <command> [options]
384384
```
385385

386386
Available commands:

xtask/xconfig/docs/USAGE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ cargo install --path .
1212

1313
## Command Line Interface
1414

15-
The `rkconf` binary provides several commands for working with Kconfig files.
15+
The `xconf` binary provides several commands for working with Kconfig files.
1616

1717
### Parse Command
1818

1919
Parse a Kconfig file and display its AST:
2020

2121
```bash
22-
rkconf parse --kconfig Kconfig --srctree .
22+
xconf parse --kconfig Kconfig --srctree .
2323
```
2424

2525
Options:
@@ -28,31 +28,31 @@ Options:
2828

2929
Example:
3030
```bash
31-
rkconf parse --kconfig examples/sample_project/Kconfig --srctree examples/sample_project
31+
xconf parse --kconfig examples/sample_project/Kconfig --srctree examples/sample_project
3232
```
3333

3434
### Defconfig Command
3535

3636
Apply a defconfig file (not yet implemented):
3737

3838
```bash
39-
rkconf defconfig <defconfig-path> --kconfig Kconfig --srctree .
39+
xconf defconfig <defconfig-path> --kconfig Kconfig --srctree .
4040
```
4141

4242
### Menuconfig Command
4343

4444
Interactive TUI configuration (not yet implemented):
4545

4646
```bash
47-
rkconf menuconfig --kconfig Kconfig --srctree .
47+
xconf menuconfig --kconfig Kconfig --srctree .
4848
```
4949

5050
### Generate Command
5151

5252
Generate configuration files from .config:
5353

5454
```bash
55-
rkconf generate --config .config --kconfig Kconfig --srctree .
55+
xconf generate --config .config --kconfig Kconfig --srctree .
5656
```
5757

5858
This command generates:

xtask/xconfig/src/cli/commands.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use clap::{Parser as ClapParser, Subcommand};
55
use std::path::PathBuf;
66

77
#[derive(ClapParser, Debug)]
8-
#[command(name = "rkconf")]
8+
#[command(name = "xconf")]
99
#[command(about = "Rust Kconfig tool - Kbuild configuration system", long_about = None)]
1010
pub struct Cli {
1111
#[command(subcommand)]

0 commit comments

Comments
 (0)