From e28c56a7600fe9916a72d92fc5244bc57ebf48c4 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Mon, 6 Dec 2021 13:07:33 -0500 Subject: [PATCH 1/4] CLIENT-SPECIFICATION: Add macos recommendation Signed-off-by: Matthew Peveler --- CLIENT-SPECIFICATION.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 73e92e399c4eb1..c73c51a4ee3663 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -85,7 +85,9 @@ The main version of every page is stored inside (but not directly) the `pages` d - `osx/` - ...etc. -Additional platforms MAY be added in the future. Clients MAY NOT support new platforms (though such support is RECOMMENDED), but MUST NOT break if additional platforms are added. +It is RECOMMENDED that client supports `macos` as an alias for `osx`. + +Additional platforms MAY be added in the future. Clients MAY NOT support new platforms (though such support is RECOMMENDED), but MUST NOT break if additional platforms are added. The pages themselves reside inside the appropriate platform folder, with the extension `.md`. Here are some example mappings: From c24a98eb34f9b0d00aa28f264f4cf4c133647079 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 16 Dec 2021 19:18:59 -0500 Subject: [PATCH 2/4] Update CLIENT-SPECIFICATION.md --- CLIENT-SPECIFICATION.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index c73c51a4ee3663..a45961d353d142 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -226,6 +226,9 @@ the form `vX.Y`) should be done immediately AFTER merging the version bump, as the commit hash changes when merging with squash or rebase. --> + - Unreleased + - Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514)) + - [v1.5, March 17th 2021](https://github.com/tldr-pages/tldr/blob/v1.5/CLIENT-SPECIFICATION.md) ([#5428](https://github.com/tldr-pages/tldr/pull/5428)) - Add requirement for converting command names to lowercase before running the page resolution algorithm. - Use HTTPS for archive links. From 702dae2e7415f10487fbf40fc27569c9ce3f8dcf Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Sun, 19 Dec 2021 17:42:26 +0000 Subject: [PATCH 3/4] Update CLIENT-SPECIFICATION.md --- CLIENT-SPECIFICATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index a45961d353d142..849c53f49b9337 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -85,7 +85,7 @@ The main version of every page is stored inside (but not directly) the `pages` d - `osx/` - ...etc. -It is RECOMMENDED that client supports `macos` as an alias for `osx`. +It is RECOMMENDED that clients support `macos` as an alias for `osx`. Additional platforms MAY be added in the future. Clients MAY NOT support new platforms (though such support is RECOMMENDED), but MUST NOT break if additional platforms are added. From c67f5aeeed3e75d931a6c674e0a2eaec037b87e3 Mon Sep 17 00:00:00 2001 From: Matthew Peveler Date: Thu, 6 Jan 2022 15:47:32 -0500 Subject: [PATCH 4/4] Update CLIENT-SPECIFICATION.md --- CLIENT-SPECIFICATION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 849c53f49b9337..7d1b0d11a80f10 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -87,7 +87,7 @@ The main version of every page is stored inside (but not directly) the `pages` d It is RECOMMENDED that clients support `macos` as an alias for `osx`. -Additional platforms MAY be added in the future. Clients MAY NOT support new platforms (though such support is RECOMMENDED), but MUST NOT break if additional platforms are added. +While clients do not need to support new platforms automatically (though such support is RECOMMENDED), they MUST NOT break if additional platforms are added to tldr-pages. The pages themselves reside inside the appropriate platform folder, with the extension `.md`. Here are some example mappings: