From 058e23720f45cfaf69bd11fa6dde5304eb8e1a58 Mon Sep 17 00:00:00 2001 From: Andrew Toskin Date: Thu, 10 Aug 2017 23:03:51 -0700 Subject: [PATCH] Clarify notes on dependency errors, tests, and VCS integration. An optional feature that suggests you install Python is okay; core-dumping is not. The note on tests was about fish development tests, not the `test` builtin for conditional syntax. Specifically mention git, hg, and svn in the VCS section. --- CONTRIBUTING.md | 2 ++ README.md | 5 ++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 373c3dc9a..a01431df2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,8 @@ To make linting the code easy there are two make targets: `lint` and `lint-all`. Fish has custom cppcheck rules in the file `.cppcheck.rule`. These help catch mistakes such as using `wcwidth()` rather than `fish_wcwidth()`. Please add a new rule if you find similar mistakes being made. +Fish also depends on `diff` and `expect` for its tests. + ### Dealing With Lint Warnings You are strongly encouraged to address a lint warning by refactoring the code, changing variable names, or whatever action is implied by the warning. diff --git a/README.md b/README.md index fd3fe6955..4c36b4e35 100644 --- a/README.md +++ b/README.md @@ -38,15 +38,14 @@ At runtime, fish requires: * sed * bc, the "basic calculator" program. -Optional functionality should degrade gracefully. If fish ever threw an error about missing dependencies for an optional feature, it would be a bug in fish and should be reported on our GitHub. Optional features and dependencies include: +Optional functionality should degrade gracefully. (If fish ever threw a syntax error or a core dump due to missing dependencies for an optional feature, it would be a bug in fish and should be reported on our GitHub.) Optional features and dependencies include: -* fish's builtin `test` syntax, which requires `diff` and `expect`. You don't need these, though, if you don't want to use our tests. * dynamically generating usage tips for builtin functions, which requires man, apropos, nroff, and ul. * manual page parsing for auto-completion for external commands, which also requires the above man tools, plus Python 2.6+ or Python 3.3+. Python 2 will also need the backports.lzma package; Python 3.3+ should include the required module by default. * the web configuration tool, which requires Python 2.6+ or 3.3+. * the fish_clipboard_* functions (bound to \cv and \cx), which require xsel or pbcopy/pbpaste. -fish can also show VCS information in the prompt, when the current working directory is in a VCS-tracked project. This is one of the weakest dependencies, though: if you don't use git, you don't need git information in the prompt, and if you do use git, you already have it. +fish can also show VCS information in the prompt, when the current working directory is in a VCS-tracked project, with support for Git, Mercurial, and Subversion. This is one of the weakest dependencies, though: if you don't use git, for example, you don't need git information in the prompt, and if you do use git, you already have it. Similarly, fish comes with a variety of auto-completion scripts to help with command-line usage of a variety of applications; these scripts call the application in question, but you should only need these applications if you use them. ### Autotools Build