Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion xtask/xconfig/MENUCONFIG_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The TUI (Terminal User Interface) menuconfig provides a modern, user-friendly in
cd examples/sample_project

# Run menuconfig
rkconf menuconfig
xconf menuconfig

# The TUI will launch showing the configuration options
# Use arrow keys to navigate, Space to toggle, Enter to open menus
Expand Down
44 changes: 22 additions & 22 deletions xtask/xconfig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ EOF
**Step 2: Generate configuration with defaults**

```bash
rkconf saveconfig
xconf saveconfig
# Creates .config, auto.conf, and autoconf.h
```

Expand All @@ -106,7 +106,7 @@ cat .config

```bash
# You added new options to Kconfig...
rkconf oldconfig
xconf oldconfig

# Output:
# 🆕 New configuration options detected:
Expand All @@ -117,7 +117,7 @@ rkconf oldconfig

With auto-defaults:
```bash
rkconf oldconfig --auto-defaults
xconf oldconfig --auto-defaults
# Automatically applies default values to new options
```

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

for line in config.lines() {
let line = line.trim();
Expand Down Expand Up @@ -198,11 +198,11 @@ fn main() {

## 📚 Commands Reference

### `rkconf saveconfig`
### `xconf saveconfig`
Generate configuration files with default values from Kconfig.

```bash
rkconf saveconfig [OPTIONS]
xconf saveconfig [OPTIONS]

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

**Example:**
```bash
rkconf saveconfig --output my.config --kconfig MyKconfig
xconf saveconfig --output my.config --kconfig MyKconfig
```

### `rkconf oldconfig`
### `xconf oldconfig`
Update existing configuration when Kconfig changes.

```bash
rkconf oldconfig [OPTIONS]
xconf oldconfig [OPTIONS]

Options:
-c, --config <FILE> Input .config file [default: .config]
Expand All @@ -237,17 +237,17 @@ Options:
**Example:**
```bash
# Interactive mode (prompts for new options)
rkconf oldconfig
xconf oldconfig

# Automatic mode (uses defaults for new options)
rkconf oldconfig --auto-defaults
xconf oldconfig --auto-defaults
```

### `rkconf generate`
### `xconf generate`
Generate auto.conf and autoconf.h from existing .config.

```bash
rkconf generate [OPTIONS]
xconf generate [OPTIONS]

Options:
-c, --config <FILE> Input .config file [default: .config]
Expand All @@ -257,14 +257,14 @@ Options:

**Example:**
```bash
rkconf generate --config production.config
xconf generate --config production.config
```

### `rkconf parse`
### `xconf parse`
Parse and validate Kconfig syntax (debugging tool).

```bash
rkconf parse [OPTIONS]
xconf parse [OPTIONS]

Options:
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
Expand All @@ -273,14 +273,14 @@ Options:

**Example:**
```bash
rkconf parse --kconfig Kconfig
xconf parse --kconfig Kconfig
```

### `rkconf menuconfig`
### `xconf menuconfig`
Interactive terminal UI for configuration.

```bash
rkconf menuconfig [OPTIONS]
xconf menuconfig [OPTIONS]

Options:
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
Expand All @@ -298,11 +298,11 @@ Options:

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

### `rkconf defconfig` *(Coming Soon)*
### `xconf defconfig` *(Coming Soon)*
Apply a defconfig file.

```bash
rkconf defconfig <DEFCONFIG_FILE> [OPTIONS]
xconf defconfig <DEFCONFIG_FILE> [OPTIONS]

Options:
-k, --kconfig <FILE> Kconfig file path [default: Kconfig]
Expand Down Expand Up @@ -367,7 +367,7 @@ examples/sample_project/
**Try it:**
```bash
cd examples/sample_project
rkconf saveconfig
xconf saveconfig
cat .config
```

Expand Down
4 changes: 2 additions & 2 deletions xtask/xconfig/docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,10 +377,10 @@ Error type for Kconfig operations.

### Running Commands

The CLI is accessed through the `rkconf` binary:
The CLI is accessed through the `xconf` binary:

```bash
rkconf <command> [options]
xconf <command> [options]
```

Available commands:
Expand Down
12 changes: 6 additions & 6 deletions xtask/xconfig/docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ cargo install --path .

## Command Line Interface

The `rkconf` binary provides several commands for working with Kconfig files.
The `xconf` binary provides several commands for working with Kconfig files.

### Parse Command

Parse a Kconfig file and display its AST:

```bash
rkconf parse --kconfig Kconfig --srctree .
xconf parse --kconfig Kconfig --srctree .
```

Options:
Expand All @@ -28,31 +28,31 @@ Options:

Example:
```bash
rkconf parse --kconfig examples/sample_project/Kconfig --srctree examples/sample_project
xconf parse --kconfig examples/sample_project/Kconfig --srctree examples/sample_project
```

### Defconfig Command

Apply a defconfig file (not yet implemented):

```bash
rkconf defconfig <defconfig-path> --kconfig Kconfig --srctree .
xconf defconfig <defconfig-path> --kconfig Kconfig --srctree .
```

### Menuconfig Command

Interactive TUI configuration (not yet implemented):

```bash
rkconf menuconfig --kconfig Kconfig --srctree .
xconf menuconfig --kconfig Kconfig --srctree .
```

### Generate Command

Generate configuration files from .config:

```bash
rkconf generate --config .config --kconfig Kconfig --srctree .
xconf generate --config .config --kconfig Kconfig --srctree .
```

This command generates:
Expand Down
2 changes: 1 addition & 1 deletion xtask/xconfig/src/cli/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use clap::{Parser as ClapParser, Subcommand};
use std::path::PathBuf;

#[derive(ClapParser, Debug)]
#[command(name = "rkconf")]
#[command(name = "xconf")]
#[command(about = "Rust Kconfig tool - Kbuild configuration system", long_about = None)]
pub struct Cli {
#[command(subcommand)]
Expand Down
Loading