From 0e9ab28600ab920ceb83db2edd4e90dbe206b7ab Mon Sep 17 00:00:00 2001 From: Michael Cho Date: Tue, 18 May 2021 13:57:16 -0700 Subject: [PATCH] docs: fix Cask Cookbook placeholders being discarded on docs.brew.sh --- docs/Cask-Cookbook.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Cask-Cookbook.md b/docs/Cask-Cookbook.md index 9b474b4046..47b5e4d37c 100644 --- a/docs/Cask-Cookbook.md +++ b/docs/Cask-Cookbook.md @@ -303,7 +303,7 @@ The [`find-appcast`](https://github.com/Homebrew/homebrew-cask/blob/HEAD/develop | key | value | | --------------- | ----------- | -| `must_contain:` | a custom string for `brew audit --appcast {{cask_file}}` to check against. | +| `must_contain:` | a custom string for `brew audit --appcast ` to check against. | Sometimes a `version` doesn’t match a string on the webpage, in which case we tweak what to search for. Example: if `version` is `6.26.1440` and the appcast’s contents only show `6.24`, the check for “is `version` in the appcast feed” will fail. With `must_contain`, the check is told to “look for this string instead of `version`”. In the example, `must_contain: version.major_minor` is saying “look for `6.24`”, making the check succeed. @@ -362,7 +362,7 @@ When `caveats` is a string, it is evaluated at compile time. The following metho | `version` | the Cask version | `homepage` | the Cask homepage | `caskroom_path` | the containing directory for all staged Casks, typically `/usr/local/Caskroom` (only available with block form) -| `staged_path` | the staged location for this Cask, including version number: `/usr/local/Caskroom/{{token}}/{{version}}` (only available with block form) +| `staged_path` | the staged location for this Cask, including version number: `/usr/local/Caskroom//` (only available with block form) Example: @@ -1142,21 +1142,21 @@ SourceForge and OSDN (formerly `SourceForge.JP`) projects are common ways to dis We prefer URLs of this format: ``` -https://downloads.sourceforge.net/{{project_name}}/{{filename}}.{{ext}} +https://downloads.sourceforge.net//. ``` Or, if it’s from [OSDN](https://osdn.jp/): ``` -http://{{subdomain}}.osdn.jp/{{project_name}}/{{release_id}}/{{filename}}.{{ext}} +http://.osdn.jp///. ``` -`{{subdomain}}` is typically of the form `dl` or `{{user}}.dl`. +`` is typically of the form `dl` or `.dl`. If these formats are not available, and the application is macOS-exclusive (otherwise a command-line download defaults to the Windows version) we prefer the use of this format: ``` -https://sourceforge.net/projects/{{project_name}}/files/latest/download +https://sourceforge.net/projects//files/latest/download ``` #### Some Providers Block Command-line Downloads