diff options
| author | Markus Reiter | 2016-10-08 12:08:41 +0200 |
|---|---|---|
| committer | Markus Reiter | 2016-10-08 12:10:54 +0200 |
| commit | 5cae4532bfade512c156f8d4c6b84f9714e4fef3 (patch) | |
| tree | f5e49988e48097c8c534e3a5e3aefce207d1443b /Library/Homebrew/cask/doc/reporting_bugs | |
| parent | 0c3bb42a8a4ac46cc2622cb6660565e186d9df2b (diff) | |
| download | brew-5cae4532bfade512c156f8d4c6b84f9714e4fef3.tar.bz2 | |
Remove Homebrew Cask documentation.
Diffstat (limited to 'Library/Homebrew/cask/doc/reporting_bugs')
14 files changed, 0 insertions, 213 deletions
diff --git a/Library/Homebrew/cask/doc/reporting_bugs/a_cask_fails_to_install.md b/Library/Homebrew/cask/doc/reporting_bugs/a_cask_fails_to_install.md deleted file mode 100644 index 90dc685f0..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/a_cask_fails_to_install.md +++ /dev/null @@ -1,79 +0,0 @@ -<sup><sub>[Go back](../../README.md#reporting-bugs)</sup></sub> - -# A cask fails to install - -Possible reasons: - -* [`curl` error](#curl-error) -* [`Permission denied` error](#permission-denied-error) -* [`sha256 mismatch` error](#sha256-mismatch-error) -* [`source is not there` error](#source-is-not-there-error) -* [Unlisted reason](#unlisted-reason) - ---- - -#### `curl` error: - -If the error output includes something like - -``` -curl: (22) The requested URL returned error: 403 Forbidden -``` - -the problem was with the downloading itself (see how the error came from `curl`). Homebrew-Cask itself is fine and the problem is generally one of: - -1. App vendor or file in their server is down. -2. Cask is outdated. -3. A problem in your setup or connection. - -[Continue to the fix](curl_error_fix_curlrc.md) - ---- - -#### `Permission denied` error: - -If the error output includes something like - -``` -Error: Permission denied - (/usr/local/Caskroom/someapp/0.1/Someapp.app, /Applications/Someapp.app) -``` - -the problem isn’t with Homebrew-Cask itself, but some permissions on your system. - -[Continue to the fix](permission_denied_error_fix_appdir.md) - ---- - -#### `sha256 mismatch` error - -If the error output includes something like - -``` -Error: sha256 mismatch -Expected: 3dbc6c2205af35db5370c7642b9a2b833668880569b9c64a7f5a670bf9911130 -Actual: 526d747d99a93b760f7965e25a57ed61de9b93d566a0ba0c5f1c7e83719b20fd -``` - -Either your download was incomplete/corrupt or the cask is outdated. - -[Continue to the fix](sha256_mismatch_error_fix_icomplete.md) - ---- - -#### `source is not there` error - -If the error output includes something like - -``` -Error: It seems the App source is not there: '/usr/local/Caskroom/…' -``` - -the directory structure inside the app’s archive changed in some way. It must be fixed in Homebrew-Cask. - -[Continue to the fix](source_is_not_there_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/Library/Homebrew/cask/doc/reporting_bugs/brew_cask_list_shows_wrong_information.md b/Library/Homebrew/cask/doc/reporting_bugs/brew_cask_list_shows_wrong_information.md deleted file mode 100644 index 981b8cb47..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/brew_cask_list_shows_wrong_information.md +++ /dev/null @@ -1,7 +0,0 @@ -<sup><sub>[Go back](../../README.md#reporting-bugs)</sup></sub> - -# `brew cask list` shows wrong information - -We know. [`brew cask list` is broken](https://github.com/caskroom/homebrew-cask/issues/14058) and has been for quite a while. Pull requests to fix the outstanding problems are welcome. - -**Do not open an issue.** diff --git a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_curlrc.md b/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_curlrc.md deleted file mode 100644 index cb74139fa..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_curlrc.md +++ /dev/null @@ -1,5 +0,0 @@ -<sup><sub>[Go back](a_cask_fails_to_install.md#curl-error)</sup></sub> - -First, lets tackle a common problem: do you have a `.curlrc` file? Those are a frequent cause of issues of this nature. Before anything else, remove that file and try again. If it now works, do not open an issue. Incompatible `.curlrc` configurations must be fixed on your side. - -If, however, you do not have a `.curlrc` or removing it did not work, lets [continue our diagnose](curl_error_fix_vendor.md). diff --git a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_no_download.md b/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_no_download.md deleted file mode 100644 index 2ec686d60..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_no_download.md +++ /dev/null @@ -1,10 +0,0 @@ -<sup><sub>[Go back](curl_error_fix_vendor.md)</sup></sub> - -There are a few reasons why you might not be finding a download: - -* You can’t access the vendor’s website at all. [Continue here](curl_error_fix_wont_fix.md). -* You can access the vendor’s site but they’re informing you the app is now discontinued. Submit a pull request deleting the cask or [open an issue informing us of the situation][issue_dead_app]. -* You can access the vendor’s site but you cannot find the download link. [Open an issue][issue_outdated_cask_but_cannot_find_link] and detail all your steps so far. - -[issue_dead_app]: https://github.com/caskroom/homebrew-cask/issues/new?title=Dead%20app%3A%20&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%20link%20to%20the%20page%20that%20informs%20about%20the%20app%20being%20dead.%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. -[issue_outdated_cask_but_cannot_find_link]: https://github.com/caskroom/homebrew-cask/issues/new?title=Outdated%20cask%20but%20cannot%20find%20link%3A%20&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%20why%20you%20failed%20to%20find%20the%20download%20link.%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. diff --git a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_outdated.md b/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_outdated.md deleted file mode 100644 index 6a7e6e73f..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_outdated.md +++ /dev/null @@ -1,11 +0,0 @@ -<sup><sub>[Go back](curl_error_fix_vendor.md)</sup></sub> - -Since the download started, it likely means the cask is outdated. Lets fix it: - -1. Look around the app’s website and find out what the latest version is. It will likely be expressed in the URL used to download it. -2. Take a look at the cask’s version (`brew cask _stanza version {{cask_name}}`) and verify it is indeed outdated. - * If the app’s version is `latest`, it means the `url` itself is outdated. It will need to be changed to the new one. - -If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue][issue_outdated_cask] explaining your steps so far and why you’re having trouble submitting the update. - -[issue_outdated_cask]: https://github.com/caskroom/homebrew-cask/issues/new?title=Outdated%20cask%20but%20cannot%20find%20link%3A%20&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%20why%20you%20failed%20to%20find%20the%20download%20link.%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. diff --git a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_vendor.md b/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_vendor.md deleted file mode 100644 index bcb785ba7..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_vendor.md +++ /dev/null @@ -1,8 +0,0 @@ -<sup><sub>[Go back](curl_error_fix_curlrc)</sup></sub> - -Lets now see if the issue is upstream: - -1. Got to the vendor’s website (`brew cask home {{cask_name}}`). -2. Find the download link for the app and click on it. - -Does it download? [Yes](curl_error_fix_outdated.md) | [No](curl_error_fix_wont_fix.md) | [There is nothing to download](curl_error_fix_no_download.md) diff --git a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_wont_fix.md b/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_wont_fix.md deleted file mode 100644 index c02b9adfe..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/curl_error_fix_wont_fix.md +++ /dev/null @@ -1,9 +0,0 @@ -<sup><sub>[Go back](curl_error_fix_vendor.md)</sup></sub> - -This means the issue isn’t in any way related to Homebrew-Cask, but with the vendor or your connection. - -Start by diagnosing your connection (try to download other casks, go around the web). If the problem is with your connection, try a website like [Ask Different](https://apple.stackexchange.com/) to ask for advice. - -If you’re sure the issue is not with your connection, contact the app’s vendor and let them know their link is down, so they can fix it. - -**Do not open an issue.** diff --git a/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_appdir.md b/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_appdir.md deleted file mode 100644 index fcee7fd73..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_appdir.md +++ /dev/null @@ -1,7 +0,0 @@ -<sup><sub>[Go back](a_cask_fails_to_install.md#permission-denied-error)</sup></sub> - -In this case, it’s likely you’re a standard user and don’t have permissions to write to `/Applications` (which is now our default). If you never changed your default installation directory for apps and were using Homebrew-Cask before we changed our behaviour to moving apps instead of linking, you should have some symlinks in your `~/Applications` directory, which you do have permission to write to. - -You can use `--appdir=~/Applications` when installing to bring back the old behaviour. For a permanent change, [follow the `Options` section in `USAGE.md`](https://github.com/caskroom/homebrew-cask/blob/1de4657a0ed35463602b31061b0c16dc9078b8a0/USAGE.md#options). Specifically, you’ll want to set `export HOMEBREW_CASK_OPTS="--appdir=~/Applications"` in your shell’s startup file. - -If `--appdir` doesn’t fix the issue or you do have write permissions to `/Applications`, the problem may lie [in the app bundle itself](permission_denied_error_fix_bundle.md). diff --git a/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_bundle.md b/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_bundle.md deleted file mode 100644 index 7b23eef0a..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/permission_denied_error_fix_bundle.md +++ /dev/null @@ -1,5 +0,0 @@ -<sup><sub>[Go back](permission_denied_error_fix_appdir.md)</sup></sub> - -Some app bundles don’t have certain permissions that might be necessary for us to move them to the appropriate location. You may check such permissions with `ls -ls {{path_to_app_bundle}}`. If you see something like `dr-xr-xr-x` at the start of the output, that may be the cause. To fix it, we simply change the app bundle’s permission to allow us to move it, and then set it back to what it was (in case the developer set those permissions deliberately). See [`licoin`](https://github.com/caskroom/homebrew-cask/blob/0cde71f1fea8ad62d6ec4732fcf35ac0c52d8792/Casks/litecoin.rb#L14L20) for an example of such a cask. - -If the issue persists, [go back](../../README.md#reporting-bugs) and pick `My problem isn’t listed`. Be sure to mention all your steps so far and what you’re having difficulties with. diff --git a/Library/Homebrew/cask/doc/reporting_bugs/pre_bug_report.md b/Library/Homebrew/cask/doc/reporting_bugs/pre_bug_report.md deleted file mode 100644 index 4a7fba3c4..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/pre_bug_report.md +++ /dev/null @@ -1,15 +0,0 @@ -Before reporting a bug, lets make sure everything is right with your setup. - -When reporting bugs, remember that Homebrew-Cask is an independent project from Homebrew. Do your best to direct bug reports to the appropriate project. If your command started with `brew cask`, bring the bug to us first. - -Start by searching for your issue before posting a new one. If you find an open issue and have any new information not reported in the original, please add your insights. If you find a closed issue, try the solutions there. If the issue is still not solved, open a new one with your new information and a link back to the old related issue. - -If you did not find your particular bug, before reporting it make sure you have the latest versions of Homebrew, Homebrew-Cask, and all Taps by running the following commands. These will also fix some other issues: - -```bash -$ brew update; brew cleanup; brew cask cleanup -$ brew uninstall --force brew-cask; brew update -$ brew untap phinze/cask; brew untap caskroom/cask; brew update -``` - -Retry your failing command. If the issue persists, [go back](../../README.md#reporting-bugs) and pick the appropriate instructions for your problem. diff --git a/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_icomplete.md b/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_icomplete.md deleted file mode 100644 index 7da488334..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_icomplete.md +++ /dev/null @@ -1,5 +0,0 @@ -<sup><sub>[Go back](a_cask_fails_to_install.md#sha256-mismatch-error)</sup></sub> - -First, lets see if the problem was with your download. Delete the downloaded file (its location will be pointed out right under the `Actual` shasum line) and try again. - -If the problem persists, [the cask must be outdated](sha256_mismatch_error_fix_outdated.md). diff --git a/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_outdated.md b/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_outdated.md deleted file mode 100644 index a37ea5337..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/sha256_mismatch_error_fix_outdated.md +++ /dev/null @@ -1,13 +0,0 @@ -<sup><sub>[Go back](sha256_mismatch_error_fix_icomplete.md)</sup></sub> - -Lets bring the cask up to date. It’ll likely need a new version, but it’s possible the version has remained the same (happens occasionally when the vendor updates the app in place). - -1. Got to the vendor’s website (`brew cask home {{cask_name}}`). - * Alternatively, if it has an `appcast`, read that (`curl "$(brew cask _stanza appcast {{cask_name}})"`). -2. Find out what the latest version is. It will likely be expressed in the URL used to download it. -3. Take a look at the cask’s version (`brew cask _stanza version {{cask_name}}`) and verify it is indeed outdated. - * If the app’s version is `latest`, it means the `url` itself is outdated. It will need to be changed to the new one. - -If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue][issue_outdated_cask] explaining your steps so far and why you’re having trouble submitting the update. - -[issue_outdated_cask]: https://github.com/caskroom/homebrew-cask/issues/new?title=Outdated%20cask%20but%20cannot%20find%20link%3A%20&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%20why%20you%20failed%20to%20find%20the%20download%20link.%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. diff --git a/Library/Homebrew/cask/doc/reporting_bugs/source_is_not_there_fix.md b/Library/Homebrew/cask/doc/reporting_bugs/source_is_not_there_fix.md deleted file mode 100644 index 8ee7c31e9..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/source_is_not_there_fix.md +++ /dev/null @@ -1,28 +0,0 @@ -<sup><sub>[Go back](a_cask_fails_to_install.md#source-is-not-there-error)</sup></sub> - -First, you need to identify which artifact is not being handled correctly anymore. It’s explicit in the error message: if it says `Error: It seems the App source…'` the problem is [`app`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/app.md). The pattern is the same across all artifacts. - -Fixing this error is typically easy, and requires only a bit of time on your part. Start by downloading the package for the cask: `brew cask fetch {{cask_name}}`. The last line of output will inform you of the location of the download. Navigate there and manually unpack it. As an example, lets say the structure inside the archive is as follows: - -``` -. -├─ Files/SomeApp.app -├─ Files/script.sh -└─ README.md -``` - -Now, lets look at the cask (`brew cask cat {{cask_name}}`: - -``` -(…) -app 'SomeApp.app' -(…) -``` - -The cask was expecting `SomeApp.app` to be in the top directory of the archive (see how it says simply `SomeApp.app`) but the developer changed it to inside a `Files` directory. All we have to do is update that line of the cask to follow the new structure: `app 'Files/SomeApp.app'`. - -Note that occasionally the app’s name changes completely (from `SomeApp.app` to `OtherApp.app`, lets say). In these instances, the filename of the cask itself, as well as its token, must also change. Consult the [`token reference`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md) for complete instructions on the new name. - -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, [open an issue][issue_source_not_there_and_cannot_find_it] explaining your steps so far and why you’re having trouble submitting the update. - -[issue_source_not_there_and_cannot_find_it]: https://github.com/caskroom/homebrew-cask/issues/new?title=Source%20not%20there%20and%20cannot%20find%20it%3A%20&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%20why%20you%20failed%20to%20find%20the%20new%20artifact%20source.%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.
\ No newline at end of file diff --git a/Library/Homebrew/cask/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md b/Library/Homebrew/cask/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md deleted file mode 100644 index 1b1227de8..000000000 --- a/Library/Homebrew/cask/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md +++ /dev/null @@ -1,11 +0,0 @@ -<sup><sub>[Go back](../../README.md#reporting-bugs)</sup></sub> - -# `uninstall` wrongly reports cask as not installed - -Reports of this bug are usually accompanied with the output of `brew cask list` showing the cask is indeed installed. [You should not rely on `brew cask list`](https://github.com/caskroom/homebrew-cask/issues/14058) anyway, and this error is somewhat related to it. - -This is prone to happen when you try to uninstall a cask that has been updated since you last installed, or when a cask no longer exists in the repo (`brew cask list` will show it with `(!)`). We’re working to handle those situations better. - -For now, rerun your command with `--force`, or uninstall manually. - -**Do not open an issue.** |
