From 8ece2d395c9988ed005934de93ba6ed1b6389e6a Mon Sep 17 00:00:00 2001 From: Christoph Niemann Date: Tue, 27 Jan 2026 08:26:46 +0100 Subject: [PATCH] doc setup_deb822_repo arg order (#11215) Co-authored-by: Christoph Niemann --- .../tools.func/TOOLS_FUNC_FUNCTIONS_REFERENCE.md | 16 +++++++++------- .../misc/tools.func/TOOLS_FUNC_USAGE_EXAMPLES.md | 12 ++++++------ 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/misc/tools.func/TOOLS_FUNC_FUNCTIONS_REFERENCE.md b/docs/misc/tools.func/TOOLS_FUNC_FUNCTIONS_REFERENCE.md index cedf43f00..361af06c8 100644 --- a/docs/misc/tools.func/TOOLS_FUNC_FUNCTIONS_REFERENCE.md +++ b/docs/misc/tools.func/TOOLS_FUNC_FUNCTIONS_REFERENCE.md @@ -137,15 +137,17 @@ Add repository in modern deb822 format (recommended over legacy format). **Signature**: ```bash -setup_deb822_repo REPO_URL NAME DIST MAIN_URL RELEASE +setup_deb822_repo NAME GPG_URL REPO_URL SUITE COMPONENT [ARCHITECTURES] [ENABLED] ``` **Parameters**: -- `REPO_URL` - URL to GPG key (e.g., https://example.com/key.gpg) - `NAME` - Repository name (e.g., "nodejs") -- `DIST` - Distribution (jammy, bookworm, etc.) -- `MAIN_URL` - Main repository URL -- `RELEASE` - Release type (main, testing, etc.) +- `GPG_URL` - URL to GPG key (e.g., https://example.com/key.gpg) +- `REPO_URL` - Main repository URL (e.g., https://example.com/repo) +- `SUITE` - Repository suite (e.g., "jammy", "bookworm") +- `COMPONENT` - Repository component (e.g., "main", "testing") +- `ARCHITECTURES` - Optional Comma-separated list of architectures (e.g., "amd64,arm64") +- `ENABLED` - Optional "true" or "false" (default: "true") **Returns**: - `0` - Repository added successfully @@ -154,10 +156,10 @@ setup_deb822_repo REPO_URL NAME DIST MAIN_URL RELEASE **Example**: ```bash setup_deb822_repo \ - "https://deb.nodesource.com/gpgkey/nodesource.gpg.key" \ "nodejs" \ + "https://deb.nodesource.com/gpgkey/nodesource.gpg.key" \ + "https://deb.nodesource.com/node_20.x" \ "jammy" \ - "https://deb.nodesource.com/node_20.x" \ "main" ``` diff --git a/docs/misc/tools.func/TOOLS_FUNC_USAGE_EXAMPLES.md b/docs/misc/tools.func/TOOLS_FUNC_USAGE_EXAMPLES.md index 96e6132b2..39475b37b 100644 --- a/docs/misc/tools.func/TOOLS_FUNC_USAGE_EXAMPLES.md +++ b/docs/misc/tools.func/TOOLS_FUNC_USAGE_EXAMPLES.md @@ -221,10 +221,10 @@ msg_info "Setting up repository" # Add custom repository in deb822 format setup_deb822_repo \ - "https://my-repo.example.com/gpg.key" \ "my-applications" \ - "jammy" \ + "https://my-repo.example.com/gpg.key" \ "https://my-repo.example.com/debian" \ + "jammy" \ "main" msg_ok "Repository configured" @@ -244,18 +244,18 @@ msg_info "Setting up repositories" # Node.js repository setup_deb822_repo \ - "https://deb.nodesource.com/gpgkey/nodesource.gpg.key" \ "nodejs" \ - "jammy" \ + "https://deb.nodesource.com/gpgkey/nodesource.gpg.key" \ "https://deb.nodesource.com/node_20.x" \ + "jammy" \ "main" # Docker repository setup_deb822_repo \ - "https://download.docker.com/linux/ubuntu/gpg" \ "docker" \ - "jammy" \ + "https://download.docker.com/linux/ubuntu/gpg" \ "https://download.docker.com/linux/ubuntu" \ + "jammy" \ "stable" # Update once for all repos