Skip to content

Commit 7022bd9

Browse files
committed
docs: Fix various errors
Remove references to non-existent commands and incorrect options: - Remove non-existent `bcvk libvirt create` command from README - Remove non-existent `bcvk libvirt restart` command - Remove incorrect `--autostart` flag from libvirt-run examples - Remove unsupported disk formats (VHD, VMDK) from disk-images.md and really trim down to be clear it just wraps bootc install. - Remove non-existent `--partition` option - Fix `--size` to correct `--disk-size` flag throughout Fix incorrect references: - Fix binary name from `bck` to `bcvk` in docs/HACKING.md and Justfile - Fix repository URL from cgwalters/bcvk to bootc-dev/bcvk Fix incomplete content: - Complete incomplete sentence in README about ephemeral VMs - Populate empty docs/src/HACKING.md with redirect to ../HACKING.md - Fix path in docs/src/contributing.md Assisted-by: Claude Code (Sonnet 4.5) Signed-off-by: Colin Walters <walters@verbum.org>
1 parent ffd9870 commit 7022bd9

File tree

9 files changed

+11
-78
lines changed

9 files changed

+11
-78
lines changed

Justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,5 @@ archive: build
9494

9595
# Install the binary to ~/.local/bin
9696
install: build
97-
cp target/release/bck ~/.local/bin/
97+
cp target/release/bcvk ~/.local/bin/
9898

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ bcvk ephemeral run-ssh quay.io/fedora/fedora-bootc:42
2828
```
2929

3030
Everything with `bcvk ephemeral` creates a podman container that reuses the
31-
host virtualization stack, and
31+
host virtualization stack, making it simple to test bootc containers without
32+
requiring root privileges or dedicated VM infrastructure.
3233

3334
### Creating a persistent bootable disk image from a container image
3435
```bash
@@ -90,9 +91,6 @@ bcvk libvirt rm my-fedora-vm
9091
bcvk to-disk quay.io/fedora/fedora-bootc:42 /tmp/fedora.img
9192
bcvk libvirt upload /tmp/fedora.img --name fedora-base
9293

93-
# Create a domain from uploaded image
94-
bcvk libvirt create fedora-base --name my-vm --memory 8192
95-
9694
# Run with custom filesystem and network settings
9795
bcvk libvirt run --filesystem xfs --network bridge quay.io/centos-bootc/centos-bootc:stream10
9896
```

docs/HACKING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Integration tests require QEMU/KVM to be fully working as they launch actual VMs
3434

3535
## Running
3636

37-
Ensure the entrypoint script is in `$PATH`, i.e. that `bck` works.
37+
Ensure the entrypoint script is in `$PATH`, i.e. that `bcvk` works.
3838

39-
Then you can invoke `bck`.
39+
Then you can invoke `bcvk`.
4040

4141
## Code formatting
4242

docs/src/HACKING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# HACKING
2+
3+
See [../HACKING.md](../HACKING.md) for development instructions.

docs/src/building.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ sudo systemctl enable --now libvirtd
3535
## Clone and Build
3636

3737
```bash
38-
git clone https://github.com/cgwalters/bcvk.git
38+
git clone https://github.com/bootc-dev/bcvk.git
3939
cd bcvk
4040
cargo build --release
4141
```

docs/src/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Contributing
22

3-
We welcome contributions to bcvk! Please see [docs/HACKING.md](../HACKING.md) for detailed development instructions.
3+
We welcome contributions to bcvk! Please see [../HACKING.md](../HACKING.md) for detailed development instructions.

docs/src/disk-images.md

Lines changed: 2 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,4 @@
11
# Disk Images
22

3-
The `to-disk` command creates bootable disk images from bootc containers.
4-
5-
## Supported Formats
6-
7-
```bash
8-
# Raw disk image (default)
9-
bcvk to-disk quay.io/fedora/fedora-bootc:42 output.img
10-
11-
# QCOW2 (compressed, for QEMU/KVM)
12-
bcvk to-disk --format qcow2 quay.io/fedora/fedora-bootc:42 output.qcow2
13-
14-
# VHD (Hyper-V, Azure)
15-
bcvk to-disk --format vhd quay.io/fedora/fedora-bootc:42 output.vhd
16-
17-
# VMDK (VMware)
18-
bcvk to-disk --format vmdk quay.io/fedora/fedora-bootc:42 output.vmdk
19-
```
20-
21-
## Configuration Options
22-
23-
```bash
24-
# Disk size
25-
bcvk to-disk --size 50G quay.io/fedora/fedora-bootc:42 output.img
26-
27-
# Filesystem type
28-
bcvk to-disk --filesystem xfs quay.io/fedora/fedora-bootc:42 output.img
29-
bcvk to-disk --filesystem ext4 quay.io/fedora/fedora-bootc:42 output.img
30-
31-
# Partitioning scheme
32-
bcvk to-disk --partition gpt quay.io/fedora/fedora-bootc:42 output.img
33-
bcvk to-disk --partition mbr quay.io/fedora/fedora-bootc:42 output.img
34-
```
35-
36-
## Common Use Cases
37-
38-
### Cloud Deployment
39-
40-
```bash
41-
# AWS/GCP (raw format)
42-
bcvk to-disk --format raw --size 30G quay.io/fedora/fedora-bootc:42 cloud.img
43-
44-
# Azure (VHD format)
45-
bcvk to-disk --format vhd --size 30G quay.io/fedora/fedora-bootc:42 azure.vhd
46-
```
47-
48-
### Bare Metal
49-
50-
```bash
51-
# Create bootable USB/SD card image
52-
bcvk to-disk --size 16G quay.io/fedora/fedora-bootc:42 usb.img
53-
sudo dd if=usb.img of=/dev/sdX bs=4M status=progress
54-
```
55-
56-
### Virtualization
57-
58-
```bash
59-
# QEMU/KVM
60-
bcvk to-disk --format qcow2 quay.io/fedora/fedora-bootc:42 vm.qcow2
61-
qemu-system-x86_64 -hda vm.qcow2 -m 2048 -enable-kvm
62-
63-
# VMware
64-
bcvk to-disk --format vmdk quay.io/fedora/fedora-bootc:42 vm.vmdk
65-
66-
# VirtualBox (requires conversion)
67-
bcvk to-disk --format raw quay.io/fedora/fedora-bootc:42 vm.img
68-
VBoxManage convertfromraw vm.img vm.vdi
69-
```
3+
The `to-disk` command creates disk images from bootc containers.
4+
It is a wrapper for [bootc install to-disk](https://bootc-dev.github.io/bootc/man/bootc-install-to-disk.8.html).

docs/src/libvirt-manage.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ bcvk libvirt run --name myvm quay.io/fedora/fedora-bootc:42
99
# Manage state
1010
bcvk libvirt start myvm
1111
bcvk libvirt stop myvm
12-
bcvk libvirt restart myvm
1312

1413
# Remove VM
1514
bcvk libvirt rm myvm

docs/src/libvirt-run.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ bcvk libvirt run \
1313
--name production-api \
1414
--memory 8192 \
1515
--cpus 4 \
16-
--autostart \
1716
quay.io/myapp/api:v1.0
1817

1918
# Development setup with SSH

0 commit comments

Comments
 (0)