206 Commits

Author SHA1 Message Date
Kevin
653f333d73
Revert "service: support multiple sockets in DSL" 2023-09-28 09:58:03 -07:00
Mike McQuaid
9359f95b64
Merge pull request #16026 from apainintheneck/support-multiple-sockets-in-service-dsl
service: support multiple sockets in DSL
2023-09-28 12:41:08 +01:00
apainintheneck
5fb9f90457 service: prefer symbols over strings in DSL
This is more in keeping with the other DSL methods and Ruby
convention along with the fact that these socket names are
just used internally by launchd.
2023-09-27 22:30:30 -07:00
Patrick Linnane
3bd4050a6f
docs: update commit style guidelines 2023-09-25 08:55:16 -07:00
apainintheneck
ddfa723f77 Update service socket docs 2023-09-24 12:04:55 -07:00
Eric Knibbe
43c8fec557
docs: mark console output appropriately 2023-09-11 02:26:37 -04:00
Eric Knibbe
931f762598
docs+rubydoc: various grammar/wording fixes 2023-09-11 02:26:37 -04:00
Eric Knibbe
484efe2911
docs: various additions & changes 2023-09-05 01:06:31 -04:00
Eric Knibbe
7718c5ad61
docs: improve links & formatting 2023-09-05 00:54:26 -04:00
Issy Long
7f3a4fe667
Fix link to Ruby's FileUtils documentation in the Formula Cookbook 2023-09-01 01:01:58 +01:00
Amy Grace
edf022d94e
docs: update formula and cask URLs to new sharded format 2023-08-26 14:54:19 +01:00
Eric Knibbe
569c833924
Formula-Cookbook: expand terminology table 2023-08-12 21:48:16 -04:00
Eric Knibbe
0f4b0028b5
Formula-Cookbook: expand environment var section 2023-08-08 08:22:59 -04:00
Eric Knibbe
2b8c37b04e
Formula-Cookbook: revise download strategy docs 2023-08-07 15:30:11 -04:00
Eric Knibbe
b6c49b7a2d
docs: assume core repositories are untapped 2023-07-24 09:55:56 -04:00
Patrick Linnane
c56669e9cd
various: fix miscellaneous typos 2023-07-18 08:52:49 -07:00
Kevin
946478aed4
Merge pull request #15396 from apainintheneck/custom-service-name
Custom service name
2023-05-17 22:09:31 -07:00
apainintheneck
f2adbf6613 service: change custom name DSL
After some discussion, we decided to change the DSL to get rid of
the `plist_name` and `service_name` methods which aren't meaningful
for most users.

The new DSL looks like this:

```rb
service do
  name macos: "name", linux: "name"
end
```

I also updated some specs here to reflect these changes.

There was some talk about maybe deprecating `plist_name` and `service_name`
but I think that's outside of the scope of this PR so I'm leaving
them as is for now. One benefit of this is that everything here is backwards
compatible.
2023-05-17 21:54:32 -07:00
apainintheneck
41c7eb7078 formula-cookbook: update service docs
Add more info about the `run` method.
- Adds array example
- Adds OS specific example
2023-05-13 23:41:18 -07:00
apainintheneck
ed24ef4860 docs/formula-cookbook: update service docs 2023-05-13 14:53:02 -07:00
apainintheneck
70451ea7b1 Add cop to stop bin in service block
The preferred method is opt_bin because that works
with the API and is more portable (works between versions).

