From 00cc3d861be1b2f14abac482ae1ff00cf080f4c0 Mon Sep 17 00:00:00 2001 From: caarlos0 Date: Wed, 8 May 2024 19:03:20 +0000 Subject: [PATCH] docs: update cmd docs --- www/docs/cmd/nfpm.md | 4 +- www/docs/cmd/nfpm_completion.md | 2 +- www/docs/cmd/nfpm_init.md | 2 +- www/docs/cmd/nfpm_jsonschema.md | 2 +- www/docs/cmd/nfpm_package.md | 4 +- www/docs/static/schema.json | 81 +++++++++++++++++++++++++++++++++ 6 files changed, 88 insertions(+), 7 deletions(-) diff --git a/www/docs/cmd/nfpm.md b/www/docs/cmd/nfpm.md index 1f195b3b..2faa302f 100644 --- a/www/docs/cmd/nfpm.md +++ b/www/docs/cmd/nfpm.md @@ -1,10 +1,10 @@ # nfpm -Packages apps on RPM, Deb, APK and Arch Linux formats based on a YAML configuration file +Packages apps on RPM, Deb, APK, Arch Linux, and ipk formats based on a YAML configuration file ## Synopsis -nFPM is a simple and 0-dependencies deb, rpm, apk and arch linux packager written in Go. +nFPM is a simple and 0-dependencies apk, arch, deb, ipk and rpm linux packager written in Go. ## Options diff --git a/www/docs/cmd/nfpm_completion.md b/www/docs/cmd/nfpm_completion.md index 961caf93..6e36a2e9 100644 --- a/www/docs/cmd/nfpm_completion.md +++ b/www/docs/cmd/nfpm_completion.md @@ -16,7 +16,7 @@ See each sub-command's help for details on how to use the generated script. ## See also -* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK and Arch Linux formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK, Arch Linux, and ipk formats based on a YAML configuration file * [nfpm completion bash](/cmd/nfpm_completion_bash/) - Generate the autocompletion script for bash * [nfpm completion fish](/cmd/nfpm_completion_fish/) - Generate the autocompletion script for fish * [nfpm completion powershell](/cmd/nfpm_completion_powershell/) - Generate the autocompletion script for powershell diff --git a/www/docs/cmd/nfpm_init.md b/www/docs/cmd/nfpm_init.md index 1742e7f1..db6909ef 100644 --- a/www/docs/cmd/nfpm_init.md +++ b/www/docs/cmd/nfpm_init.md @@ -15,5 +15,5 @@ nfpm init [flags] ## See also -* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK and Arch Linux formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK, Arch Linux, and ipk formats based on a YAML configuration file diff --git a/www/docs/cmd/nfpm_jsonschema.md b/www/docs/cmd/nfpm_jsonschema.md index a6231d41..e22e5864 100644 --- a/www/docs/cmd/nfpm_jsonschema.md +++ b/www/docs/cmd/nfpm_jsonschema.md @@ -15,5 +15,5 @@ nfpm jsonschema [flags] ## See also -* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK and Arch Linux formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK, Arch Linux, and ipk formats based on a YAML configuration file diff --git a/www/docs/cmd/nfpm_package.md b/www/docs/cmd/nfpm_package.md index f18bff0c..d8d98bd9 100644 --- a/www/docs/cmd/nfpm_package.md +++ b/www/docs/cmd/nfpm_package.md @@ -11,11 +11,11 @@ nfpm package [flags] ``` -f, --config string config file to be used (default "nfpm.yaml") -h, --help help for package - -p, --packager string which packager implementation to use [apk|deb|rpm|archlinux] + -p, --packager string which packager implementation to use [apk|archlinux|deb|ipk|rpm] -t, --target string where to save the generated package (filename, folder or empty for current folder) ``` ## See also -* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK and Arch Linux formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb, APK, Arch Linux, and ipk formats based on a YAML configuration file diff --git a/www/docs/static/schema.json b/www/docs/static/schema.json index ed0ba769..36146939 100644 --- a/www/docs/static/schema.json +++ b/www/docs/static/schema.json @@ -192,6 +192,10 @@ "$ref": "#/$defs/ArchLinux", "title": "archlinux-specific settings" }, + "ipk": { + "$ref": "#/$defs/IPK", + "title": "ipk-specific settings" + }, "name": { "type": "string", "title": "package name" @@ -563,6 +567,79 @@ "additionalProperties": false, "type": "object" }, + "IPK": { + "properties": { + "abi_version": { + "type": "string", + "title": "abi version" + }, + "alternatives": { + "items": { + "$ref": "#/$defs/IPKAlternative" + }, + "type": "array", + "title": "alternatives" + }, + "arch": { + "type": "string", + "title": "architecture in deb nomenclature" + }, + "auto_installed": { + "type": "boolean", + "title": "auto installed", + "default": false + }, + "essential": { + "type": "boolean", + "title": "whether package is essential", + "default": false + }, + "fields": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "fields" + }, + "predepends": { + "items": { + "type": "string", + "examples": [ + "nfpm" + ] + }, + "type": "array", + "title": "predepends directive" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array", + "title": "tags" + } + }, + "additionalProperties": false, + "type": "object" + }, + "IPKAlternative": { + "properties": { + "priority": { + "type": "integer", + "title": "priority" + }, + "target": { + "type": "string", + "title": "target" + }, + "link_name": { + "type": "string", + "title": "link name" + } + }, + "additionalProperties": false, + "type": "object" + }, "Overridables": { "properties": { "replaces": { @@ -655,6 +732,10 @@ "archlinux": { "$ref": "#/$defs/ArchLinux", "title": "archlinux-specific settings" + }, + "ipk": { + "$ref": "#/$defs/IPK", + "title": "ipk-specific settings" } }, "additionalProperties": false,