mirror of
https://github.com/linka-cloud/d2vm.git
synced 2024-11-13 03:26:25 +00:00
docs: update cli reference
Signed-off-by: Adphi <philippe.adrien.nousse@gmail.com>
This commit is contained in:
parent
c5bf2e1713
commit
8ca3f4a375
6
Makefile
6
Makefile
@ -28,7 +28,7 @@ GORELEASER_URL := https://github.com/goreleaser/goreleaser/releases/download/$(G
|
||||
BIN := $(PWD)/bin
|
||||
export PATH := $(BIN):$(PATH)
|
||||
|
||||
CLI_REFERENCE_PATH := docs/reference
|
||||
CLI_REFERENCE_PATH := docs/content/reference
|
||||
|
||||
bin:
|
||||
@mkdir -p $(BIN)
|
||||
@ -67,7 +67,7 @@ tests:
|
||||
@go list ./...| xargs go test -exec sudo -count=1 -timeout 20m -v
|
||||
|
||||
docs-up-to-date:
|
||||
@$(MAKE) docs
|
||||
@$(MAKE) cli-docs
|
||||
@git diff --quiet -- docs ':(exclude)docs/reference/d2vm_run_qemu.md' || (git --no-pager diff -- docs ':(exclude)docs/reference/d2vm_run_qemu.md'; echo "Please regenerate the documentation with 'make docs'"; exit 1)
|
||||
|
||||
check-fmt:
|
||||
@ -108,6 +108,6 @@ examples: build-dev
|
||||
@echo "Building examples/full/Dockerfile"
|
||||
@./d2vm build -o examples/build/full.qcow2 --build-arg=USER=adphi --build-arg=PASSWORD=adphi examples/full
|
||||
|
||||
docs: .build
|
||||
cli-docs: .build
|
||||
@rm -rf $(CLI_REFERENCE_PATH)
|
||||
@./d2vm docs $(CLI_REFERENCE_PATH)
|
||||
|
@ -17,6 +17,7 @@ d2vm build [context directory] [flags]
|
||||
--network-manager string Network manager to use for the image: none, netplan, ifupdown
|
||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||
-p, --password string Root user password (default "root")
|
||||
--raw Just convert the container to virtual machine image without installing anything more
|
||||
-s, --size string The output image size (default "10G")
|
||||
```
|
||||
|
@ -16,6 +16,7 @@ d2vm convert [docker image] [flags]
|
||||
-o, --output string The output image, the extension determine the image format, raw will be used if none. Supported formats: qcow2 qed raw vdi vhd vmdk (default "disk0.qcow2")
|
||||
-p, --password string The Root user password (default "root")
|
||||
--pull Always pull docker image
|
||||
--raw Just convert the container to virtual machine image without installing anything more
|
||||
-s, --size string The output image size (default "10G")
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user