Also removed the last example from the docs of `bin/"name"`
from the service block section
2023-04-04 20:00:30 -07:00
Shane Smith
6782adfe4c
Remove extra space 2023-03-15 10:21:11 -04:00
Shane Smith
d8f7e633f2
Fix keep_alive sample code in formula cookbook 2023-03-09 15:28:00 -05:00
Mike McQuaid
c209c0403d
Fix references to formula.json and cask.json
These would be stranded after `formula.jws.json`.
2023-02-24 16:46:15 +00:00
Jacob Ford
a591cad985
Formula-Cookbook: generalize locations
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2023-02-21 15:27:44 -05:00
Jacob Ford
926cba3e16
Formula-Cookbook: suggested edits from @MikeMcQuaid
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-02-21 13:32:38 -05:00
Jacob Ford
c70ce7a4bf Formula-Cookbook: correct HOMEBREW_NO_INSTALL_FROM_API value 2023-02-21 00:03:00 -05:00
Jacob Ford
44a43f1a46 Formulae-Cookbook: update for Homebrew v4 2023-02-20 19:52:38 -05:00
Issy Long
a640c50a04
docs/Formula-Cookbook: Fix markdownlint "multiple blank lines" 2023-02-04 15:38:50 +01:00
Patrick Linnane
8f01281f3d
Update docs/Formula-Cookbook.md
Co-authored-by: Issy Long <issyl0@github.com>
2023-02-04 15:21:16 +01:00
Patrick Linnane
05949443eb
Update docs/Formula-Cookbook.md
Co-authored-by: Issy Long <issyl0@github.com>
2023-02-04 15:21:09 +01:00
Patrick Linnane
225909bb58
Update docs/Formula-Cookbook.md
Co-authored-by: Issy Long <issyl0@github.com>
2023-02-04 15:20:55 +01:00
Patrick Linnane
5ae18ce357
docs: Clarify dependency values 2023-02-04 14:43:32 +01:00
EricFromCanada
42e91e8668
docs: add Table of Contents to selected pages 2022-12-30 00:45:30 -05:00
EricFromCanada
9cc4766d33
docs: hyperlink updates
plus some reformatting
2022-12-06 12:52:03 -05:00
EricFromCanada
d6d16969c6
Formula-Cookbook: content & formatting updates 2022-11-11 16:07:11 -05:00
EricFromCanada
69f3ce6ec1
Formula-Cookbook: add/move/reorder sections 2022-11-11 16:07:11 -05:00
EricFromCanada
9c22c47e4f
Cookbooks: adjust line breaks 2022-11-11 15:49:53 -05:00
Rylan Polster
78bf62ee5d
Apply suggestions from code review
Co-authored-by: Adrian Ho <the.gromgit@gmail.com>
2022-08-04 10:15:00 -04:00
Rylan Polster
9176d65054
Clarifications 2022-08-03 20:38:23 -04:00
Rylan Polster
6a93c5d53d
Add on_{system} methods to formula cookbook 2022-08-03 20:33:49 -04:00
Adrian Ho
751aa12f84 Formula-Cookbook.md: added missing dirs 2022-06-19 08:42:17 +08:00
danielbayley
38d6e36d47 Fix #13367 2022-06-04 15:15:23 +01:00
danielbayley
9f11c81dbe Document zsh_function 2022-06-04 10:40:17 +01:00
Sean Molenaar
3d5d12e8b9
service: add sockets and keepalive variants 2022-04-12 12:17:27 +02:00
Sean Molenaar
1d742d243b
Update docs/Formula-Cookbook.md
Co-authored-by: Nanda H Krishna <me@nandahkrishna.com>
2022-02-18 18:10:06 +01:00
Sean Molenaar
9c5c0d1afe
docs: document service block 2022-02-15 20:01:14 +01:00
Carlo Marcelo Arenas Belón
e567d7f595
Update Formula-Cookbook.md gsub! example
The use of a naked expression will trigger errors from `brew audit` so use instead parenthesis around the parameters as per its recommendation and to avoid ambiguous syntax.
2021-10-19 13:20:16 -07:00
XuehaiPan
3f96d963f7 style: fix inconsistent code style for shell scripts 2021-09-15 14:59:01 +08:00
FnControlOption
999a3c66f9 docs: use brew --repository shorthand in Cask Cookbook 2021-09-01 05:59:26 -07:00