From 22961f2fbd0b37eea4ac0007ecc54b88546501c7 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 4 Mar 2025 22:41:31 +0530 Subject: [PATCH 1/2] CLIENT-SPECIFICATION: require support for common as an arg in platform flag --- CLIENT-SPECIFICATION.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 80d3f5d5fb7ade..cb0fce8efe13ac 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -24,6 +24,8 @@ If a page is common across multiple platforms, but slightly different on a given For example, if the command `foo` is common to `mac`, `windows`, and `linux` but functions differently on `windows`, then the main page will be stored in `common`, and a copy will be placed in `windows` that's altered to match the different functionality. +Clients SHOULD support passing `common` as an argument to the [platform flag](#arguments) (i.e. `-p common` and `--platform`) to display identical pages when a platform specific page variant (i.e. under `linux`, `openbsd`, etc) of the command exists. + ## Command-line interface This section describes the standardised command-line interface (CLI) for clients implementing one. Clients that do not provide a CLI can ignore this section. @@ -37,7 +39,7 @@ When adding support for an option, clients MUST implement all variants of that o Option | Required? | Meaning -------------------|-------------|---------- `-v`, `--version` | Yes | Shows the current version of the client, and the version of this specification that it implements. -`-p`, `--platform` | Yes | Specifies the platform to be used to perform the action (either listing or searching) as an argument. If this option is specified, the selected platform MUST be checked first instead of the current platform as described below. +`-p`, `--platform` | Yes | Specifies the platform (including common) to be used to perform the action (either listing or searching) as an argument. If this option is specified, the selected platform MUST be checked first instead of the current platform as described below. `-u`, `--update` | Conditional | Updates the offline cache of pages. MUST be implemented if caching is supported. `-l`, `--list` | No | Lists all the pages in the current platform to the standard output. `-L`, `--language` | No | Specifies the preferred language for the page returned. Overrides other language detection mechanisms. See the [language section](#language) for more information. From 4e2b8ada5106335c7a39914e7f455257dfe3f5fd Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 4 Mar 2025 23:05:02 +0530 Subject: [PATCH 2/2] Update CLIENT-SPECIFICATION.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- CLIENT-SPECIFICATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index cb0fce8efe13ac..f1743c68295ff9 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -24,7 +24,7 @@ If a page is common across multiple platforms, but slightly different on a given For example, if the command `foo` is common to `mac`, `windows`, and `linux` but functions differently on `windows`, then the main page will be stored in `common`, and a copy will be placed in `windows` that's altered to match the different functionality. -Clients SHOULD support passing `common` as an argument to the [platform flag](#arguments) (i.e. `-p common` and `--platform`) to display identical pages when a platform specific page variant (i.e. under `linux`, `openbsd`, etc) of the command exists. +Clients SHOULD support passing `common` as an argument to the [platform flag](#arguments) (i.e. `-p common` and `--platform common`) to display identical pages when a platform specific page variant (i.e. under `linux`, `openbsd`, etc) of the command exists. ## Command-line interface