mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-27 05:13:10 +00:00
No description
7988cff6bd
This is a *tiny* commit code-wise, but the explanation is a bit longer. When I made string read in chunks, I picked a chunk size from bash's read, under the assumption that they had picked a good one. It turns out, on the (linux) systems I've tested, that's simply not true. My tests show that a bigger chunk size of up to 4096 is better *across the board*: - It's better with very large inputs - It's equal-to-slightly-better with small inputs - It's equal-to-slightly-better even if we quit early My test setup: 0. Create various fish builds with various sizes for STRING_CHUNK_SIZE, name them "fish-$CHUNKSIZE". 1. Download the npm package names from https://github.com/nice-registry/all-the-package-names/blob/master/names.json (I used commit 87451ea77562a0b1b32550124e3ab4a657bf166c, so it's 46.8MB) 2. Extract the names so we get a line-based version: ```fish jq '.[]' names.json | string trim -c '"' >/tmp/all ``` 3. Create various sizes of random extracts: ```fish for f in 10000 1000 500 50 shuf /tmp/all | head -n $f > /tmp/$f end ``` (the idea here is to defeat any form of pattern in the input). 4. Run benchmarks: hyperfine -w 3 ./fish-{128,512,1024,2048,4096}" -c 'for i in (seq 1000) string match -re foot < $f end; true'" (reduce the seq size for the larger files so you don't have to wait for hours - the idea here is to have some time running string and not just fish startup time) This shows results pretty much like ``` Summary './fish-2048 -c 'for i in (seq 1000) string match -re foot < /tmp/500 end; true'' ran 1.01 ± 0.02 times faster than './fish-4096 -c 'for i in (seq 1000) string match -re foot < /tmp/500 end; true'' 1.02 ± 0.03 times faster than './fish-1024 -c 'for i in (seq 1000) string match -re foot < /tmp/500 end; true'' 1.08 ± 0.03 times faster than './fish-512 -c 'for i in (seq 1000) string match -re foot < /tmp/500 end; true'' 1.47 ± 0.07 times faster than './fish-128 -c 'for i in (seq 1000) string match -re foot < /tmp/500 end; true'' ``` So we see that up to 1024 there's a difference, and after that the returns are marginal. So we stick with 1024 because of the memory trade-off. ---- Fun extra: Comparisons with `grep` (GNU grep 3.7) are *weird*. Because you both get ``` './fish-4096 -c 'for i in (seq 100); string match -re foot < /tmp/500; end; true'' ran 11.65 ± 0.23 times faster than 'fish -c 'for i in (seq 100); command grep foot /tmp/500; end'' ``` and ``` 'fish -c 'for i in (seq 2); command grep foot /tmp/all; end'' ran 66.34 ± 3.00 times faster than './fish-4096 -c 'for i in (seq 2); string match -re foot < /tmp/all; end; true'' 100.05 ± 4.31 times faster than './fish-128 -c 'for i in (seq 2); string match -re foot < /tmp/all; end; true'' ``` Basically, if you *can* give grep a lot of work at once (~40MB in this case), it'll churn through it like butter. But if you have to call it a lot, string beats it by virtue of cheating. |
||
|---|---|---|
| .builds | ||
| .github | ||
| benchmarks | ||
| build_tools | ||
| cmake | ||
| debian | ||
| doc_src | ||
| docker | ||
| etc | ||
| osx | ||
| po | ||
| share | ||
| src | ||
| tests | ||
| .clang-format | ||
| .clang-tidy | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .oclint | ||
| BSDmakefile | ||
| CHANGELOG.rst | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| config_cmake.h.in | ||
| CONTRIBUTING.rst | ||
| COPYING | ||
| Dockerfile | ||
| fish.desktop | ||
| fish.pc.in | ||
| fish.png | ||
| fish.spec.in | ||
| GNUmakefile | ||
| README.rst | ||
`fish <https://fishshell.com/>`__ - the friendly interactive shell |Build Status| ================================================================================= fish is a smart and user-friendly command line shell for macOS, Linux, and the rest of the family. fish includes features like syntax highlighting, autosuggest-as-you-type, and fancy tab completions that just work, with no configuration required. For more on fish’s design philosophy, see the `design document <https://fishshell.com/docs/current/design.html>`__. Quick Start ----------- fish generally works like other shells, like bash or zsh. A few important differences can be found at https://fishshell.com/docs/current/tutorial.html by searching for the magic phrase “unlike other shells”. Detailed user documentation is available by running ``help`` within fish, and also at https://fishshell.com/docs/current/index.html Getting fish ------------ macOS ~~~~~ fish can be installed: - using `Homebrew <http://brew.sh/>`__: ``brew install fish`` - using `MacPorts <https://www.macports.org/>`__: ``sudo port install fish`` - using the `installer from fishshell.com <https://fishshell.com/>`__ - as a `standalone app from fishshell.com <https://fishshell.com/>`__ Note: The minimum supported macOS version is 10.10 "Yosemite". Packages for Linux ~~~~~~~~~~~~~~~~~~ Packages for Debian, Fedora, openSUSE, and Red Hat Enterprise Linux/CentOS are available from the `openSUSE Build Service <https://software.opensuse.org/download.html?project=shells%3Afish&package=fish>`__. Packages for Ubuntu are available from the `fish PPA <https://launchpad.net/~fish-shell/+archive/ubuntu/release-3>`__, and can be installed using the following commands: :: sudo apt-add-repository ppa:fish-shell/release-3 sudo apt update sudo apt install fish Instructions for other distributions may be found at `fishshell.com <https://fishshell.com>`__. Windows ~~~~~~~ - On Windows 10, fish can be installed under the WSL Windows Subsystem for Linux with the instructions for the appropriate distribution listed above under “Packages for Linux”, or from source with the instructions below. - Fish can also be installed on all versions of Windows using `Cygwin <https://cygwin.com/>`__ (from the **Shells** category). Building from source ~~~~~~~~~~~~~~~~~~~~ If packages are not available for your platform, GPG-signed tarballs are available from `fishshell.com <https://fishshell.com/>`__ and `fish-shell on GitHub <https://github.com/fish-shell/fish-shell/releases>`__. See the `Building <#building>`__ section for instructions. Running fish ------------ Once installed, run ``fish`` from your current shell to try fish out! Dependencies ~~~~~~~~~~~~ Running fish requires: - curses or ncurses (preinstalled on most \*nix systems) - some common \*nix system utilities (currently ``mktemp``), in addition to the basic POSIX utilities (``cat``, ``cut``, ``dirname``, ``ls``, ``mkdir``, ``mkfifo``, ``rm``, ``sort``, ``tee``, ``tr``, ``uname`` and ``sed`` at least, but the full coreutils plus ``find`` and ``awk`` is preferred) - The gettext library, if compiled with translation support The following optional features also have specific requirements: - builtin commands that have the ``--help`` option or print usage messages require ``nroff`` or ``mandoc`` for display - automated completion generation from manual pages requires Python 3.5+ - the ``fish_config`` web configuration tool requires Python 3.5+ and a web browser - system clipboard integration (with the default Ctrl-V and Ctrl-X bindings) require either the ``xsel``, ``xclip``, ``wl-copy``/``wl-paste`` or ``pbcopy``/``pbpaste`` utilities - full completions for ``yarn`` and ``npm`` require the ``all-the-package-names`` NPM module - ``colorls`` is used, if installed, to add color when running ``ls`` on platforms that do not have color support (such as OpenBSD) Switching to fish ~~~~~~~~~~~~~~~~~ If you wish to use fish as your default shell, use the following command: :: chsh -s /usr/local/bin/fish ``chsh`` will prompt you for your password and change your default shell. (Substitute ``/usr/local/bin/fish`` with whatever path fish was installed to, if it differs.) Log out, then log in again for the changes to take effect. Use the following command if fish isn’t already added to ``/etc/shells`` to permit fish to be your login shell: :: echo /usr/local/bin/fish | sudo tee -a /etc/shells To switch your default shell back, you can run ``chsh -s /bin/bash`` (substituting ``/bin/bash`` with ``/bin/tcsh`` or ``/bin/zsh`` as appropriate). Building -------- .. _dependencies-1: Dependencies ~~~~~~~~~~~~ Compiling fish requires: - a C++11 compiler (g++ 4.8 or later, or clang 3.3 or later) - CMake (version 3.5 or later) - a curses implementation such as ncurses (headers and libraries) - PCRE2 (headers and libraries) - optional, this will be downloaded if missing - gettext (headers and libraries) - optional, for translation support Sphinx is also optionally required to build the documentation from a cloned git repository. Additionally, running the test suite requires Python 3.5+ and the pexpect package. Building from source (all platforms) - Makefile generator ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To install into ``/usr/local``, run: .. code:: bash mkdir build; cd build cmake .. make sudo make install The install directory can be changed using the ``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``. Building from source (macOS) - Xcode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Note: The minimum supported macOS version is 10.10 "Yosemite". .. code:: bash mkdir build; cd build cmake .. -G Xcode An Xcode project will now be available in the ``build`` subdirectory. You can open it with Xcode, or run the following to build and install in ``/usr/local``: .. code:: bash xcodebuild xcodebuild -scheme install The install directory can be changed using the ``-DCMAKE_INSTALL_PREFIX`` parameter for ``cmake``. Build options ~~~~~~~~~~~~~ In addition to the normal cmake build options (like ``CMAKE_INSTALL_PREFIX``), fish has some other options available to customize it. - BUILD_DOCS=ON|OFF - whether to build the documentation. This is automatically set to OFF when sphinx isn't installed. - INSTALL_DOCS=ON|OFF - whether to install the docs. This is automatically set to on when BUILD_DOCS is or prebuilt documentation is available (like when building in-tree from a tarball). - FISH_USE_SYSTEM_PCRE2=ON|OFF - whether to use an installed pcre2. This is normally autodetected. - MAC_CODESIGN_ID=String|OFF - the codesign ID to use on Mac, or "OFF" to disable codesigning. - WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations. Note that fish does *not* support static linking and will attempt to error out if it detects it. Help, it didn’t build! ~~~~~~~~~~~~~~~~~~~~~~ If fish reports that it could not find curses, try installing a curses development package and build again. On Debian or Ubuntu you want: :: sudo apt install build-essential cmake ncurses-dev libncurses5-dev libpcre2-dev gettext On RedHat, CentOS, or Amazon EC2: :: sudo yum install ncurses-devel Contributing Changes to the Code -------------------------------- See the `Guide for Developers <CONTRIBUTING.rst>`__. Contact Us ---------- Questions, comments, rants and raves can be posted to the official fish mailing list at https://lists.sourceforge.net/lists/listinfo/fish-users or join us on our `gitter.im channel <https://gitter.im/fish-shell/fish-shell>`__. Or use the `fish tag on Unix & Linux Stackexchange <https://unix.stackexchange.com/questions/tagged/fish>`__. There is also a fish tag on Stackoverflow, but it is typically a poor fit. Found a bug? Have an awesome idea? Please `open an issue <https://github.com/fish-shell/fish-shell/issues/new>`__. .. |Build Status| image:: https://github.com/fish-shell/fish-shell/workflows/make%20test/badge.svg :target: https://github.com/fish-shell/fish-shell/actions