language stringclasses 1
value | owner stringlengths 2 15 | repo stringlengths 2 21 | sha stringlengths 45 45 | message stringlengths 7 36.3k | path stringlengths 1 199 | patch stringlengths 15 102k | is_multipart bool 2
classes |
|---|---|---|---|---|---|---|---|
Other | Homebrew | brew | 51ca60d6d5faf97f74774ee8366785a6a8d1e168.json | add formula cleanup to install and reinstall | Library/Homebrew/cmd/install.rb | @@ -73,6 +73,9 @@
#:
#: If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
#: creating patches to the software.
+#:
+#: If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
+#: of upgraded <formulae>.
require "missing_formula"
require "formula_... | true |
Other | Homebrew | brew | 51ca60d6d5faf97f74774ee8366785a6a8d1e168.json | add formula cleanup to install and reinstall | Library/Homebrew/cmd/reinstall.rb | @@ -3,6 +3,9 @@
#:
#: If `--display-times` is passed, install times for each formula are printed
#: at the end of the run.
+#:
+#: If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
+#: of upgraded <formulae>.
require "formula_installer"
require "development_tools"
@@ -24,... | true |
Other | Homebrew | brew | 51ca60d6d5faf97f74774ee8366785a6a8d1e168.json | add formula cleanup to install and reinstall | Library/Homebrew/cmd/upgrade.rb | @@ -3,7 +3,7 @@
#:
#: Options for the `install` command are also valid here.
#:
-#: If `--cleanup` is specified, `HOMEBREW_INSTALL_CLEANUP` or `HOMEBREW_UPGRADE_CLEANUP` is set then remove
+#: If `--cleanup` is specified or `HOMEBREW_INSTALL_CLEANUP` is set then remove
#: previously installed version(s)... | true |
Other | Homebrew | brew | 51ca60d6d5faf97f74774ee8366785a6a8d1e168.json | add formula cleanup to install and reinstall | Library/Homebrew/test/cmd/upgrade_spec.rb | @@ -17,17 +17,4 @@
expect(HOMEBREW_CELLAR/"testball/0.1").to be_a_directory
expect(HOMEBREW_CELLAR/"testball/0.0.1").not_to exist
end
-
- it "upgrades a Formula and cleans up old versions when `HOMEBREW_INSTALL_CLEANUP` is set" do
- setup_test_formula "testball"
- # allow(ENV).to receive(:[]).and_ca... | true |
Other | Homebrew | brew | 51ca60d6d5faf97f74774ee8366785a6a8d1e168.json | add formula cleanup to install and reinstall | docs/Manpage.md | @@ -1243,11 +1243,10 @@ Note that environment variables must have a value set to be detected. For exampl
This issue typically occurs when using FileVault or custom SSD
configurations.
- * `HOMEBREW_UPGRADE_CLEANUP`:
- If set, `brew upgrade` always assumes `--cleanup` has been passed.
-
* `HOMEBREW_IN... | true |
Other | Homebrew | brew | 7380ebf85b8dc9564ab12194ce0149498559bd48.json | diy: add meson support
Also print the path to put files into if no build system was
determined. | Library/Homebrew/cmd/diy.rb | @@ -25,8 +25,10 @@ def diy
puts "-DCMAKE_INSTALL_PREFIX=#{prefix}"
elsif File.file? "configure"
puts "--prefix=#{prefix}"
+ elsif File.file? "meson.build"
+ puts "-Dprefix=#{prefix}"
else
- raise "Couldn't determine build system"
+ raise "Couldn't determine build system. You ca... | false |
Other | Homebrew | brew | 8e092d0ae038f0af2a12c51d0fce58742c7516f3.json | README: add Jason Tedor.
Welcome! | README.md | @@ -44,7 +44,7 @@ Homebrew/brew's other current maintainers are [Claudia](https://github.com/claui
Homebrew/brew's Linux support (and Linuxbrew) maintainers are [Michka Popoff](https://github.com/imichka) and [Shaun Jackman](https://github.com/sjackman).
-Homebrew/homebrew-core's other current maintainers are [Cla... | true |
Other | Homebrew | brew | 8e092d0ae038f0af2a12c51d0fce58742c7516f3.json | README: add Jason Tedor.
Welcome! | docs/Manpage.md | @@ -1315,7 +1315,7 @@ Homebrew/brew's other current maintainers are Claudia, Michka Popoff, Shaun Jack
Homebrew/brew's Linux support (and Linuxbrew) maintainers are Michka Popoff and Shaun Jackman.
-Homebrew/homebrew-core's other current maintainers are Claudia, Michka Popoff, Shaun Jackman, Chongyu Zhu, commitay,... | true |
Other | Homebrew | brew | 8e092d0ae038f0af2a12c51d0fce58742c7516f3.json | README: add Jason Tedor.
Welcome! | manpages/brew.1 | @@ -1462,7 +1462,7 @@ Homebrew/brew\'s other current maintainers are Claudia, Michka Popoff, Shaun Jac
Homebrew/brew\'s Linux support (and Linuxbrew) maintainers are Michka Popoff and Shaun Jackman\.
.
.P
-Homebrew/homebrew\-core\'s other current maintainers are Claudia, Michka Popoff, Shaun Jackman, Chongyu Zhu, co... | true |
Other | Homebrew | brew | b30ab67ca68155586620f55d1ee562fbf4cffacf.json | unpack_strategy: fix extension for compress | Library/Homebrew/unpack_strategy/compress.rb | @@ -5,7 +5,7 @@ class Compress < Tar
using Magic
def self.extensions
- [".compress"]
+ [".Z"]
end
def self.can_extract?(path) | false |
Other | Homebrew | brew | 9e4fb40f92ed2acadc82909cc3bc4b2d66467c2d.json | docs: update descriptions of git- and curl-related vars
Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable. | Library/Homebrew/manpages/brew.1.md.erb | @@ -10,7 +10,7 @@
# When done, regenerate the man page and its HTML version by running `brew man`.
%>
brew(1) -- The missing package manager for macOS
-===============================================
+================================================
## SYNOPSIS
@@ -105,6 +105,7 @@ can take several different for... | true |
Other | Homebrew | brew | 9e4fb40f92ed2acadc82909cc3bc4b2d66467c2d.json | docs: update descriptions of git- and curl-related vars
Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable. | Library/Homebrew/shims/scm/git | @@ -1,6 +1,6 @@
#!/bin/bash
-# This script because we support $GIT, $HOMEBREW_SVN, etc., Xcode-only and
+# This script because we support $HOMEBREW_GIT, $HOMEBREW_SVN, etc., Xcode-only and
# no Xcode/CLT configurations. Order is careful to be what the user would want.
set +o posix | true |
Other | Homebrew | brew | 9e4fb40f92ed2acadc82909cc3bc4b2d66467c2d.json | docs: update descriptions of git- and curl-related vars
Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable. | docs/Manpage.md | @@ -1,5 +1,5 @@
brew(1) -- The missing package manager for macOS
-===============================================
+================================================
## SYNOPSIS
@@ -1100,6 +1100,7 @@ can take several different forms:
The formula file will be cached for later use.
## ENVIRONMENT
+
Note that... | true |
Other | Homebrew | brew | 9e4fb40f92ed2acadc82909cc3bc4b2d66467c2d.json | docs: update descriptions of git- and curl-related vars
Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable. | manpages/brew.1 | @@ -1297,22 +1297,15 @@ If set, Homebrew will use this editor when editing a single formula, or several
.
.TP
\fBHOMEBREW_FORCE_BREWED_CURL\fR
-If set, Homebrew will use a Homebrew\-installed \fBcurl\fR rather than the system version\.
+If set, Homebrew will always use a Homebrew\-installed \fBcurl\fR rather than th... | true |
Other | Homebrew | brew | f7ec07680ccf859fd331d3fe7195afc366fc3741.json | cli_parser: Add support for short flag options | Library/Homebrew/cli_parser.rb | @@ -76,20 +76,24 @@ def comma_array(name, description: nil)
end
end
- def flag(name, description: nil, required_for: nil, depends_on: nil)
- if name.end_with? "="
+ def flag(*names, description: nil, required_for: nil, depends_on: nil)
+ if names.any? { |name| name.end_with? "=... | true |
Other | Homebrew | brew | f7ec07680ccf859fd331d3fe7195afc366fc3741.json | cli_parser: Add support for short flag options | Library/Homebrew/test/cli_parser_spec.rb | @@ -76,6 +76,20 @@
end
end
+ describe "test short flag options" do
+ subject(:parser) {
+ described_class.new do
+ flag "-f", "--filename=", description: "Name of the file"
+ end
+ }
+
+ it "parses a short flag option with its argument" do
+ parser.parse(["--filename=random.txt... | true |
Other | Homebrew | brew | b0198d097e115d304d1169709c6029fa24e0f2fa.json | os/mac/utils/bottles: handle Linux bottles.
These are an invalid argument on macOS but still need to be handled. | Library/Homebrew/compat.rb | @@ -1,3 +1,4 @@
+require "compat/extend/os/mac/utils/bottles"
require "compat/requirements/x11_requirement"
require "compat/requirements/xcode_requirement"
require "compat/cask" | true |
Other | Homebrew | brew | b0198d097e115d304d1169709c6029fa24e0f2fa.json | os/mac/utils/bottles: handle Linux bottles.
These are an invalid argument on macOS but still need to be handled. | Library/Homebrew/compat/extend/os/mac/utils/bottles.rb | @@ -0,0 +1,19 @@
+module Utils
+ class Bottles
+ class Collector
+ module Compat
+ private
+
+ def tag_without_or_later(tag)
+ return super unless tag.to_s.end_with?("_or_later")
+
+ odeprecated "`or_later` bottles",
+ "bottles without `or_later` (or_later i... | true |
Other | Homebrew | brew | b0198d097e115d304d1169709c6029fa24e0f2fa.json | os/mac/utils/bottles: handle Linux bottles.
These are an invalid argument on macOS but still need to be handled. | Library/Homebrew/extend/os/mac/utils/bottles.rb | @@ -42,6 +42,10 @@ def find_altivec_tag(tag)
altivec_tag if key?(altivec_tag)
end
+ def tag_without_or_later(tag)
+ tag
+ end
+
# Find a bottle built for a previous version of macOS.
def find_older_compatible_tag(tag)
begin
@@ -51,13 +55,12 @@ def find_older_com... | true |
Other | Homebrew | brew | 462439ea1d3140b2b6a6adc5531dc3dd71d4b96c.json | README: use Azure Pipelines badge. | README.md | @@ -19,7 +19,7 @@ Second, read the [Troubleshooting Checklist](https://docs.brew.sh/Troubleshootin
**If you don't read these it will take us far longer to help you with your problem.**
## Contributing
-[](https://travis-ci.org/Homebrew/brew)
+[![Azure Pipeli... | false |
Other | Homebrew | brew | 44578adfdb3e780579381407e0a88677fa0eaa8c.json | audit: use debian canonical mirror | Library/Homebrew/rubocops/urls_cop.rb | @@ -43,6 +43,7 @@ def audit_formula(_node, _class_node, _parent_class_node, body_node)
%r{^http://code\.google\.com/},
%r{^http://fossies\.org/},
%r{^http://mirrors\.kern... | true |
Other | Homebrew | brew | 44578adfdb3e780579381407e0a88677fa0eaa8c.json | audit: use debian canonical mirror | Library/Homebrew/test/rubocops/urls_cop_spec.rb | @@ -76,9 +76,33 @@
"msg" => <<~EOS,
Please use a secure mirror for Debian URLs.
We recommend:
- https://mirrors.ocf.berkeley.edu/debian/dists/foo/
+ https://deb.debian.org/debian/dists/foo/
EOS
"col" => 2,
+ }, {
+ "url" => "https://mirr... | true |
Other | Homebrew | brew | 5e68a0872e0540adacd4d5ff2a988113eba045d2.json | audit: remove heroku formula.
This was removed in https://github.com/Homebrew/homebrew-core/pull/33233. | Library/Homebrew/dev-cmd/audit.rb | @@ -684,7 +684,6 @@ def audit_specs
throttled = %w[
aws-sdk-cpp 10
awscli 10
- heroku 10
quicktype 10
vim 50
] | false |
Other | Homebrew | brew | bd3bc09720c0adc764b7082622cdedc933d0d28e.json | restore sh test | Library/Homebrew/test/utils/shell_spec.rb | @@ -7,6 +7,11 @@
expect(subject.profile).to eq("~/.bash_profile")
end
+ it "returns ~/.bash_profile by default" do
+ ENV["SHELL"] = "/bin/sh"
+ expect(subject.profile).to eq("~/.bash_profile")
+ end
+
it "returns ~/.bash_profile for Bash" do
ENV["SHELL"] = "/bin/bash"
ex... | false |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/audit.rb | @@ -53,7 +53,7 @@ module Homebrew
def audit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `audit` [<options>] <formulae>:
+ `audit` [<options>] <formulae>
Check <formulae> for Homebrew coding style violations. This should be run before
submitting a new formula.... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/bottle.rb | @@ -72,7 +72,7 @@ module Homebrew
def bottle_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `bottle` [<options>] <formulae>:
+ `bottle` [<options>] <formulae>
Generate a bottle (binary package) from a formula that was installed with
`--build-bottle`. | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/bump-formula-pr.rb | @@ -50,7 +50,7 @@ module Homebrew
def bump_formula_pr_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `bump-formula-pr` [<options>] [<formula>]:
+ `bump-formula-pr` [<options>] [<formula>]
Create a pull request to update a formula with a new URL or a new tag.
| true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/create.rb | @@ -30,7 +30,7 @@ module Homebrew
def create_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `create` [<options>] <URL>:
+ `create` [<options>] <URL>
Generate a formula for the downloadable file at <URL> and open it in the editor.
Homebrew will attempt to automat... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/edit.rb | @@ -13,7 +13,7 @@ module Homebrew
def edit_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `edit` [<formulae>]:
+ `edit` [<formulae>]
Open a formula in the editor set by `EDITOR` or `HOMEBREW_EDITOR`, or open the
Homebrew repository for editing if no <formula> is... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/extract.rb | @@ -99,7 +99,7 @@ module Homebrew
def extract_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `extract` [<options>] <formula> <tap>:
+ `extract` [<options>] <formula> <tap>
Look through repository history to find the most recent version of <formula> and
create a ... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/formula.rb | @@ -10,7 +10,7 @@ module Homebrew
def formula_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `formula` <formulae>:
+ `formula` <formulae>
Display the path where a formula is located.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/irb.rb | @@ -26,7 +26,7 @@ module Homebrew
def irb_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `irb` [<options>]:
+ `irb` [<options>]
Enter the interactive Homebrew Ruby shell.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/linkage.rb | @@ -20,7 +20,7 @@ module Homebrew
def linkage_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `linkage` [<options>] [<formulae>]:
+ `linkage` [<options>] [<formulae>]
Check the library links for kegs of installed formulae.
Raises an error if run on uninstalled fo... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/man.rb | @@ -40,7 +40,7 @@ module Homebrew
def man_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `man` [<options>]:
+ `man` [<options>]
Generate Homebrew's manpages.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/mirror.rb | @@ -10,7 +10,7 @@ module Homebrew
def mirror_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `mirror` <formulae>:
+ `mirror` <formulae>
Reuploads the stable URL for a formula to Bintray to use it as a mirror.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/prof.rb | @@ -9,7 +9,7 @@ module Homebrew
def prof_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `prof` [<ruby options>]:
+ `prof` [<ruby options>]
Run Homebrew with the Ruby profiler.
| true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/pull.rb | @@ -74,7 +74,7 @@ module Homebrew
def pull_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `pull` [<options>] <patch sources>:
+ `pull` [<options>] <patch sources>
Get a patch from a GitHub commit or pull request and apply it to Homebrew.
Optionally, publish upda... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/release-notes.rb | @@ -13,7 +13,7 @@ module Homebrew
def release_notes_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `release-notes` [<options>] [<previous_tag>] [<end_ref>]:
+ `release-notes` [<options>] [<previous_tag>] [<end_ref>]
Print the merged pull requests on Homebrew/brew between... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/ruby.rb | @@ -11,7 +11,7 @@ module Homebrew
def ruby_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `ruby` [<ruby options>]:
+ `ruby` [<ruby options>]
Run a Ruby instance with Homebrew's libraries loaded.
| true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/tap-new.rb | @@ -10,7 +10,7 @@ module Homebrew
def tap_new_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `tap-new` <user>`/`<repo>:
+ `tap-new` <user>`/`<repo>
Generate the template files for a new tap.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/test.rb | @@ -25,7 +25,7 @@ module Homebrew
def test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `test` [<options>] <formulae>:
+ `test` [<options>] <formulae>
Run the test method provided by an installed formula.
There is no standard output or return code, but general... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/tests.rb | @@ -24,7 +24,7 @@ module Homebrew
def tests_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `tests` [<options>]:
+ `tests` [<options>]
Run Homebrew's unit and integration tests.
EOS | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | Library/Homebrew/dev-cmd/update-test.rb | @@ -22,7 +22,7 @@ module Homebrew
def update_test_args
Homebrew::CLI::Parser.new do
usage_banner <<~EOS
- `update-test` [<options>]:
+ `update-test` [<options>]
Run a test of `brew update` with a new repository clone.
If no arguments are passed, use `origin/master` as th... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | docs/Manpage.md | @@ -663,199 +663,201 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
## DEVELOPER COMMANDS
-### `audit` [*`options`*] *`formulae`*:
+### `audit` [*`options`*] *`formulae`*
-Check *`formulae`* for Homebrew coding style violations. This should be
-run before submitting a new form... | true |
Other | Homebrew | brew | 388781f6a74d353d1a69b836217e859ac3f9bb30.json | dev-cmd/: remove colons from command specs.
These aren't needed when converting Parser-based help text to man page or Markdown formats.
Includes regenerated docs. | manpages/brew.1 | @@ -676,12 +676,12 @@ Print the version number of Homebrew to standard output and exit\.
.
.SH "DEVELOPER COMMANDS"
.
-.SS "\fBaudit\fR [\fIoptions\fR] \fIformulae\fR:"
-Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. If no \fIformulae\fR are provided,... | true |
Other | Homebrew | brew | 599ecc9b5ad7951b8ddc51490ebe93a976d43b29.json | Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae. | Library/Homebrew/compat.rb | @@ -1,6 +1,7 @@
require "compat/os/mac"
require "compat/dependable"
require "compat/dependency_collector"
+require "compat/download_strategy"
require "compat/fileutils"
require "compat/formula_support"
require "compat/cask" | true |
Other | Homebrew | brew | 599ecc9b5ad7951b8ddc51490ebe93a976d43b29.json | Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae. | Library/Homebrew/compat/download_strategy.rb | @@ -0,0 +1,254 @@
+require "download_strategy"
+
+# S3DownloadStrategy downloads tarballs from AWS S3.
+# To use it, add `:using => :s3` to the URL section of your
+# formula. This download strategy uses AWS access tokens (in the
+# environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`)
+# to sign the ... | true |
Other | Homebrew | brew | 599ecc9b5ad7951b8ddc51490ebe93a976d43b29.json | Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae. | Library/Homebrew/download_strategy.rb | @@ -474,191 +474,6 @@ def initialize(path)
end
end
-# S3DownloadStrategy downloads tarballs from AWS S3.
-# To use it, add `:using => :s3` to the URL section of your
-# formula. This download strategy uses AWS access tokens (in the
-# environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`)
-# to s... | true |
Other | Homebrew | brew | 599ecc9b5ad7951b8ddc51490ebe93a976d43b29.json | Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae. | Library/Homebrew/test/download_strategies_spec.rb | @@ -46,8 +46,8 @@
end
end
-describe GitHubPrivateRepositoryDownloadStrategy do
- subject { described_class.new(url, "foo", version) }
+describe "GitHubPrivateRepositoryDownloadStrategy", :needs_compat do
+ subject { GitHubPrivateRepositoryDownloadStrategy.new(url, "foo", version) }
let(:url) { "https://git... | true |
Other | Homebrew | brew | 599ecc9b5ad7951b8ddc51490ebe93a976d43b29.json | Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae. | docs/Formula-Cookbook.md | @@ -546,7 +546,7 @@ class Python3 < Formula
head "https://hg.python.org/cpython", :using => :hg
```
-Homebrew offers both anonymous and authenticated download strategies.
+Homebrew offers anonymous download strategies.
| `:using` value | download strategy |
|----------------|----------------------... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | .yardopts | @@ -7,7 +7,4 @@
--exclude Library/Homebrew/compat/
Library/Homebrew/**/*.rb
-
-share/doc/homebrew/*.html
-Library/Homebrew/*.md
-share/doc/homebrew/*.md
*.md | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cache_store.rb | @@ -2,7 +2,7 @@
#
# `CacheStoreDatabase` acts as an interface to a persistent storage mechanism
-# residing in the `HOMEBREW_CACHE`
+# residing in the `HOMEBREW_CACHE`.
#
class CacheStoreDatabase
# Yields the cache store database.
@@ -107,7 +107,7 @@ def cache_path
#
# `CacheStore` provides methods to muta... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cask/cmd/doctor.rb | @@ -42,7 +42,7 @@ def check_software_versions
end
# This could be done by calling into Homebrew, but the situation
- # where "doctor" is needed is precisely the situation where such
+ # where `brew doctor` is needed is precisely the situation where such
# things are less dependable.
... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cask/installer.rb | @@ -221,9 +221,9 @@ def install_artifacts
end
end
- # TODO: move dependencies to a separate class
- # dependencies should also apply for "brew cask stage"
- # override dependencies with --force or perhaps --force-deps
+ # TODO: move dependencies to a separate class,
+ # de... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cleaner.rb | @@ -1,8 +1,9 @@
# Cleans a newly installed keg.
# By default:
-# * removes .la files
-# * removes perllocal.pod files
-# * removes .packlist files
+#
+# * removes `.la` files
+# * removes `perllocal.pod` files
+# * removes `.packlist` files
# * removes empty directories
# * sets permissions on executables
# * remo... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cmd/upgrade.rb | @@ -91,8 +91,8 @@ def upgrade
def upgrade_formulae(formulae_to_install)
return if formulae_to_install.empty?
- # Sort keg_only before non-keg_only formulae to avoid any needless conflicts
- # with outdated, non-keg_only versions of formulae being upgraded.
+ # Sort keg-only before non-keg-only formul... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/config.rb | @@ -2,13 +2,13 @@
raise "HOMEBREW_BREW_FILE was not exported! Please call bin/brew directly!"
end
-# Path to `bin/brew` main executable in HOMEBREW_PREFIX
+# Path to `bin/brew` main executable in `HOMEBREW_PREFIX`
HOMEBREW_BREW_FILE = Pathname.new(ENV["HOMEBREW_BREW_FILE"])
# Where we link under
HOMEBREW_PRE... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/cxxstdlib.rb | @@ -40,10 +40,10 @@ def initialize(type, compiler)
@compiler = compiler.to_sym
end
- # If either package doesn't use C++, all is well
- # libstdc++ and libc++ aren't ever intercompatible
+ # If either package doesn't use C++, all is well.
+ # libstdc++ and libc++ aren't ever intercompatible.
# libstdc+... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/dependable.rb | @@ -1,7 +1,7 @@
require "options"
module Dependable
- # :run and :linked are no longer used but keep them here to avoid them being
+ # `:run` and `:linked` are no longer used but keep them here to avoid them being
# misused in future.
RESERVED_TAGS = [:build, :optional, :recommended, :run, :test, :linked].f... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/dependency.rb | @@ -71,7 +71,7 @@ def self._load(marshaled)
class << self
# Expand the dependencies of dependent recursively, optionally yielding
- # [dependent, dep] pairs to allow callers to apply arbitrary filters to
+ # `[dependent, dep]` pairs to allow callers to apply arbitrary filters to
# the list.
# ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/description_cache_store.rb | @@ -4,24 +4,24 @@
#
# `DescriptionCacheStore` provides methods to fetch and mutate linkage-specific data used
-# by the `brew linkage` command
+# by the `brew linkage` command.
#
class DescriptionCacheStore < CacheStore
include Searchable
# Inserts a formula description into the cache if it does not exist... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/dev-cmd/pull.rb | @@ -453,9 +453,9 @@ def files_changed_in_patch(patchfile, tap)
{ files: files, formulae: formulae, others: others }
end
- # Get current formula versions without loading formula definition in this process
- # Returns info as a hash (type => version), for pull.rb's internal use
- # Uses special key :nonexist... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/diagnostic.rb | @@ -59,8 +59,8 @@ def get_mounts(path = nil)
class Checks
############# HELPERS
- # Finds files in HOMEBREW_PREFIX *and* /usr/local.
- # Specify paths relative to a prefix eg. "include/foo.h".
+ # Finds files in `HOMEBREW_PREFIX` *and* /usr/local.
+ # Specify paths relative to a prefix... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/download_strategy.rb | @@ -72,8 +72,8 @@ def chdir
end
private :chdir
- # @!attribute [r]
- # return most recent modified time for all files in the current working directory after stage.
+ # @!attribute [r] source_modified_time
+ # Returns the most recent modified time for all files in the current working directory after stage.
... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/exceptions.rb | @@ -436,9 +436,9 @@ def dump
end
end
-# raised by FormulaInstaller.check_dependencies_bottled and
-# FormulaInstaller.install if the formula or its dependencies are not bottled
-# and are being installed on a system without necessary build tools
+# Raised by {FormulaInstaller#check_dependencies_bottled} and
+# {F... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/extend/ARGV.rb | @@ -243,7 +243,7 @@ def fetch_head?
include? "--fetch-HEAD"
end
- # eg. `foo -ns -i --bar` has three switches, n, s and i
+ # e.g. `foo -ns -i --bar` has three switches: `n`, `s` and `i`
def switch?(char)
return false if char.length > 1
| true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/extend/ENV/shared.rb | @@ -88,11 +88,11 @@ def append_path(key, path)
# Prepends a directory to `PATH`.
# Is the formula struggling to find the pkgconfig file? Point it to it.
- # This is done automatically for `keg_only` formulae.
+ # This is done automatically for keg-only formulae.
# <pre>ENV.prepend_path "PKG_CONFIG_PATH", "... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/extend/os/mac/hardware/cpu.rb | @@ -94,7 +94,7 @@ def universal_archs
# Determines whether the current CPU and macOS combination
# can run an executable of the specified architecture.
# `arch` is a symbol in the same format returned by
- # Hardware::CPU.family
+ # {Hardware::CPU.family}.
def can_run?(arch)
... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/extend/pathname.rb | @@ -145,7 +145,7 @@ def install_symlink_p(src, new_basename)
# @private
alias old_write write
- # we assume this pathname object is a file obviously
+ # We assume this pathname object is a file, obviously
def write(content, *open_args)
raise "Will not overwrite #{self}" if exist?
@@ -196,7 +196,7 @@... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/extend/string.rb | @@ -18,7 +18,7 @@ class NilClass
def chuzzle; end
end
-# used by the inreplace function (in utils.rb)
+# Used by the inreplace function (in `utils.rb`).
module StringInreplaceExtension
attr_accessor :errors
| true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/formula.rb | @@ -29,8 +29,8 @@
# Make sure you check with `brew search` that the name is free!
# @abstract
# @see SharedEnvExtension
-# @see FileUtils
# @see Pathname
+# @see https://www.rubydoc.info/stdlib/fileutils FileUtils
# @see https://docs.brew.sh/Formula-Cookbook Formula Cookbook
# @see https://github.com/styleguide/r... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/formula_support.rb | @@ -1,4 +1,4 @@
-# Used to track formulae that cannot be installed at the same time
+# Used to track formulae that cannot be installed at the same time.
FormulaConflict = Struct.new(:name, :reason)
# Used to annotate formulae that duplicate macOS provided software
@@ -39,7 +39,7 @@ def to_s
end
end
-# Used to... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/formulary.rb | @@ -1,7 +1,7 @@
require "digest/md5"
require "extend/cachable"
-# The Formulary is responsible for creating instances of Formula.
+# The Formulary is responsible for creating instances of {Formula}.
# It is not meant to be used directly from formulae.
module Formulary
@@ -175,15 +175,15 @@ def initialize(alias_... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/global.rb | @@ -51,7 +51,7 @@
"(KHTML, like Gecko) Version/10.0.3 Safari/602.4.8".freeze
# Bintray fallback is here for people auto-updating from a version where
-# HOMEBREW_BOTTLE_DEFAULT_DOMAIN isn't set.
+# `HOMEBREW_BOTTLE_DEFAULT_DOMAIN` isn't set.
HOMEBREW_BOTTLE_DEFAULT_DOMAIN = if ENV["HOMEBREW_BOTTLE_DEFAULT_DOMAIN... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/keg.rb | @@ -111,9 +111,8 @@ def to_s
].freeze
# Given an array of kegs, this method will try to find some other kegs
- # that depend on them.
+ # that depend on them. If it does, it returns:
#
- # If it does, it returns:
# - some kegs in the passed array that have installed dependents
# - some installed dep... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/language/python.rb | @@ -94,7 +94,7 @@ def self.included(base)
end
# Instantiates, creates, and yields a {Virtualenv} object for use from
- # Formula#install, which provides helper methods for instantiating and
+ # {Formula#install}, which provides helper methods for instantiating and
# installing packages ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/linkage_cache_store.rb | @@ -3,11 +3,11 @@
#
# `LinkageCacheStore` provides methods to fetch and mutate linkage-specific data used
-# by the `brew linkage` command
+# by the `brew linkage` command.
#
class LinkageCacheStore < CacheStore
- # @param [String] keg_path
- # @param [CacheStoreDatabase] database
+ # @param keg_path [String... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/messages.rb | @@ -1,5 +1,5 @@
# A Messages object collects messages that may need to be displayed together
-# at the end of a multi-step `brew` command run
+# at the end of a multi-step `brew` command run.
class Messages
attr_reader :caveats, :formula_count, :install_times
| true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/migrator.rb | @@ -137,7 +137,7 @@ def initialize(formula, force: ARGV.force?)
@old_pin_link_record = old_pin_record.readlink if @pinned
end
- # Fix INSTALL_RECEIPTS for tap-migrated formula.
+ # Fix INSTALL_RECEIPTs for tap-migrated formula.
def fix_tabs
old_tabs.each do |tab|
tab.tap = formula.tap
@@ -160... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/os/linux/elf.rb | @@ -1,5 +1,5 @@
+# @see https://en.wikipedia.org/wiki/Executable_and_Linkable_Format#File_header
module ELFShim
- # See: https://en.wikipedia.org/wiki/Executable_and_Linkable_Format#File_header
MAGIC_NUMBER_OFFSET = 0
MAGIC_NUMBER_ASCII = "\x7fELF".freeze
| true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/os/mac.rb | @@ -72,20 +72,23 @@ def active_developer_dir
@active_developer_dir ||= Utils.popen_read("/usr/bin/xcode-select", "-print-path").strip
end
- # If a specific SDK is requested
- # a) The requested SDK is returned, if it's installed.
- # b) If the requested SDK is not installed, the newest SDK (i... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/os/mac/xquartz.rb | @@ -60,8 +60,8 @@ def minimum_version
"2.7.11"
end
- # https://xquartz.macosforge.org/trac/wiki
- # https://xquartz.macosforge.org/trac/wiki/Releases
+ # - https://xquartz.macosforge.org/trac/wiki
+ # - https://xquartz.macosforge.org/trac/wiki/Releases
def latest_version
... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/patch.rb | @@ -162,7 +162,7 @@ def inspect
end
end
-# Legacy patches have no checksum and are not cached
+# Legacy patches have no checksum and are not cached.
class LegacyPatch < ExternalPatch
def initialize(strip, url)
super(strip) | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/requirement.rb | @@ -49,7 +49,7 @@ def message
s
end
- # Overriding #satisfied? is unsupported.
+ # Overriding {#satisfied?} is unsupported.
# Pass a block or boolean to the satisfy DSL method instead.
def satisfied?
satisfy = self.class.satisfy
@@ -61,7 +61,7 @@ def satisfied?
true
end
- # Overriding ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/resource.rb | @@ -61,10 +61,10 @@ def clear_cache
downloader.clear_cache
end
- # Verifies download and unpacks it
+ # Verifies download and unpacks it.
# The block may call `|resource,staging| staging.retain!` to retain the staging
# directory. Subclasses that override stage should implement the tmp
- # dir using ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/class_cop.rb | @@ -68,7 +68,7 @@ def autocorrect(node)
end
module FormulaAuditStrict
- # - `test do ..end` should be meaningfully defined in the formula
+ # - `test do ..end` should be meaningfully defined in the formula.
class Test < FormulaCop
def audit_formula(_node, _class_node, _parent_class... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/components_order_cop.rb | @@ -3,9 +3,9 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop checks for correct order of components in a Formula
+ # This cop checks for correct order of components in Formulae.
#
- # - component_precedence_list has component hierarchy in a nested list
+ # - `component_... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/components_redundancy_cop.rb | @@ -3,11 +3,11 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop checks if redundant components are present and other component errors
+ # This cop checks if redundant components are present and other component errors.
#
# - `url|checksum|mirror` should be inside `stable` bl... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/conflicts_cop.rb | @@ -4,7 +4,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits versioned Formulae for `conflicts_with`
+ # This cop audits versioned Formulae for `conflicts_with`.
class Conflicts < FormulaCop
MSG = "Versioned formulae should not use `conflicts_with`. " \
... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/dependency_order_cop.rb | @@ -3,7 +3,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop checks for correct order of `depends_on` in a Formula
+ # This cop checks for correct order of `depends_on` in Formulae.
#
# precedence order:
# build-time > run-time > normal > recommended > optional | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/extend/formula_cop.rb | @@ -30,7 +30,7 @@ def on_class(node)
end
# Checks for regex match of pattern in the node and
- # Sets the appropriate instance variables to report the match
+ # sets the appropriate instance variables to report the match
def regex_match_group(node, pattern)
string_repr = string... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/formula_desc_cop.rb | @@ -4,7 +4,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits `desc` in Formulae
+ # This cop audits `desc` in Formulae.
#
# - Checks for existence of `desc`
# - Checks if size of `desc` > 80
@@ -37,7 +37,7 @@ def audit_formula(_node, _class_node, _parent_clas... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/homepage_cop.rb | @@ -3,7 +3,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits `homepage` url in Formulae
+ # This cop audits the `homepage` URL in Formulae.
class Homepage < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
homepage_node = ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/lines_cop.rb | @@ -3,7 +3,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop checks for various miscellaneous Homebrew coding styles
+ # This cop checks for various miscellaneous Homebrew coding styles.
class Lines < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, _... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/options_cop.rb | @@ -3,7 +3,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits `options` in Formulae
+ # This cop audits `options` in Formulae.
class Options < FormulaCop
DEPRECATION_MSG = "macOS has been 64-bit only since 10.6 so 32-bit options are deprecated.".freeze
| true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/patches_cop.rb | @@ -4,7 +4,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits patches in Formulae
+ # This cop audits patches in Formulae.
class Patches < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body)
external_patches = find_all_blocks(body,... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/rubocops/urls_cop.rb | @@ -3,7 +3,7 @@
module RuboCop
module Cop
module FormulaAudit
- # This cop audits urls and mirrors in Formulae
+ # This cop audits URLs and mirrors in Formulae.
class Urls < FormulaCop
def audit_formula(_node, _class_node, _parent_class_node, body_node)
urls = find_every_fu... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/software_spec.rb | @@ -359,7 +359,7 @@ def compatible_cellar?
cellar == :any || cellar == :any_skip_relocation || cellar == HOMEBREW_CELLAR.to_s
end
- # Does the Bottle this BottleSpecification belongs to need to be relocated?
+ # Does the {Bottle} this BottleSpecification belongs to need to be relocated?
def skip_relocati... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/tap.rb | @@ -2,7 +2,7 @@
require "readall"
require "description_cache_store"
-# a {Tap} is used to extend the formulae provided by Homebrew core.
+# A {Tap} is used to extend the formulae provided by Homebrew core.
# Usually, it's synced with a remote git repository. And it's likely
# a GitHub repository with the name of ... | true |
Other | Homebrew | brew | 20167e5f1b45c486a05d3be4c0b5209d5d1a838d.json | Adjust comments to tidy API docs output. | Library/Homebrew/utils.rb | @@ -303,7 +303,7 @@ def safe_system(cmd, *args, **options)
raise(ErrorDuringExecution.new([cmd, *args], status: $CHILD_STATUS))
end
-# prints no output
+# Prints no output
def quiet_system(cmd, *args)
Homebrew._system(cmd, *args) do
# Redirect output streams to `/dev/null` instead of closing as some prog... | true |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.