Skip to content

Commit 7be05ad

Browse files
authored
docs: move language reference to docs.brew.sh (Homebrew#104628)
* doc: move language reference to docs.brew.sh * doc: reference Cask Cookbook instead of language reference
1 parent a90f74e commit 7be05ad

36 files changed

+43
-1482
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ With a bit of work, you can create a Cask for it. The document [Adding A Cask](d
5151
Some style guidelines:
5252

5353
* All Casks and code should be indented using two spaces (never tabs). When `brew style` contradicts this, `style` must be followed.
54-
* There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the [Cask Language Reference](doc/cask_language_reference).
55-
* The stanza order and position of newlines is important to make things easier (See [Stanza order](doc/cask_language_reference/#stanza-order)).
56-
* Use string manipulations to improve the maintainability of your Cask (See [`version` methods](doc/cask_language_reference/stanzas/version.md#version-methods)).
54+
* There should not be any extraneous comments - the only comments that should be used are the ones explicitly defined in the [Cask Cookbook](https://docs.brew.sh/Cask-Cookbook.md).
55+
* The stanza order and position of newlines is important to make things easier (See [Stanza order](https://docs.brew.sh/Cask-Cookbook.md#stanza-order)).
56+
* Use string manipulations to improve the maintainability of your Cask (See [`version` methods](https://docs.brew.sh/Cask-Cookbook.md#version-methods)).
5757
* Test your cask using `brew audit/style` (See [testing](doc/development/adding_a_cask.md#testing-your-new-cask)).
5858
* Make one Pull Request per Cask change.
5959
* Do not squash commits after updating a Pull Request.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If the issue is still not solved, see the guides for common problems:
5757

5858
## Requests
5959

60-
* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#adding-a-cask).
60+
* Issues requesting new casks will be closed. If you want a cask added to the main repositories, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/HEAD/CONTRIBUTING.md#adding-a-cask).
6161
* For a feature request, [use this template](https://github.com/Homebrew/homebrew-cask/issues/new?template=02_feature_request.md).
6262

6363
## Questions? Wanna chat?

USAGE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ atom google-chrome 1password
9494

9595
With `--full-name` the Tap name will also be included, _e.g._: `purple/monkey/dishwasher` for the Cask `dishwasher` installed from the Tap `purple/monkey`.
9696

97-
Given an installed Cask, `brew list --casks {{cask_name}}` lists the staged files.
97+
Given an installed Cask, `brew list --casks <cask_name>` lists the staged files.
9898

9999
Show details about a specific Cask:
100100

@@ -155,7 +155,7 @@ $ brew install homebrew/cask-fonts/font-symbola
155155
* `--debug`: output debug information
156156
* `--no-binaries`: skip symlinking executable binaries into `/usr/local/bin`
157157
* `--require-sha`: abort installation of Cask if no checksum is defined
158-
* `--no-quarantine`: [disable Apple’s quarantining](https://github.com/Homebrew/homebrew-cask/blob/master/doc/faq/app_cant_be_opened.md) for the specific app
158+
* `--no-quarantine`: [disable Apple’s quarantining](https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/faq/app_cant_be_opened.md) for the specific app
159159
* `--language=<iso-language>[,<iso-language> ... ]`: changes the language of the Cask to be installed. The first matching language is used, otherwise it uses the default language of the Cask.
160160

161161
You can also modify the default installation locations used when issuing `brew install`:

doc/cask_language_reference/all_stanzas.md

-62
This file was deleted.

doc/cask_language_reference/readme.md

-175
This file was deleted.

0 commit comments

Comments
 (0)