diff --git a/README.md b/README.md index 94f92b6f90..5e16f60605 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,7 @@ If your issue persists, follow these instructions to the appropriate course of a * [`Permission denied` error](doc/reporting_bugs/a_cask_fails_to_install.md#permission-denied-error) * [`sha256 mismatch` error](doc/reporting_bugs/a_cask_fails_to_install.md#sha256-mismatch-error) * [`source is not there` error](doc/reporting_bugs/a_cask_fails_to_install.md#source-is-not-there-error) + * [`wrong number of arguments` error](doc/reporting_bugs/a_cask_fails_to_install.md#wrong-number-of-arguments-error) * [Unlisted reason](doc/reporting_bugs/a_cask_fails_to_install.md#unlisted-reason) * [`brew cask list` shows wrong information](doc/reporting_bugs/brew_cask_list_shows_wrong_information.md) * [`uninstall` wrongly reports cask as not installed](doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md) diff --git a/doc/issue_templates/issue_wrong_number_of_arguments.md b/doc/issue_templates/issue_wrong_number_of_arguments.md new file mode 100644 index 0000000000..77ba5544ef --- /dev/null +++ b/doc/issue_templates/issue_wrong_number_of_arguments.md @@ -0,0 +1,8 @@ +Getting wrong number of arguments and cannot fix: + +* Insert the name of the cask in the title, after the `:`. +* Insert the name of the cask and a link to it in the body of this issue (example: [`alfred`](https://github.com/caskroom/homebrew-cask/blob/master/Casks/alfred.rb)). +* Insert a detailed explanation of what you tried to do and the current situation. +* After all that **delete all this pre-inserted template text**. + +Failure to follow these instructions may get your issue closed without further explanation. Thank you for taking the time to correctly report the issue. diff --git a/doc/reporting_bugs/a_cask_fails_to_install.md b/doc/reporting_bugs/a_cask_fails_to_install.md index 8376278c39..642f63367e 100644 --- a/doc/reporting_bugs/a_cask_fails_to_install.md +++ b/doc/reporting_bugs/a_cask_fails_to_install.md @@ -48,7 +48,7 @@ Expected: 3dbc6c2205af35db5370c7642b9a2b833668880569b9c64a7f5a670bf9911130 Actual: 526d747d99a93b760f7965e25a57ed61de9b93d566a0ba0c5f1c7e83719b20fd ``` -Either your download was incomplete/corrupt or the cask is outdated. +either your download was incomplete/corrupt or the cask is outdated. [Continue to the fix](sha256_mismatch_error_fix_icomplete.md) @@ -68,6 +68,20 @@ the directory structure inside the app’s archive changed in some way. It must --- +#### `wrong number of arguments` error + +If the error output includes something like + +``` +Error: wrong number of arguments (1 for 4) +``` + +it’s likely the software you’re trying to install is incompatible with your macOS version. + +[Continue to the fix](wrong_number_of_arguments_fix.md) + +--- + #### Unlisted reason If your issue isn’t listed here, [go back](../../README.md#reporting-bugs) and pick `My problem isn’t listed`. diff --git a/doc/reporting_bugs/wrong_number_of_arguments_fix.md b/doc/reporting_bugs/wrong_number_of_arguments_fix.md new file mode 100644 index 0000000000..c010dc71b3 --- /dev/null +++ b/doc/reporting_bugs/wrong_number_of_arguments_fix.md @@ -0,0 +1,7 @@ +[Go back](a_cask_fails_to_install.md#wrong-number-of-arguments-error) + +Make sure the issue really lies with your macOS version. To do so, try to install the software manually. If it is incompatible with your macOS version, it will tell you. In that case, there is nothing we can do to help you install the software, but we can add a [`depends_on macos:`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/depends_on.md#depends_on-macos) stanza to prevent the cask from trying to install on incompatible macOS versions. + +Follow the instructions to [submit a fix](../../CONTRIBUTING.md#updating-a-cask), and make the change to the cask. If using `cask-repair`, you may give it the `--edit-cask` flag when calling it on the command-line to step right into editing it. If you’re having trouble submitting the fix or manually installing the software worked without a problem, open an issue [with this template][issue_wrong_number_of_arguments] explaining your steps so far and the current situation. + +[issue_wrong_number_of_arguments]: https://github.com/caskroom/homebrew-cask/issues/new?title=Getting%20wrong%20number%20of%20arguments%20and%20cannot%20fix%3A&body=%0A%2A%20Insert%20the%20name%20of%20the%20cask%20in%20the%20title%2C%20after%20the%20%60%3A%60.%0A%2A%20Insert%20the%20name%20of%20the%20cask%20and%20a%20link%20to%20it%20in%20the%20body%20of%20this%20issue%20%28example%3A%20%5B%60alfred%60%5D%28https%3A%2F%2Fgithub.com%2Fcaskroom%2Fhomebrew-cask%2Fblob%2Fmaster%2FCasks%2Falfred.rb%29%29.%0A%2A%20Insert%20a%20detailed%20explanation%20of%20what%20you%20tried%20to%20do%20and%20the%20current%20situation.%0A%2A%20After%20all%20that%20%2A%2Adelete%20all%20this%20pre-inserted%20template%20text%2A%2A.%0A%0AFailure%20to%20follow%20these%20instructions%20may%20get%20your%20issue%20closed%20without%20further%20explanation.%20Thank%20you%20for%20taking%20the%20time%20to%20correctly%20report%20the%20issue.%0A