Release 4.0.8

Created by ./build_tools/release.sh 4.0.8

.builds/alpine.yml

@@ -24,4 +24,4 @@ tasks:
           ninja
   - test: |
           cd fish-shell/build
-          ninja test
+          env ninja test

.builds/arch.yml

@@ -20,4 +20,4 @@ tasks:
           ninja
   - test: |
           cd fish/build
-          ninja test
+          env ninja test

.cargo/config.toml

@@ -1,8 +0,0 @@
-# This file is _not_ included in the tarballs for now
-# Binary builds on Linux packaging infrastructure need to overwrite it to make `cargo vendor` work
-# Releases and development builds made using OBS/Launchpad will _not_ reflect the contents of this
-# file
-
-[resolver]
-# Make cargo 1.84+ respect MSRV (rust-version in Cargo.toml)
-incompatible-rust-versions = "fallback"

.cirrus.yml

@@ -20,15 +20,17 @@ linux_task:
         #   container:
         #       <<: *step
         #       image: ghcr.io/krobelus/fish-ci/focal-32bit:latest
+
     tests_script:
         # cirrus at times gives us 32 procs and 2 GB of RAM
         # Unrestriced parallelism results in OOM
         - lscpu || true
         - (cat /proc/meminfo | grep MemTotal) || true
         - mkdir build && cd build
-        - FISH_TEST_MAX_CONCURRENCY=6 cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
+        - cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCTEST_PARALLEL_LEVEL=6 ..
         - ninja -j 6 fish
         - ninja fish_run_tests
+
     only_if: $CIRRUS_REPO_OWNER == 'fish-shell'
 
 linux_arm_task:
@@ -39,26 +41,34 @@ linux_arm_task:
         - name: jammy-armv7-32bit
           arm_container:
               image: ghcr.io/fish-shell/fish-ci/jammy-armv7-32bit
+
     tests_script:
         # cirrus at times gives us 32 procs and 2 GB of RAM
         # Unrestriced parallelism results in OOM
         - lscpu || true
         - (cat /proc/meminfo | grep MemTotal) || true
         - mkdir build && cd build
-        - FISH_TEST_MAX_CONCURRENCY=6 cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
+        - cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCTEST_PARALLEL_LEVEL=6 ..
         - ninja -j 6 fish
         - file ./fish
         - ninja fish_run_tests
+
     # CI task disabled during RIIR transition
     only_if: false && $CIRRUS_REPO_OWNER == 'fish-shell'
 
 freebsd_task:
     matrix:
-        - name: FreeBSD 14
+        # - name: FreeBSD 14
+        #   freebsd_instance:
+        #       image_family: freebsd-14-0-snap
+        - name: FreeBSD 13
           freebsd_instance:
-              image: freebsd-14-3-release-amd64-ufs
+              image: freebsd-13-2-release-amd64
+        # - name: FreeBSD 12.3
+        #   freebsd_instance:
+        #       image: freebsd-12-3-release-amd64
     tests_script:
-        - pkg install -y cmake-core devel/pcre2 devel/ninja gettext git-lite lang/rust misc/py-pexpect
+        - pkg install -y cmake-core devel/pcre2 devel/ninja misc/py-pexpect git-lite terminfo-db
         # libclang.so is a required build dependency for rust-c++ ffi bridge
         - pkg install -y llvm
         # BSDs have the following behavior: root may open or access files even if
@@ -71,7 +81,16 @@ freebsd_task:
         - mkdir build && cd build
         - chown -R fish-user ..
         - sudo -u fish-user -s whoami
-        - sudo -u fish-user -s FISH_TEST_MAX_CONCURRENCY=1 cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
-        - sudo -u fish-user -s ninja -j 6 fish
-        - sudo -u fish-user -s ninja fish_run_tests
+        # FreeBSD's pkg currently has rust 1.66.0 while we need rust 1.70.0+. Use rustup to install
+        # the latest, but note that it only installs rust per-user.
+        - sudo -u fish-user -s fetch -qo - https://sh.rustup.rs > rustup.sh
+        - sudo -u fish-user -s sh ./rustup.sh -y --profile=minimal
+        # `sudo -s ...` does not invoke a login shell so we need a workaround to make sure the
+        # rustup environment is configured for subsequent `sudo -s ...` commands.
+        # For some reason, this doesn't do the job:
+        # - sudo -u fish-user sh -c 'echo source \$HOME/.cargo/env >> $HOME/.cshrc'
+        - sudo -u fish-user -s cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCTEST_PARALLEL_LEVEL=1 ..
+        - sudo -u fish-user sh -c '. $HOME/.cargo/env; ninja -j 6 fish'
+        - sudo -u fish-user sh -c '. $HOME/.cargo/env; ninja fish_run_tests'
+
     only_if: $CIRRUS_REPO_OWNER == 'fish-shell'

.gitattributes

@@ -1,12 +1,13 @@
 # normalize newlines
-* text=auto eol=lf
+* text=auto
+*.fish text
+*.bat eol=crlf
 
 # let git show off diff hunk headers, help git diff -L:
 # https://git-scm.com/docs/gitattributes
-*.c diff=cpp
+*.cpp diff=cpp
 *.h diff=cpp
 *.py diff=py
-*.rs diff=rust
 # add a [diff "fish"] to git config with pattern
 *.fish diff=fish
 
@@ -20,13 +21,12 @@
 /.github/* export-ignore
 /.builds export-ignore
 /.builds/* export-ignore
-# to make cargo vendor work correctly
-/.cargo/ export-ignore
-/.cargo/config.toml export-ignore
 
-# for linguist, which drives GitHub's language statistics
+# for linguist; let github identify our project as C++ instead of C due to pcre2
+pcre2/** linguist-vendored
 alpine.js linguist-vendored
 doc_src/** linguist-documentation
 *.fish linguist-language=fish
-# see 70f2899fcd which attempts to "rig the count"
+src/*.h linguist-language=c++
+src/builtins/*.h linguist-language=c++
 share/completions/*.fish linguist-documentation

.github/ISSUE_TEMPLATE.md

@@ -1,18 +1,10 @@
----
-name: "Bug Report"
-about: "Simple template for bug reports"
-title: ""
-labels: []
-assignees: []
----
-
 <!--
 Please tell us which fish version you are using by executing the following:
 
   fish --version
   echo $version
 
-Please tell us which operating system (output of `uname`) and terminal you are using.
+Please tell us which operating system and terminal you are using. The output of `uname -a` and `echo $TERM` may be helpful in this regard although other commands might be relevant in your specific situation.
 
 Please tell us if you tried fish without third-party customizations by executing this command and whether it affected the behavior you are reporting:
 

.github/actions/install-sphinx-markdown-builder/action.yml

@@ -1,14 +0,0 @@
-name: Install sphinx-markdown-builder
-
-permissions:
-  contents: read
-
-runs:
-  using: "composite"
-  steps:
-    - shell: bash
-      run: |
-        set -x
-        commit=b259de1dc97573a71470a1d71c3d83535934136b
-        pip install git+https://github.com/krobelus/sphinx-markdown-builder@"$commit"
-        python -c 'import sphinx_markdown_builder'

.github/actions/rust-toolchain@stable/action.yml

@@ -14,7 +14,7 @@ permissions:
 runs:
   using: "composite"
   steps:
-    - uses: dtolnay/rust-toolchain@1.90
+    - uses: dtolnay/rust-toolchain@1.89
       with:
         targets: ${{ inputs.targets }}
         components: ${{ inputs.components }}

.github/workflows/autolabel_prs.yml

@@ -8,12 +8,16 @@ jobs:
   label-and-milestone:
     runs-on: ubuntu-latest
     steps:
+    # - name: Checkout repository
+    #   uses: actions/checkout@v2
+
     - name: Set label and milestone
       id: set-label-milestone
       uses: actions/github-script@v7
       with:
         script: |
           const completionsLabel = 'completions';
+          const completionsMilestone = 'fish next-3.x';
 
           // Get changed files in the pull request
           const prNumber = context.payload.pull_request.number;
@@ -37,4 +41,26 @@ jobs:
               labels: [completionsLabel],
             });
             console.log(`PR ${prNumber} assigned label "${completionsLabel}"`);
+
+            // Get the list of milestones
+            const { data: milestones } = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+            });
+
+            // Find the milestone id
+            const milestone = milestones.find(milestone => milestone.title === completionsMilestone);
+
+            if (milestone) {
+              // Set the milestone for the PR
+              await github.rest.issues.update({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                milestone: milestone.number
+              });
+              console.log(`PR ${prNumber} assigned milestone "${completionsMilestone}"`);
+            } else {
+              console.error(`Milestone "${completionsMilestone}" not found`);
+            }
           }

.github/workflows/main.yml

@@ -3,7 +3,7 @@ name: make fish_run_tests
 on: [push, pull_request]
 
 env:
-  FISH_TEST_MAX_CONCURRENCY: "4"
+  CTEST_PARALLEL_LEVEL: "1"
   CMAKE_BUILD_PARALLEL_LEVEL: "4"
 
 permissions:
@@ -16,13 +16,12 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: ./.github/actions/rust-toolchain@oldest-supported
+    - uses: dtolnay/rust-toolchain@1.70
     - name: Install deps
       run: |
-        sudo apt install gettext libpcre2-dev python3-pexpect python3-sphinx tmux
+        sudo apt install gettext libpcre2-dev python3-pexpect tmux
         # Generate a locale that uses a comma as decimal separator.
         sudo locale-gen fr_FR.UTF-8
-    - uses: ./.github/actions/install-sphinx-markdown-builder
     - name: cmake
       run: |
         mkdir build && cd build
@@ -33,14 +32,6 @@ jobs:
     - name: make fish_run_tests
       run: |
         make -C build VERBOSE=1 fish_run_tests
-    - name: translation updates
-      run: |
-        # Generate PO files. This should not result it a change in the repo if all translations are
-        # up to date.
-        # Ensure that fish is available as an executable.
-        PATH="$PWD/build:$PATH" build_tools/update_translations.fish
-        # Show diff output. Fail if there is any.
-        git --no-pager diff --exit-code || { echo 'There are uncommitted changes after regenerating the gettext PO files. Make sure to update them via `build_tools/update_translations.fish` after changing source files.'; exit 1; }
 
   ubuntu-32bit-static-pcre2:
 
@@ -48,7 +39,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: ./.github/actions/rust-toolchain@oldest-supported
+    - uses: dtolnay/rust-toolchain@1.70
       with:
         targets: "i586-unknown-linux-gnu" # rust-toolchain wants this comma-separated
     - name: Install deps
@@ -91,14 +82,13 @@ jobs:
     - name: Install deps
       run: |
         sudo apt install gettext libpcre2-dev python3-pexpect tmux
-        sudo apt install llvm # for llvm-symbolizer
     - name: cmake
       env:
           CC: clang
       run: |
         mkdir build && cd build
         # Rust's ASAN requires the build system to explicitly pass a --target triple. We read that
-        # value from CMake variable Rust_CARGO_TARGET.
+        # value from CMake variable Rust_CARGO_TARGET (shared with corrosion).
         cmake .. -DASAN=1 -DRust_CARGO_TARGET=x86_64-unknown-linux-gnu -DCMAKE_BUILD_TYPE=Debug
     - name: make
       run: |
@@ -114,8 +104,8 @@ jobs:
           # UPDATE: this can cause spurious leak reports for __cxa_thread_atexit_impl() under glibc.
           LSAN_OPTIONS: verbosity=0:log_threads=0:use_tls=1:print_suppressions=0
       run: |
-        set -x
-        export ASAN_SYMBOLIZER_PATH=$(command -v /usr/bin/llvm-symbolizer* | sort -n | head -1)
+        llvm_version=$(clang --version | awk 'NR==1 { split($NF, version, "."); print version[1] }')
+        export ASAN_SYMBOLIZER_PATH=/usr/bin/llvm-symbolizer-$llvm_version
         export LSAN_OPTIONS="$LSAN_OPTIONS:suppressions=$PWD/build_tools/lsan_suppressions.txt"
         make -C build VERBOSE=1 fish_run_tests
 
@@ -129,7 +119,7 @@ jobs:
   #
   #   steps:
   #   - uses: actions/checkout@v4
-  #   - uses: ./.github/actions/rust-toolchain@oldest-supported
+  #   - uses: dtolnay/rust-toolchain@1.70
   #   - name: Install deps
   #     run: |
   #       sudo apt install gettext libpcre2-dev python3-pexpect tmux
@@ -157,7 +147,7 @@ jobs:
       CARGO_NET_GIT_FETCH_WITH_CLI: true
     steps:
     - uses: actions/checkout@v4
-    - uses: ./.github/actions/rust-toolchain@oldest-supported
+    - uses: dtolnay/rust-toolchain@1.70
     - name: Install deps
       run: |
         # --break-system-packages because homebrew has now declared itself "externally managed".
@@ -167,7 +157,7 @@ jobs:
     - name: cmake
       run: |
         mkdir build && cd build
-        cmake -DCMAKE_BUILD_TYPE=Debug ..
+        cmake -DWITH_GETTEXT=NO -DCMAKE_BUILD_TYPE=Debug ..
     - name: make
       run: |
         make -C build VERBOSE=1

.github/workflows/release.yml

@@ -1,12 +1,9 @@
 name: Create a new release
 
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version to release (tag name)'
-        required: true
-        type: string
+  push:
+    tags:
+      - '*.*.*'
 
 permissions:
   contents: write
@@ -19,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           # Workaround for https://github.com/actions/checkout/issues/882
-          ref: ${{ inputs.version }}
+          ref: ${{ github.ref }}
       - name: Check if the pushed tag looks like a release
         run: |
           set -x
@@ -39,30 +36,57 @@ jobs:
       - uses: actions/checkout@v4
         with:
           # Workaround for https://github.com/actions/checkout/issues/882
-          ref: ${{ inputs.version }}
+          ref: ${{ github.ref }}
       - name: Install dependencies
         run: sudo apt install cmake gettext ninja-build python3-pip python3-sphinx
-      - uses: ./.github/actions/install-sphinx-markdown-builder
       - name: Create tarball
         run: |
           set -x
           mkdir /tmp/fish-built
           FISH_ARTEFACT_PATH=/tmp/fish-built ./build_tools/make_tarball.sh
-          relnotes=/tmp/fish-built/release-notes.md
-          # Need history since the last release (i.e. tag) for stats.
-          git fetch --tags
-          git fetch --unshallow
-          sh -x ./build_tools/release-notes.sh >"$relnotes"
-          # Delete title
-          sed -n 1p "$relnotes" | grep -q "^## fish .*"
-          sed -n 2p "$relnotes" | grep -q '^$'
-          sed -i 1,2d "$relnotes"
+          {
+            pip install sphinx-markdown-builder==0.6.8
+            relnotes_tmp=$(mktemp -d)
+            mkdir "$relnotes_tmp/src" "$relnotes_tmp/out"
+            version=$(git describe)
+            minor_version=${version%.*}
+            changelog_for_this_version=$(awk <CHANGELOG.rst '
+              /^fish/ && $2 != "'"$version"'" { exit }
+              { print }
+            ')
+            # Also fix up any relative references to other documentation files.
+            # Also remove spurious transitions at the end of the document.
+            printf %s "$changelog_for_this_version" |
+              sed >"$relnotes_tmp/src"/index.rst \
+                -e 's,:doc:`\(.*\) <\([^>]*\)>`,`\1 <https://fishshell.com/docs/'"$minor_version"'/\2.html>`_,g' \
+                -e 's,:envvar:`\([^`]*\)`,``$\1``,g' \
+                -e '$s/^----*$//'
+
+            # In future, we could reuse doctree from when we made HTML docs.
+            sphinx-build -j 1 $(: "sphinx-markdown-builder is not marked concurrency-safe") \
+              -W -E -b markdown -c doc_src \
+              -d "$relnotes_tmp/doctree" "$relnotes_tmp/src" $relnotes_tmp/out
+            # Delete title
+            sed -n 1p "$relnotes_tmp/out/index.md" | grep -q "^# fish .*"
+            sed -n 2p "$relnotes_tmp/out/index.md" | grep -q '^$'
+            sed -i 1,2d "$relnotes_tmp/out/index.md"
+            {
+              cat "$relnotes_tmp/out/index.md" - <<EOF
+          ----
+
+          *Download links: To download the source code for fish, we suggest the file named "fish-$version.tar.xz". The file downloaded from "Source code (tar.gz)" will not build correctly.*
+
+          *The files called fish-$version-linux-\*.tar.xz are experimental packages containing a single standalone ``fish`` binary for any Linux with the given architecture.*
+          EOF
+            } >/tmp/fish-built/release-notes.md
+            rm -r "$relnotes_tmp"
+          }
       - name: Upload tarball artifact
         uses: actions/upload-artifact@v4
         with:
           name: source-tarball
           path: |
-            /tmp/fish-built/fish-${{ inputs.version }}.tar.xz
+            /tmp/fish-built/fish-${{ github.ref_name }}.tar.xz
             /tmp/fish-built/release-notes.md
           if-no-files-found: error
 
@@ -74,7 +98,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           # Workaround for https://github.com/actions/checkout/issues/882
-          ref: ${{ inputs.version }}
+          ref: ${{ github.ref }}
       - name: Install Rust Stable
         uses: ./.github/actions/rust-toolchain@stable
         with:
@@ -84,11 +108,12 @@ jobs:
       - name: Build statically-linked executables
         run: |
           set -x
-          cargo build --release --target x86_64-unknown-linux-musl --bin fish
           CFLAGS="-D_FORTIFY_SOURCE=2" \
+            CMAKE_WITH_GETTEXT=0 \
             CC=aarch64-linux-gnu-gcc \
             RUSTFLAGS="-C linker=aarch64-linux-gnu-gcc -C link-arg=-lgcc -C link-arg=-D_FORTIFY_SOURCE=0" \
             cargo build --release --target aarch64-unknown-linux-musl --bin fish
+          cargo build --release --target x86_64-unknown-linux-musl --bin fish
       - name: Compress
         run: |
           set -x
@@ -99,7 +124,7 @@ jobs:
       - uses: actions/upload-artifact@v4
         with:
           name: Static builds for Linux
-          path: fish-${{ inputs.version }}-linux-*.tar.xz
+          path: fish-${{ github.ref_name }}-linux-*.tar.xz
           if-no-files-found: error
 
   create-draft-release:
@@ -113,7 +138,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           # Workaround for https://github.com/actions/checkout/issues/882
-          ref: ${{ inputs.version }}
+          ref: ${{ github.ref }}
       - name: Download all artifacts
         uses: actions/download-artifact@v4
         with:
@@ -124,13 +149,13 @@ jobs:
       - name: Create draft release
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ inputs.version }}
-          name: fish ${{ inputs.version }}
+          tag_name: ${{ github.ref_name }}
+          name: fish ${{ github.ref_name }}
           body_path: /tmp/artifacts/release-notes.md
           draft: true
           files: |
-            /tmp/artifacts/fish-${{ inputs.version }}.tar.xz
-            /tmp/artifacts/fish-${{ inputs.version }}-linux-*.tar.xz
+            /tmp/artifacts/fish-${{ github.ref_name }}.tar.xz
+            /tmp/artifacts/fish-${{ github.ref_name }}-linux-*.tar.xz
 
   packages-for-macos:
     needs: [is-release-tag, create-draft-release]
@@ -141,7 +166,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           # Workaround for https://github.com/actions/checkout/issues/882
-          ref: ${{ inputs.version }}
+          ref: ${{ github.ref }}
       - name: Install Rust
         uses: ./.github/actions/rust-toolchain@oldest-supported
         with:
@@ -170,9 +195,8 @@ jobs:
           ./build_tools/make_macos_pkg.sh -s -f /tmp/app.p12 \
             -i /tmp/installer.p12 -p "$MAC_CODESIGN_PASSWORD" \
             -n -j /tmp/notarize.json
-          version=$(git describe)
-          [ -f "${FISH_ARTEFACT_PATH}/fish-$version.app.zip" ]
-          [ -f "${FISH_ARTEFACT_PATH}/fish-$version.pkg" ]
+          [ -f "${FISH_ARTEFACT_PATH}/fish-${{ github.ref_name }}.app.zip" ]
+          [ -f "${FISH_ARTEFACT_PATH}/fish-${{ github.ref_name }}.pkg" ]
           rm /tmp/installer.p12 /tmp/app.p12 /tmp/notarize.json
         env:
           MAC_CODESIGN_APP_P12_BASE64: ${{ secrets.MAC_CODESIGN_APP_P12_BASE64 }}
@@ -183,7 +207,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          version=$(git describe)
-          gh release upload $version \
-            /tmp/fish-built/fish-$version.app.zip \
-            /tmp/fish-built/fish-$version.pkg
+          gh release upload $(git describe) \
+            /tmp/fish-built/fish-${{ github.ref_name }}.app.zip \
+            /tmp/fish-built/fish-${{ github.ref_name }}.pkg

.github/workflows/rust_checks.yml

@@ -8,54 +8,34 @@ permissions:
 jobs:
   rustfmt:
     runs-on: ubuntu-latest
+
     steps:
     - uses: actions/checkout@v3
-    - uses: ./.github/actions/rust-toolchain@stable
-      with:
-        components: rustfmt
+    - uses: dtolnay/rust-toolchain@stable
     - name: cargo fmt
-      run: cargo fmt --check
+      run: cargo fmt --check --all
 
-  clippy-stable:
+  clippy:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        features: ["", "--no-default-features"]
+
     steps:
     - uses: actions/checkout@v3
-    - uses: ./.github/actions/rust-toolchain@stable
-      with:
-        components: clippy
+    - uses: dtolnay/rust-toolchain@stable
     - name: Install deps
       run: |
-        sudo apt install gettext
+        sudo apt install gettext libpcre2-dev
+    - name: cmake
+      run: |
+        cmake -B build
     - name: cargo clippy
-      run: cargo clippy --workspace --all-targets ${{ matrix.features }} -- --deny=warnings
+      # This used to have --deny=warnings, but that turns rust release day
+      # into automatic CI failure day, so we don't do that.
+      run: cargo clippy --workspace --all-targets
 
-  clippy-msrv:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ./.github/actions/rust-toolchain@oldest-supported
-      with:
-        components: clippy
-    - name: Install deps
-      run: |
-        sudo apt install gettext
-    - name: cargo clippy
-      run: cargo clippy --workspace --all-targets -- --deny=warnings
-
-  rustdoc:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ./.github/actions/rust-toolchain@stable
-    - name: Install deps
-      run: |
-        sudo apt install gettext
-    - name: cargo doc
-      run: |
-        RUSTDOCFLAGS='-D warnings' cargo doc --workspace
-    - name: cargo doctest
-      run: |
-        cargo test --doc --workspace
+  # Disabling for now because it also checks "advisories",
+  # making CI fail for reasons unrelated to the patch
+  # cargo-deny:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v3
+  #   - uses: EmbarkStudios/cargo-deny-action@v1

.gitignore

@@ -38,6 +38,7 @@ Desktop.ini
 Thumbs.db
 ehthumbs.db
 
+messages.pot
 .directory
 .fuse_hidden*
 
@@ -76,7 +77,6 @@ __pycache__
 /share/__fish_build_paths.fish
 /share/pkgconfig
 /tests/*.tmp.*
-/tests/.last-check-all-files
 
 # xcode
 ## Build generated
@@ -102,6 +102,3 @@ target/
 
 # Generated by clangd
 /.cache
-
-# JetBrains editors.
-.idea/

CHANGELOG.rst

@@ -1,189 +1,3 @@
-fish 4.1.0 (released September 27, 2025)
-========================================
-
-.. ignore for 4.1: 10929 10940 10948 10955 10965 10975 10989 10990 10998 11028 11052 11055 11069 11071 11079 11092 11098 11104 11106 11110 11140 11146 11148 11150 11214 11218 11259 11288 11299 11328 11350 11373 11395 11417 11419
-
-Notable improvements and fixes
-------------------------------
-- Compound commands (``begin; echo 1; echo 2; end``) can now be written using braces (``{ echo1; echo 2 }``), like in other shells.
-- fish now supports transient prompts: if :envvar:`fish_transient_prompt` is set to 1, fish will reexecute prompt functions with the ``--final-rendering`` argument before running a commandline (:issue:`11153`).
-- Tab completion results are truncated up to the common directory path, instead of somewhere inside that path. E.g. if you complete "share/functions", and it includes the files "foo.fish" and "bar.fish",
-  the completion pager will now show "…/foo.fish" and "…/bar.fish" (:issue:`11250`).
-- Self-installing builds as created by e.g. ``cargo install`` no longer install other files, see :ref:`below <changelog-4.1-embedded>`.
-- Our gettext-based message-localization has been reworked,
-  adding translations to self-installing builds; see :ref:`below <changelog-4.1-gettext>`.
-
-Deprecations and removed features
----------------------------------
-- ``set_color --background=COLOR`` no longer implicitly activates bold mode.
-  If your theme is stored in universal variables (the historical default), some bold formatting might be lost.
-  To fix this, we suggest updating to the latest version of our theme, to explicitly activate bold mode,
-  for example use ``fish_config theme save "fish default"``.
-- ``{echo,echo}`` or ``{ echo, echo }`` are no longer interpreted as brace expansion tokens but as :doc:`compound commands <cmds/begin>`.
-- Terminfo-style key names (``bind -k nul``) are no longer supported. They had been superseded by fish's :doc:`own key names <cmds/bind>` since 4.0 (:issue:`11342`).
-- fish no longer reads the terminfo database, so its behavior is generally no longer affected by the :envvar:`TERM` environment variable (:issue:`11344`).
-  For the time being, this change can be reversed via the ``ignore-terminfo`` :ref:`feature flag <featureflags>`.
-  To do so, run the following once and restart fish::
-
-    set -Ua fish_features no-ignore-terminfo
-
-- The ``--install`` option when fish is built as self-installing is removed, see :ref:`below <changelog-4.1-embedded>`.
-- ``set_color ff0000`` now outputs 24-bit RGB true-color even if :envvar:`COLORTERM` is unset.
-  One can override this by setting :envvar:`fish_term24bit` to 0 (:issue:`11372`).
-- fish now requires the terminal to respond to queries for the :ref:`primary device attribute <term-compat-primary-da>`.
-  For now, this can be reversed via a :ref:`feature flag <featureflags>`,
-  by running (once) ``set -Ua fish_features no-query-term`` and restarting fish.
-- Users of GNU screen may experience :ref:`minor glitches <term-compat-dcs-gnu-screen>` when starting fish.
-
-Scripting improvements
-----------------------
-- The :doc:`argparse <cmds/argparse>` builtin has seen many improvements, see :ref:`below <changelog-4.1-argparse>`.
-- The :doc:`string pad <cmds/string-pad>` command now has a ``-C/--center`` option.
-- The :doc:`psub <cmds/psub>` command now allows combining ``--suffix`` with ``--fifo`` (:issue:`11729`).
-- The :doc:`read <cmds/read>` builtin has learned the ``--tokenize-raw`` option to tokenize without quote removal (:issue:`11084`).
-
-Interactive improvements
-------------------------
-- Autosuggestions are now also provided in multi-line command lines. Like :kbd:`ctrl-r`, these operate only on the current line.
-- Autosuggestions used to not suggest multi-line command-lines from history; now autosuggestions include individual lines from multi-line command-lines.
-- The history pager search now preserves ordering between :kbd:`ctrl-s` forward and :kbd:`ctrl-r` backward searches.
-- Instead of highlighting events by flashing *all text to the left of the cursor*,
-  failing history token search (:kbd:`alt-.`) flashes the associated token,
-  failing tab-completion flashes the to-be-completed token (:issue:`11050`),
-  deleting an autosuggestion (:kbd:`shift-delete`) flashes the suggestion,
-  and all other scenarios flash the full command line.
-- Pasted commands are now stripped of any :code:`$\ ` command prefixes, to help pasting code snippets.
-- Builtin help options (e.g. ``abbr --help``) now use ``man`` directly, meaning that variables like :envvar:`MANWIDTH` are respected (:issue:`11786`).
-- ``funced`` will now edit copied functions directly, instead of the file where ``function --copy`` was invoked. (:issue:`11614`)
-- Added a simple ``fish_jj_prompt`` which reduces visual noise in the prompt inside `Jujutsu <https://jj-vcs.github.io/jj/latest/>`__ repositories that are colocated with Git.
-
-New or improved bindings
-^^^^^^^^^^^^^^^^^^^^^^^^
-- On non-macOS systems, :kbd:`alt-left`, :kbd:`alt-right`, :kbd:`alt-backspace` and :kbd:`alt-delete` no longer operate on punctuation-delimited words but on whole arguments, possibly including special characters like ``/`` and quoted spaces.
-  On macOS, the corresponding :kbd:`ctrl-` prefixed keys operate on whole arguments.
-  Word operations are still available via the other respective modifier, just like in most web browsers.
-- :kbd:`ctrl-z` (undo) after executing a command will restore the previous cursor position instead of placing the cursor at the end of the command line.
-- The :kbd:`alt-s` binding will now also use ``run0`` if available.
-- Some mouse support has been added: the OSC 133 prompt marking feature has learned about kitty's ``click_events=1`` flag, which allows moving fish's cursor by clicking in the command line,
-  and selecting pager items (:issue:`10932`).
-- Before clearing the screen and redrawing, :kbd:`ctrl-l` now pushes all text located above the prompt to the terminal's scrollback,
-  via a new special input function :ref:`scrollback-push <special-input-functions-scrollback-push>`.
-  For compatibility with terminals that do not implement ECMA-48's :ref:`SCROLL UP <term-compat-indn>` command,
-  this function is only used if the terminal advertises support for that via :ref:`XTGETTCAP <term-compat-xtgettcap>`.
-- Vi mode has learned :kbd:`ctrl-a` (increment) and :kbd:`ctrl-x` (decrement) (:issue:`11570`).
-
-Completions
-^^^^^^^^^^^
-- ``git`` completions now show the remote URL as description when completing remotes.
-- ``systemctl`` completions no longer print escape codes if ``SYSTEMD_COLORS`` happens to be set (:issue:`11465`).
-- Added and improved many completion scripts, notably ``tmux``.
-
-Improved terminal support
-^^^^^^^^^^^^^^^^^^^^^^^^^
-- Support for double, curly, dotted and dashed underlines, for use in ``fish_color_*`` variables and the :doc:`set_color builtin <cmds/set_color>` (:issue:`10957`).
-- Underlines can now be colored independent of text (:issue:`7619`).
-- New documentation page :doc:`Terminal Compatibility <terminal-compatibility>` (also accessible via ``man fish-terminal-compatibility``) lists the terminal control sequences used by fish.
-- fish now requires the terminal to respond to queries for the :ref:`primary device attribute <term-compat-primary-da>`.
-  For now, this can be reversed via a :ref:`feature flag <featureflags>`,
-  by running (once) ``set -Ua fish_features no-query-term``.
-
-Other improvements
-------------------
-- Updated Chinese and German translations.
-- ``fish_indent --dump-parse-tree`` now emits simple metrics about the tree including its memory consumption.
-- We added some tools to improve development workflows, for example ``build_tools/{check,update_translations,release}.sh`` and ``tests/test_driver.py``.
-  In conjunction with ``cargo``, these enable almost all day-to-day development tasks without using CMake.
-
-For distributors
-----------------
-- Builtin commands that support the ``--help`` option now require the ``man`` program.
-  The direct dependency on ``mandoc`` and ``nroff`` has been removed.
-- fish no longer uses gettext MO files, see :ref:`below <changelog-4.1-gettext>`.
-  If you have use cases which are incompatible with our new approach, please let us know.
-- The :doc:`fish_indent <cmds/fish_indent>` and :doc:`fish_key_reader <cmds/fish_key_reader>` programs are now also available as builtins.
-  If fish is invoked via e.g. a symlink with one of these names,
-  it will act like the given tool (i.e. it's a multi-call binary).
-  This allows truly distributing fish as a single file (:issue:`10876`).
-- The CMake build configuration has been simplified and no longer second-guesses rustup.
-  It will run rustc and cargo via :envvar:`PATH` or in ~/.cargo/bin/.
-  If that doesn't match your setup, set the Rust_COMPILER and Rust_CARGO CMake variables (:issue:`11328`).
-- Cygwin support has been reintroduced, since `Rust gained a Cygwin target <https://github.com/rust-lang/rust/pull/134999>`__ (:issue:`11238`).
-- CMake 3.15 is now required.
-
-.. _changelog-4.1-embedded:
-
-Changes to self-installing builds
----------------------------------
-
-The self-installing build type introduced in fish 4.0 has been changed (:issue:`11143`).
-Now fish built with embedded data will just read the data straight from its own binary or write it out to temporary files when necessary, instead of requiring an installation step on start.
-That means it is now possible to build fish as a single file and copy it to any system with a compatible CPU architecture, including as a different user, without extracting any files.
-As before, this is the default when building via ``cargo``, and disabled when building via CMake.
-For packagers we continue to recommend CMake.
-
-Note: When fish is built like this, the :envvar:`__fish_data_dir` variable will be empty because that directory no longer has meaning.
-You should generally not need these files.
-For example, if you want to make sure that completions for "foo" are loaded, use ``complete -C"foo " >/dev/null``  instead).
-The raw files are still exposed via :ref:`status subcommands <status-get-file>`, mainly for fish's internal use, but you can also use them as a last resort.
-
-Remaining benefits of a full installation (as currently done by CMake) are:
-
-- man pages like ``fish(1)`` in standard locations, easily accessible from outside fish.
-- a local copy of the HTML documentation, typically accessed via the :doc:`help <cmds/help>` function.
-  In builds with embedded data, ``help`` will redirect to e.g. `<https://fishshell.com/docs/current/>`__
-- ``fish_indent`` and ``fish_key_reader`` as separate files, making them easily accessible outside fish
-- an (empty) ``/etc/fish/config.fish`` as well as empty directories ``/etc/fish/{functions,completions,conf.d}``
-- ``$PREFIX/share/pkgconfig/fish.pc``, which defines directories for configuration-snippets, like ``vendor_completions.d``
-
-.. _changelog-4.1-gettext:
-
-Changes to gettext localization
--------------------------------
-
-We replaced several parts of the gettext functionality with custom implementations (:issue:`11726`).
-Most notably, message extraction, which should now work reliably, and the runtime implementation, where we no longer dynamically link to gettext, but instead use our own implementation, whose behavior is similar to GNU gettext, with some :doc:`minor deviations <cmds/_>`.
-Our implementation now fully respects fish variables, so locale variables do not have to be exported for fish localizations to work.
-They still have to be exported to inform other programs about language preferences.
-The :envvar:`LANGUAGE` environment variable is now treated as a path variable, meaning it is an implicitly colon-separated list.
-While we no longer have any runtime dependency on gettext, we still need gettext tools for building, most notably ``msgfmt``.
-When building without ``msgfmt`` available, localization will not work with the resulting executable.
-Localization data is no longer sourced at runtime from MO files on the file system, but instead built into the executable.
-This is always done, independently of the other data embedding, so all fish executables will have access to all message catalogs, regardless of the state of the file system.
-Disabling our new ``localize-messages`` cargo feature will cause fish to be built without localization support.
-CMake builds can continue to use the ``WITH_GETTEXT`` option, with the same semantics as the ``localize-messages`` feature.
-The current implementation does not provide any configuration options for controlling which language catalogs are built into the executable (other than disabling them all).
-As a workaround, you can delete files in the ``po`` directory before building to exclude unwanted languages.
-
-.. _changelog-4.1-argparse:
-
-Changes to the :doc:`argparse <cmds/argparse>` builtin
-------------------------------------------------------
-
-- ``argparse`` now saves recognised options, including option-arguments in :envvar:`argv_opts`, allowing them to be forwarded to other commands (:issue:`6466`).
-- ``argparse`` options can now be marked to be deleted from :envvar:`argv_opts` (by adding a ``&`` at the end of the option spec, before a ``!`` if present). There is now also a corresponding ``-d`` / ``--delete`` option to ``fish_opt``.
-- ``argparse --ignore-unknown`` now removes preceding known short options from groups containing unknown options (e.g. when parsing ``-abc``, if ``a`` is known but ``b`` is not, then :envvar:`argv` will contain ``-bc``).
-- ``argparse`` now has an ``-u`` / ``--move-unknown`` option that works like ``--ignore-unknown`` but preserves unknown options in :envvar:`argv`.
-- ``argparse`` now has an ``-S`` / ``--strict-longopts`` option that forbids abbreviating long options or passing them with a single dash (e.g. if there is a long option called ``foo``, ``--fo`` and ``--foo`` won't match it).
-- ``argparse`` now has a ``-U`` / ``--unknown-arguments`` option to specify how to parse unknown option's arguments.
-- ``argparse`` now allows specifying options that take multiple optional values by using ``=*`` in the option spec (:issue:`8432`).
-  In addition, ``fish_opt`` has been modified to support such options by using the ``--multiple-vals`` together with ``-o`` / ``--optional-val``; ``-m`` is also now acceptable as an abbreviation for ``--multiple-vals``.
-- ``fish_opt`` no longer requires you give a short flag name when defining options, provided you give it a long flag name with more than one character.
-- ``argparse`` option specifiers for long-only options can now start with ``/``, allowing the definition of long options with a single letter. Due to this change, the ``--long-only`` option to ``fish_opt`` is now no longer necessary and is deprecated.
-- ``fish_opt`` now has a ``-v`` / ``--validate`` option you can use to give a fish script to validate values of the option.
-
---------------
-
-fish 4.0.9 (released September 27, 2025)
-========================================
-
-This release fixes:
-
-- a regression in 4.0.6 causing shifted keys to not be inserted on some terminals (:issue:`11813`).
-- a regression in 4.0.6 causing the build to fail on systems where ``char`` is unsigned (:issue:`11804`).
-- a regression in 4.0.0 causing a crash on an invalid :doc:`bg <cmds/bg>` invocation.
-
---------------
-
 fish 4.0.8 (released September 18, 2025)
 ========================================
 
@@ -225,9 +39,7 @@ This release of fish fixes a number of issues identified in fish 4.0.2:
 - Bindings with modifiers such as ``bind ctrl-w`` work again on non-Latin keyboard layouts such as a Russian one.
   This is implemented by allowing key events such as :kbd:`ctrl-ц` to match bindings of the corresponding Latin key, using the kitty keyboard protocol's base layout key (:issue:`11520`).
 - Vi mode: The cursor position after pasting via :kbd:`p` has been corrected.
-- Vi mode: Trying to replace the last character via :kbd:`r` no longer replaces the last-but-one character (:issue:`11484`).
-
---------------
+- Vi mode: Trying to replace the last character via :kbd:`r` no longer replaces the last-but-one character (:issue:`11484`),
 
 fish 4.0.2 (released April 20, 2025)
 ====================================
@@ -238,7 +50,7 @@ This release of fish fixes a number of issues identified in fish 4.0.1:
 - The warning when the terminfo database can't be found has been downgraded to a log message. fish will act as if the terminal behaves like xterm-256color, which is correct for the vast majority of cases (:issue:`11277`, :issue:`11290`).
 - Key combinations using the super (Windows/command) key can now (actually) be bound using the :kbd:`super-` prefix (:issue:`11217`). This was listed in the release notes for 4.0.1 but did not work correctly.
 - :doc:`function <cmds/function>` is stricter about argument parsing, rather than allowing additional parameters to be silently ignored (:issue:`11295`).
-- Using parentheses in the :doc:`test <cmds/test>` builtin works correctly, following a regression in 4.0.0 where they were not recognized (:issue:`11387`).
+- Using parentheses in the :doc:`test <cmds/test>` builtin works correctly, following a regression in 4.0.0 where they were not recognized (:issue:`11387`). 
 - :kbd:`delete` in Vi mode when Num Lock is active will work correctly (:issue:`11303`).
 - Abbreviations cannot alter the command-line contents, preventing a crash (:issue:`11324`).
 - Improvements to various completions, including new completions for ``wl-randr`` (:issue:`11301`), performance improvements for ``cargo`` completions by avoiding network requests (:issue:`11347`), and other improvements for  ``btrfs`` (:issue:`11320`), ``cryptsetup`` (:issue:`11315`), ``git`` (:issue:`11319`, :issue:`11322`, :issue:`11323`), ``jj`` (:issue:`11046`), and ``systemd-analyze`` (:issue:`11314`).
@@ -268,7 +80,7 @@ This release of fish includes the following improvements compared to fish 4.0.0:
 - Completions for ``wine`` correctly include files again (:issue:`11202`).
 - On macOS, paths from ``/etc/paths`` and ``/etc/manpaths`` containing colons are handled correctly (:issue:`10684`). This functionality was included in the 4.0.0 release notes but was missing from the source code.
 - The XTerm ``modifyOtherKeys`` keyboard encoding is no longer used under WezTerm, as it does not work correctly in all layouts (:issue:`11204`).
-- :kbd:`option-left` and other similar keys should now work in iTerm versions before 3.5.12; the kitty keyboard protocol is now disabled on these versions (:issue:`11192`).
+- kbd:`option-left` and other similar keys should now work in iTerm versions before 3.5.12; the kitty keyboard protocol is now disabled on these versions (:issue:`11192`).
 - The kitty keyboard protocol is no longer used under Midnight Commander, as it does not work correctly (:issue:`10640`).
 - fish now sends the commandline along with the OSC 133 semantic prompt command start sequence. This fixes a test in the kitty terminal (:issue:`11203`).
 - Git completions for third-party commands like "git-absorb" are completed correctly again (:issue:`11205`).
@@ -288,7 +100,7 @@ Notable backwards-incompatible changes
 
 - As part of a larger binding rework, ``bind`` gained a new key notation.
   In most cases the old notation should keep working, but in rare cases you may have to change a ``bind`` invocation to use the new notation.
-  See :ref:`below <changelog-4.0-new-bindings>` for details.
+  See :ref:`below <changelog-new-bindings>` for details.
 - :kbd:`ctrl-c` now calls a new bind function called ``clear-commandline``. The old behavior, which leaves a "^C" marker, is available as ``cancel-commandline`` (:issue:`10935`)
 - ``random`` will produce different values from previous versions of fish when used with the same seed, and will work more sensibly with small seed numbers.
   The seed was never guaranteed to give the same result across systems,
@@ -310,7 +122,7 @@ Notable backwards-incompatible changes
 
 Notable improvements and fixes
 ------------------------------
-.. _changelog-4.0-new-bindings:
+.. _changelog-new-bindings:
 
 -  fish now requests XTerm's ``modifyOtherKeys`` keyboard encoding and `kitty keyboard protocol's <https://sw.kovidgoyal.net/kitty/keyboard-protocol/>`_ progressive enhancements (:issue:`10359`).
    Depending on terminal support, this allows to binding more key combinations, including arbitrary combinations of modifiers :kbd:`ctrl`, :kbd:`alt` and :kbd:`shift`, and distinguishing (for example) :kbd:`ctrl-i` from :kbd:`tab`.
@@ -429,6 +241,7 @@ Interactive improvements
   The color scheme will not be upgraded for existing installs. If you want, you should select it again via ``fish_config``.
 - Command lines which are larger than the terminal are now displayed correctly, instead of multiple blank lines being displayed (:issue:`7296`).
 - Prompts that use external commands will no longer produce an infinite loop if the command crashes (:issue:`9796`).
+- Undo (:kbd:`ctrl-z`) restores the cursor position too (:issue:`10838`).
 - The output of ``jobs`` shows "-" for jobs that have the same process group ID as the fish process, rather than "-2" (:issue:`10833`).
 - Job expansion (``%1`` syntax) works properly for jobs that are a mixture of external commands and functions (:issue:`10832`).
 - Command lines which have more lines than the terminal can be displayed and edited correctly (:issue:`10827`).
@@ -441,11 +254,10 @@ Interactive improvements
 New or improved bindings
 ^^^^^^^^^^^^^^^^^^^^^^^^
 - When the cursor is on a command that resolves to an executable script, :kbd:`alt-o` will now open that script in your editor (:issue:`10266`).
-- During up-arrow history search, :kbd:`shift-delete` will delete the current search item and move to the next older item. Previously this was only supported in the history pager.
+- During up-arrow history search, :kbd:`shift-delete` will delete the current search item and move to the next older item. Previously this was only supported in the history pager. 
 - :kbd:`shift-delete` will also remove the currently-displayed autosuggestion from history, and remove it as a suggestion.
 - :kbd:`ctrl-Z` (also known as :kbd:`ctrl-shift-z`) is now bound to redo.
 - Some improvements to the :kbd:`alt-e` binding which edits the command line in an external editor:
-
   - The editor's cursor position is copied back to fish. This is currently supported for Vim and Kakoune.
   - Cursor position synchronization is only supported for a set of known editors, which are now also detected in aliases which use ``complete --wraps``. For example, use ``complete --wraps my-vim vim`` to synchronize cursors when ``EDITOR=my-vim``.
   - Multiline commands are indented before being sent to the editor, which matches how they are displayed in fish.
@@ -453,19 +265,16 @@ New or improved bindings
 - Bindings like :kbd:`alt-l` that print output in between prompts now work correctly with multiline commandlines.
 - :kbd:`alt-d` on an empty command line lists the directory history again. This restores the behavior of version 2.1.
 - ``history-prefix-search-backward`` and ``-forward`` now maintain the cursor position, instead of moving the cursor to the end of the command line (:issue:`10430`).
-- The following keys have refined behavior if the terminal supports :ref:`the new keyboard encodings <changelog-4.0-new-bindings>`:
-
+- The following keys have refined behavior if the terminal supports :ref:`the new keyboard encodings <changelog-new-bindings>`:
   - :kbd:`shift-enter` now inserts a newline instead of executing the command line.
   - :kbd:`ctrl-backspace` now deletes the last word instead of only one character (:issue:`10741`).
   - :kbd:`ctrl-delete` deletes the next word (same as :kbd:`alt-d`).
 - New special input functions:
-
   - ``forward-char-passive`` and ``backward-char-passive`` are like their non-passive variants but do not accept autosuggestions or move focus in the completion pager (:issue:`10398`).
   - ``forward-token``, ``backward-token``, ``kill-token``, and ``backward-kill-token`` are similar to the ``*-bigword`` variants but for the whole argument token (which includes escaped spaces) (:issue:`2014`).
   - ``clear-commandline``, which merely clears the command line, as an alternative to ``cancel-commandline`` which prints ``^C`` and a new prompt (:issue:`10213`).
 - The ``accept-autosuggestion`` special input function now returns false when there was nothing to accept (:issue:`10608`).
 - Vi mode has seen some improvements but continues to suffer from the lack of people working on it.
-
   - New default cursor shapes for insert and replace mode.
   - :kbd:`ctrl-n` in insert mode accepts autosuggestions (:issue:`10339`).
   - Outside insert mode, the cursor will no longer be placed beyond the last character on the commandline.
@@ -512,7 +321,7 @@ Improved terminal support
 
 Other improvements
 ------------------
-- ``status`` gained a ``build-info`` subcommand, to print information on how fish was built, to help with debugging (:issue:`10896`).
+- ``status`` gained a ``buildinfo`` subcommand, to print information on how fish was built, to help with debugging (:issue:`10896`).
 - ``fish_indent`` will now collapse multiple empty lines into one (:issue:`10325`).
 - ``fish_indent`` now preserves the modification time of files if there were no changes (:issue:`10624`).
 - Performance in launching external processes has been improved for many cases (:issue:`10869`).
@@ -803,7 +612,7 @@ fish 3.6.0 (released January 7, 2023)
 Notable improvements and fixes
 ------------------------------
 - By default, :kbd:`ctrl-r` now opens the command history in the pager (:issue:`602`). This is fully searchable and syntax-highlighted, as an alternative to the incremental search seen in other shells. The new special input function ``history-pager`` has been added for custom bindings.
-- Abbreviations are more flexible (:issue:`9313`, :issue:`5003`, :issue:`2287`):
+- Abbrevations are more flexible (:issue:`9313`, :issue:`5003`, :issue:`2287`):
 
   - They may optionally replace tokens anywhere on the command line, instead of only commands
   - Matching tokens may be described using a regular expression instead of a literal word
@@ -899,7 +708,7 @@ Interactive improvements
 - A new variable, :envvar:`fish_cursor_selection_mode`, can be used to configure whether the command line selection includes the character under the cursor (``inclusive``) or not (``exclusive``). The new default is ``exclusive``; use ``set fish_cursor_selection_mode inclusive`` to get the previous behavior back (:issue:`7762`).
 - fish's completion pager now fills half the terminal on first tab press instead of only 4 rows, which should make results visible more often and save key presses, without constantly snapping fish to the top of the terminal (:issue:`9105`, :issue:`2698`).
 - The ``complete-and-search`` binding, used with :kbd:`shift-tab` by default, selects the first item in the results immediately (:issue:`9080`).
-- ``bind`` output is now syntax-highlighted when used interactively.
+- ``bind`` output is now syntax-highlighted when used interacively.
 - :kbd:`alt-h` (the default ``__fish_man_page`` binding) does a better job of showing the manual page of the command under cursor (:issue:`9020`).
 - If :envvar:`fish_color_valid_path` contains an actual color instead of just modifiers, those will be used for valid paths even if the underlying color isn't "normal" (:issue:`9159`).
 - The key combination for the QUIT terminal sequence, often :kbd:`ctrl-\\` (``\x1c``), can now be used as a binding (:issue:`9234`).
@@ -1128,7 +937,7 @@ Interactive improvements
 New or improved bindings
 ^^^^^^^^^^^^^^^^^^^^^^^^
 - The :kbd:`alt-s` binding will now insert ``doas`` instead of ``sudo`` if necessary (:issue:`8942`).
-- The ``kill-whole-line`` special input function now kills the newline preceding the last line. This makes ``dd`` in vi-mode clear the last line properly.
+- The ``kill-whole-line`` special input function now kills the newline preceeding the last line. This makes ``dd`` in vi-mode clear the last line properly.
 - The new ``kill-inner-line`` special input function kills the line without any newlines, allowing ``cc`` in vi-mode to clear the line while preserving newlines (:issue:`8983`).
 - On terminals that emit special sequences for these combinations, :kbd:`shift-space` is bound like :kbd:`space`, and :kbd:`ctrl-enter` is bound like :kbd:`return` (:issue:`8874`).
 
@@ -1237,7 +1046,7 @@ Deprecations and removed features
     > set -Ua fish_features ampersand-nobg-in-token
 
 - ``$status`` is now forbidden as a command, to prevent a surprisingly common error among new users: Running ``if $status`` (:issue:`8171`). This applies *only* to ``$status``, other variables are still allowed.
-- ``set --query`` now returns an exit status of 255 if given no variable names. This means ``if set -q $foo`` will not enter the if-block if ``$foo`` is empty or unset. To restore the previous behavior, use ``if not set -q foo; or set -q $foo`` - but this is unlikely to be desirable (:issue:`8214`).
+- ``set --query`` now returns an exit status of 255 if given no variable names. This means ``if set -q $foo`` will not enter the if-block if ``$foo`` is empty or unset. To restore the previous behavior, use ``if not set -q foo; or set -q $foo`` - but this is unlikely to be desireable (:issue:`8214`).
 - ``_`` is now a reserved keyword (:issue:`8342`).
 - The special input functions ``delete-or-exit``, ``nextd-or-forward-word`` and ``prevd-or-backward-word`` replace fish functions of the same names (:issue:`8538`).
 - Mac OS X 10.9 is no longer supported. The minimum Mac version is now 10.10 "Yosemite."
@@ -1260,7 +1069,7 @@ Scripting improvements
 - ``commandline`` gained a ``--paging-full-mode`` option to check if the pager is showing all the possible lines (no "7 more rows" message) (:issue:`8485`).
 - List expansion correctly reports an error when used with all zero indexes (:issue:`8213`).
 - Running ``fish`` with a directory instead of a script as argument (eg ``fish .``) no longer leads to an infinite loop. Instead it errors out immediately (:issue:`8258`)
-- Some error messages occurring after fork, like "text file busy" have been replaced by bespoke error messages for fish (like "File is currently open for writing"). This also restores error messages with current glibc versions that removed sys_errlist (:issue:`8234`, :issue:`4183`).
+- Some error messages occuring after fork, like "text file busy" have been replaced by bespoke error messages for fish (like "File is currently open for writing"). This also restores error messages with current glibc versions that removed sys_errlist (:issue:`8234`, :issue:`4183`).
 - The ``realpath`` builtin now also squashes leading slashes with the ``--no-symlinks`` option (:issue:`8281`).
 - When trying to ``cd`` to a dangling (broken) symbolic link, fish will print an error noting that the target is a broken link (:issue:`8264`).
 - On MacOS terminals that are not granted permissions to access a folder, ``cd`` would print a spurious "rotten symlink" error, which has been corrected to "permission denied" (:issue:`8264`).
@@ -1766,7 +1575,7 @@ Interactive improvements
 -  :kbd:`ctrl-c` handling has been reimplemented in C++ and is therefore quicker (:issue:`5259`), no longer occasionally prints an "unknown command" error (:issue:`7145`) or overwrites multiline prompts (:issue:`3537`).
 -  :kbd:`ctrl-c` no longer kills background jobs for which job control is
    disabled, matching POSIX semantics (:issue:`6828`, :issue:`6861`).
--  Autosuggestions work properly after :kbd:`ctrl-c` cancels the current command line (:issue:`6937`).
+-  Autosuggestions work properly after :kbd:`ctrl-c` cancels the current commmand line (:issue:`6937`).
 -  History search is now case-insensitive unless the search string contains an uppercase character (:issue:`7273`).
 -  ``fish_update_completions`` gained a new ``--keep`` option, which improves speed by skipping completions that already exist (:issue:`6775`, :issue:`6796`).
 -  Aliases containing an embedded backslash appear properly in the output of ``alias`` (:issue:`6910`).
@@ -2320,7 +2129,7 @@ Interactive improvements
    argument.
 -  Syntax highlighting works correctly with variables as commands
    (:issue:`5658`) and redirections to close file descriptors (:issue:`6092`).
--  ``help`` works properly on Windows Subsystem for Linux (:issue:`5759`, :issue:`6338`).
+-  ``help`` works properly on Windows Subsytem for Linux (:issue:`5759`, :issue:`6338`).
 -  A bug where ``disown`` could crash the shell has been fixed (:issue:`5720`).
 -  fish will not autosuggest files ending with ``~`` unless there are no
    other candidates, as these are generally backup files (:issue:`985`).
@@ -3262,7 +3071,7 @@ Other significant changes
 -  Some systems’ ``su`` implementations do not set the ``USER``
    environment variable; it is now reset for root users (:issue:`3916`).
 -  Under terminals which support it, bracketed paste is enabled,
-   escaping problematic characters for security and convenience (:issue:`3871`).
+   escaping problematic characters for security and convience (:issue:`3871`).
    Inside single quotes (``'``), single quotes and backslashes in pasted
    text are escaped (:issue:`967`). The ``fish_clipboard_paste`` function (bound
    to ``C-v`` by default) is still the recommended pasting method where
@@ -3391,9 +3200,9 @@ Other significant changes
 -  fish no longer prints a warning when it identifies a running instance
    of an old version (2.1.0 and earlier). Changes to universal variables
    may not propagate between these old versions and 2.5b1.
--  Improved compatibility with Android (:issue:`3585`), MSYS/mingw (:issue:`2360`), and
+-  Improved compatiblity with Android (:issue:`3585`), MSYS/mingw (:issue:`2360`), and
    Solaris (:issue:`3456`, :issue:`3340`).
--  Like other shells, the ``test`` built-in now returns an error for
+-  Like other shells, the ``test`` builting now returns an error for
    numeric operations on invalid integers (:issue:`3346`, :issue:`3581`).
 -  ``complete`` no longer recognises ``--authoritative`` and
    ``--unauthoritative`` options, and they are marked as obsolete.

CMakeLists.txt

@@ -7,6 +7,9 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 set(DEFAULT_BUILD_TYPE "RelWithDebInfo")
 
+# Generate Xcode schemas (but not for tests).
+set(CMAKE_XCODE_GENERATE_SCHEME 1)
+
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     message(STATUS "Setting build type to default '${DEFAULT_BUILD_TYPE}'")
     set(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}")
@@ -14,6 +17,9 @@ endif()
 
 # Set up standard directories.
 include(GNUInstallDirs)
+add_definitions(-D_UNICODE=1)
+
+include(cmake/gettext.cmake)
 
 # Set up PCRE2
 # This sets an environment variable that needs to be available before the Rust stanzas
@@ -24,6 +30,12 @@ include(cmake/Rust.cmake)
 # Work around issue where archive-built libs go in the wrong place.
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
 
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
+  set(FISH_IN_TREE_BUILD TRUE)
+else()
+  set(FISH_IN_TREE_BUILD FALSE)
+endif()
+
 # Set up the machinery around FISH-BUILD-VERSION-FILE
 # This defines the FBVF variable.
 include(Version)
@@ -34,11 +46,6 @@ get_filename_component(REAL_CMAKE_SOURCE_DIR "${CMAKE_SOURCE_DIR}" REALPATH)
 add_definitions(-DCMAKE_BINARY_DIR="${REAL_CMAKE_BINARY_DIR}")
 add_definitions(-DCMAKE_SOURCE_DIR="${REAL_CMAKE_SOURCE_DIR}")
 
-set(build_types Release RelWithDebInfo Debug "")
-if(NOT "${CMAKE_BUILD_TYPE}" IN_LIST build_types)
-  message(WARNING "Unsupported build type ${CMAKE_BUILD_TYPE}. If this doesn't build, try one of Release, RelWithDebInfo or Debug")
-endif()
-
 # Define a function to build and link dependencies.
 function(CREATE_TARGET target)
   add_custom_target(
@@ -52,8 +59,8 @@ function(CREATE_TARGET target)
             $<$<CONFIG:RelWithDebInfo>:--profile=release-with-debug>
             --target ${Rust_CARGO_TARGET}
             --no-default-features
-            --features=${FISH_CARGO_FEATURES}
             ${CARGO_FLAGS}
+            ${FEATURES_ARG}
       &&
       "${CMAKE_COMMAND}" -E
         copy "${rust_target_dir}/${rust_profile}/${target}" "${CMAKE_CURRENT_BINARY_DIR}"
@@ -74,6 +81,8 @@ create_target(fish_key_reader)
 # Set up the docs.
 include(cmake/Docs.cmake)
 
+# A helper for running tests.
+add_executable(fish_test_helper src/fish_test_helper.c)
 # Set up tests.
 include(cmake/Tests.cmake)
 

CODE_OF_CONDUCT.md

@@ -126,3 +126,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
 https://www.contributor-covenant.org/translations.
+

CONTRIBUTING.rst

@@ -11,17 +11,10 @@ Contributions are welcome, and there are many ways to contribute!
 Whether you want to change some of the core Rust source, enhance or add a completion script or function,
 improve the documentation or translate something, this document will tell you how.
 
+Getting Set Up
+==============
 
-Mailing List
-============
-
-Send patches to the public mailing list: mailto:~krobelus/fish-shell@lists.sr.ht.
-Archives are available at https://lists.sr.ht/~krobelus/fish-shell/.
-
-GitHub
-======
-
-Fish is available on Github, at https://github.com/fish-shell/fish-shell.
+Fish is developed on Github, at https://github.com/fish-shell/fish-shell.
 
 First, you'll need an account there, and you'll need a git clone of fish.
 Fork it on Github and then run::
@@ -36,7 +29,7 @@ For that, you'll require:
 -  Rust - when in doubt, try rustup
 -  CMake
 -  PCRE2 (headers and libraries) - optional, this will be downloaded if missing
--  gettext (only the msgfmt tool) - optional, for translation support
+-  gettext (headers and libraries) - optional, for translation support
 -  Sphinx - optional, to build the documentation
 
 Of course not everything is required always - if you just want to contribute something to the documentation you'll just need Sphinx,
@@ -50,14 +43,14 @@ Guidelines
 In short:
 
 - Be conservative in what you need (keep to the agreed minimum supported Rust version, limit new dependencies)
-- Use automated tools to help you (``build_tools/check.sh``)
+- Use automated tools to help you (including ``make fish_run_tests`` and ``build_tools/style.fish``)
 
 Contributing completions
 ========================
 
 Completion scripts are the most common contribution to fish, and they are very welcome.
 
-In general, we'll take all well-written completion scripts for a command that is publicly available.
+In general, we'll take all well-written completion scripts for a command that is publically available.
 This means no private tools or personal scripts, and we do reserve the right to reject for other reasons.
 
 Before you try to contribute them to fish, consider if the authors of the tool you are completing want to maintain the script instead.
@@ -203,14 +196,8 @@ The tests can be found in three places:
 - tests/pexpects for interactive tests using `pexpect <https://pexpect.readthedocs.io/en/stable/>`__
 
 When in doubt, the bulk of the tests should be added as a littlecheck test in tests/checks, as they are the easiest to modify and run, and much faster and more dependable than pexpect tests. The syntax is fairly self-explanatory. It's a fish script with the expected output in ``# CHECK:`` or ``# CHECKERR:`` (for stderr) comments.
-If your littlecheck test has a specific dependency, use ``# REQUIRE: ...`` with a posix sh script.
 
-The pexpects are written in python and can simulate input and output to/from a terminal, so they are needed for anything that needs actual interactivity. The runner is in tests/pexpect_helper.py, in case you need to modify something there.
-
-These tests can be run via the tests/test_driver.py python script, which will set up the environment.
-It sets up a temporary $HOME and also uses it as the current directory, so you do not need to create a temporary directory in them.
-
-If you need a command to do something weird to test something, maybe add it to the ``fish_test_helper`` binary (in tests/fish_test_helper.c), or see if it can already do it.
+The pexpects are written in python and can simulate input and output to/from a terminal, so they are needed for anything that needs actual interactivity. The runner is in build_tools/pexpect_helper.py, in case you need to modify something there.
 
 Local testing
 -------------
@@ -222,15 +209,6 @@ The tests can be run on your local computer on all operating systems.
    cmake path/to/fish-shell
    make fish_run_tests
 
-Or you can run them on a fish, without involving cmake::
-
-  cargo build
-  cargo test # for the unit tests
-  tests/test_driver.py target/debug # for the script and interactive tests
-
-Here, the first argument to test_driver.py refers to a directory with ``fish``, ``fish_indent`` and ``fish_key_reader`` in it.
-In this example we're in the root of the git repo and have run ``cargo build`` without ``--release``, so it's a debug build.
-
 Git hooks
 ---------
 
@@ -250,109 +228,83 @@ One possibility is a pre-push hook script like this one:
 
    # Git gives us lines like "refs/heads/frombranch SOMESHA1 refs/heads/tobranch SOMESHA1"
    # We're only interested in the branches
-   isprotected=false
    while read from _ to _; do
-       if [ "$to" = "refs/heads/$protected_branch" ]; then
-           isprotected=true
+       if [ "x$to" = "xrefs/heads/$protected_branch" ]; then
+           isprotected=1
        fi
    done
-   if "$isprotected"; then
-       echo "Running checks before push to master"
-       build_tools/check.sh
+   if [ "x$isprotected" = x1 ]; then
+       echo "Running tests before push to master"
+       make fish_run_tests
+       RESULT=$?
+       if [ $RESULT -ne 0 ]; then
+           echo "Tests failed for a push to master, we can't let you do that" >&2
+           exit 1
+       fi
    fi
+   exit 0
 
 This will check if the push is to the master branch and, if it is, only
-allow the push if running ``build_tools/check.sh`` succeeds. In some circumstances
+allow the push if running ``make fish_run_tests`` succeeds. In some circumstances
 it may be advisable to circumvent this check with
 ``git push --no-verify``, but usually that isn’t necessary.
 
 To install the hook, place the code in a new file
 ``.git/hooks/pre-push`` and make it executable.
 
+Coverity Scan
+-------------
+
+We use Coverity’s static analysis tool which offers free access to open
+source projects. While access to the tool itself is restricted,
+fish-shell organization members should know that they can login
+`here <https://scan.coverity.com/projects/fish-shell-fish-shell?tab=overview>`__
+with their GitHub account. Currently, tests are triggered upon merging
+the ``master`` branch into ``coverity_scan_master``. Even if you are not
+a fish developer, you can keep an eye on our statistics there.
+
 Contributing Translations
 =========================
 
-Fish uses GNU gettext to translate messages from English to other languages.
-We use custom tools for extracting messages from source files and to localize at runtime.
-This means that we do not have a runtime dependency on the gettext library.
-It also means that some features are not supported, such as message context and plurals.
-We also expect all files to be UTF-8-encoded.
-In practice, this should not matter much for contributing translations.
+Fish uses the GNU gettext library to translate messages from English to
+other languages.
 
-Translation sources are
-stored in the ``po`` directory, named ``ll_CC.po``, where ``ll`` is the
-two (or possibly three) letter ISO 639-1 language code of the target language
-(e.g. ``pt`` for Portuguese). ``CC`` is an ISO 3166 country/territory code,
-(e.g. ``BR`` for Brazil).
-An example for a valid name is ``pt_BR.po``, indicating Brazilian Portuguese.
-These are the files you will interact with when adding translations.
+Creating and updating translations requires the Gettext tools, including
+``xgettext``, ``msgfmt`` and ``msgmerge``. Translation sources are
+stored in the ``po`` directory, named ``LANG.po``, where ``LANG`` is the
+two letter ISO 639-1 language code of the target language (eg ``de`` for
+German).
 
-Adding translations for a new language
---------------------------------------
+To create a new translation:
 
-Creating new translations requires the Gettext tools.
-More specifically, you will need ``msguniq`` and ``msgmerge`` for creating translations for a new
-language.
-To create a new translation, run::
+* generate a ``messages.pot`` file by running ``build_tools/fish_xgettext.fish`` from
+  the source tree
+* copy ``messages.pot`` to ``po/LANG.po``
 
-    build_tools/update_translations.fish po/ll_CC.po
+To update a translation:
 
-This will create a new PO file containing all messages available for translation.
-If the file already exists, it will be updated.
+* generate a ``messages.pot`` file by running
+  ``build_tools/fish_xgettext.fish`` from the source tree
 
-After modifying a PO file, you can recompile fish, and it will integrate the modifications you made.
-This requires that the ``msgfmt`` utility is installed (comes as part of ``gettext``).
-It is important that the ``localize-messages`` cargo feature is enabled, which it is by default.
-You can explicitly enable it using::
+* update the existing translation by running
+  ``msgmerge --update --no-fuzzy-matching po/LANG.po messages.pot``
 
-    cargo build --features=localize-messages
-
-Use environment variables to tell fish which language to use, e.g.::
-
-    LANG=pt_BR.utf8 fish
-
-or within the running fish shell::
-
-    set LANG pt_BR.utf8
-
-For more options regarding how to choose languages, see
-`the corresponding gettext documentation
-<https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html>`__.
-One neat thing you can do is set a list of languages to check for translations in the order defined
-using the ``LANGUAGE`` variable, e.g.::
-
-    set LANGUAGE pt_BR de_DE
-
-to try to translate messages to Portuguese, if that fails try German, and if that fails too you will
-see the English version defined in the source code.
-
-Modifying existing translations
--------------------------------
-
-If you want to work on translations for a language which already has a corresponding ``po`` file, it
-is sufficient to edit this file. No other changes are necessary.
-
-After recompiling fish, you should be able to see your translations in action. See the previous
-section for details.
-
-Editing PO files
-----------------
+The ``--no-fuzzy-matching`` is important as we have had terrible experiences with gettext's "fuzzy" translations in the past.
 
 Many tools are available for editing translation files, including
-command-line and graphical user interface programs. For simple use, you can use your text editor.
+command-line and graphical user interface programs. For simple use, you can just use your text editor.
 
-Open up the PO file, for example ``po/sv.po``, and you'll see something like::
+Open up the po file, for example ``po/sv.po``, and you'll see something like::
 
-    msgid "%ls: No suitable job\n"
-    msgstr ""
+  msgid "%ls: No suitable job\n"
+  msgstr "" 
 
-The ``msgid`` here is the "name" of the string to translate, typically the English string to translate.
-The second line (``msgstr``) is where your translation goes.
+The ``msgid`` here is the "name" of the string to translate, typically the english string to translate. The second line (``msgstr``) is where your translation goes.
 
 For example::
 
-    msgid "%ls: No suitable job\n"
-    msgstr "%ls: Inget passande jobb\n"
+  msgid "%ls: No suitable job\n"
+  msgstr "%ls: Inget passande jobb\n"
 
 Any ``%s`` / ``%ls`` or ``%d`` are placeholders that fish will use for formatting at runtime. It is important that they match - the translated string should have the same placeholders in the same order.
 
@@ -360,17 +312,11 @@ Also any escaped characters, like that ``\n`` newline at the end, should be kept
 
 Our tests run ``msgfmt --check-format /path/to/file``, so they would catch mismatched placeholders - otherwise fish would crash at runtime when the string is about to be used.
 
-Be cautious about blindly updating an existing translation file.
-``msgid`` strings should never be updated manually, only by running the appropriate script.
-
-Modifications to strings in source files
-----------------------------------------
-
-If a string changes in the sources, the old translations will no longer work.
-They will be preserved in the PO files, but commented-out (starting with ``#~``).
-If you add/remove/change a translatable strings in a source file,
-run ``build_tools/update_translations.fish`` to propagate this to all translation files (``po/*.po``).
-This is only relevant for developers modifying the source files of fish or fish scripts.
+Be cautious about blindly updating an existing translation file. Trivial
+changes to an existing message (eg changing the punctuation) will cause
+existing translations to be removed, since the tools do literal string
+matching. Therefore, in general, you need to carefully review any
+recommended deletions.
 
 Setting Code Up For Translations
 --------------------------------
@@ -381,7 +327,7 @@ macros:
 
 ::
 
-    streams.out.append(wgettext_fmt!("%ls: There are no jobs\n", argv[0]));
+   streams.out.append(wgettext_fmt!("%ls: There are no jobs\n", argv[0]));
 
 All messages in fish script must be enclosed in single or double quote
 characters for our message extraction script to find them.
@@ -390,15 +336,15 @@ that the following are **not** valid:
 
 ::
 
-    echo (_ hello)
-    _ "goodbye"
+   echo (_ hello)
+   _ "goodbye"
 
 Above should be written like this instead:
 
 ::
 
-    echo (_ "hello")
-    echo (_ "goodbye")
+   echo (_ "hello")
+   echo (_ "goodbye")
 
 You can use either single or double quotes to enclose the
 message to be translated. You can also optionally include spaces after

COPYING

@@ -1,7 +1,7 @@
 Fish is a smart and user-friendly command line shell.
 
 Copyright (C) 2005-2009 Axel Liljencrantz
-Copyright (C) 2009- fish-shell contributors
+Copyright (C) 2009-2024 fish-shell contributors
 
 fish is free software.
 

Cargo.lock

@@ -4,9 +4,9 @@ version = 3
 
 [[package]]
 name = "allocator-api2"
-version = "0.2.21"
+version = "0.2.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923"
+checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f"
 
 [[package]]
 name = "autocfg"
@@ -31,9 +31,9 @@ dependencies = [
 
 [[package]]
 name = "cc"
-version = "1.2.7"
+version = "1.1.30"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a012a0df96dd6d06ba9a1b29d6402d1a5d77c6befd2566afdc26e10603dc93d7"
+checksum = "b16803a61b81d9eabb7eae2588776c4c1e584b738ede45fdbb4c972cec1e9945"
 dependencies = [
  "jobserver",
  "libc",
@@ -54,9 +54,9 @@ checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724"
 
 [[package]]
 name = "cpufeatures"
-version = "0.2.16"
+version = "0.2.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "16b80225097f2e5ae4e7179dd2266824648f3e2f49d9134d584b76389d31c4c3"
+checksum = "608697df725056feaccfa42cffdaeeec3fccc4ffc38358ecd19b243e716a78e0"
 dependencies = [
  "libc",
 ]
@@ -71,6 +71,19 @@ dependencies = [
  "typenum",
 ]
 
+[[package]]
+name = "dashmap"
+version = "5.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "978747c1d849a7d2ee5e8adc0159961c48fb7e5db2f06af6723b80123bb53856"
+dependencies = [
+ "cfg-if",
+ "hashbrown 0.14.5",
+ "lock_api",
+ "once_cell",
+ "parking_lot_core",
+]
+
 [[package]]
 name = "digest"
 version = "0.10.7"
@@ -89,88 +102,38 @@ checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
 
 [[package]]
 name = "errno"
-version = "0.3.11"
+version = "0.3.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "976dd42dc7e85965fe702eb8164f21f450704bdde31faefd6471dba214cb594e"
+checksum = "534c5cf6194dfab3db3242765c03bbe257cf92f22b38f6bc0c58d59108a820ba"
 dependencies = [
  "libc",
- "windows-sys",
+ "windows-sys 0.52.0",
 ]
 
-[[package]]
-name = "fastrand"
-version = "2.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
-
 [[package]]
 name = "fish"
-version = "4.1.0"
+version = "4.0.8"
 dependencies = [
  "bitflags",
  "cc",
  "errno",
- "fish-build-helper",
- "fish-build-man-pages",
- "fish-gettext-extraction",
- "fish-gettext-maps",
- "fish-gettext-mo-file-parser",
  "fish-printf",
+ "lazy_static",
  "libc",
  "lru",
  "nix",
  "num-traits",
  "once_cell",
  "pcre2",
- "phf 0.12.1",
- "phf_codegen 0.12.1",
  "portable-atomic",
  "rand",
  "rsconf",
  "rust-embed",
  "serial_test",
  "terminfo",
- "unix_path",
  "widestring",
 ]
 
-[[package]]
-name = "fish-build-helper"
-version = "0.0.0"
-dependencies = [
- "rsconf",
-]
-
-[[package]]
-name = "fish-build-man-pages"
-version = "0.0.0"
-dependencies = [
- "fish-build-helper",
- "rsconf",
-]
-
-[[package]]
-name = "fish-gettext-extraction"
-version = "0.0.0"
-dependencies = [
- "proc-macro2",
-]
-
-[[package]]
-name = "fish-gettext-maps"
-version = "0.0.0"
-dependencies = [
- "fish-build-helper",
- "fish-gettext-mo-file-parser",
- "phf 0.12.1",
- "phf_codegen 0.12.1",
- "rsconf",
-]
-
-[[package]]
-name = "fish-gettext-mo-file-parser"
-version = "0.0.0"
-
 [[package]]
 name = "fish-printf"
 version = "0.2.1"
@@ -189,9 +152,9 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
 [[package]]
 name = "foldhash"
-version = "0.1.4"
+version = "0.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a0d2fde1f7b3d48b8395d5f2de76c18a528bd6a9cdde438df747bfcba3e05d6f"
+checksum = "f81ec6369c545a7d40e4589b5597581fa1c441fe1cce96dd1de43159910a36a2"
 
 [[package]]
 name = "generic-array"
@@ -205,9 +168,15 @@ dependencies = [
 
 [[package]]
 name = "hashbrown"
-version = "0.15.2"
+version = "0.14.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bf151400ff0baff5465007dd2f3e717f3fe502074ca563069ce3a6629d07b289"
+checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
+
+[[package]]
+name = "hashbrown"
+version = "0.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e087f84d4f86bf4b218b927129862374b72199ae7d8657835f1e89000eea4fb"
 dependencies = [
  "allocator-api2",
  "equivalent",
@@ -224,10 +193,16 @@ dependencies = [
 ]
 
 [[package]]
-name = "libc"
-version = "0.2.172"
+name = "lazy_static"
+version = "1.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d750af042f7ef4f724306de029d18836c26c1765a54a6a3f094cbd23a7267ffa"
+checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
+
+[[package]]
+name = "libc"
+version = "0.2.159"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "561d97a539a36e26a9a5fad1ea11a3039a67714694aaa379433e580854bc3dc5"
 
 [[package]]
 name = "lock_api"
@@ -247,11 +222,11 @@ checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
 
 [[package]]
 name = "lru"
-version = "0.13.0"
+version = "0.12.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "227748d55f2f0ab4735d87fd623798cb6b664512fe979705f829c9f81c934465"
+checksum = "234cf4f4a04dc1f57e24b96cc0cd600cf2af460d4161ac5ecdd0af8e1f3b2a38"
 dependencies = [
- "hashbrown",
+ "hashbrown 0.15.0",
 ]
 
 [[package]]
@@ -268,9 +243,9 @@ checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
 
 [[package]]
 name = "nix"
-version = "0.30.1"
+version = "0.29.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "74523f3a35e05aba87a1d978330aef40f67b0304ac79c1c00b294c9830543db6"
+checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46"
 dependencies = [
  "bitflags",
  "cfg-if",
@@ -348,76 +323,38 @@ dependencies = [
 
 [[package]]
 name = "phf"
-version = "0.11.3"
+version = "0.11.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1fd6780a80ae0c52cc120a26a1a42c1ae51b247a253e4e06113d23d2c2edd078"
+checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc"
 dependencies = [
- "phf_shared 0.11.3",
-]
-
-[[package]]
-name = "phf"
-version = "0.12.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "913273894cec178f401a31ec4b656318d95473527be05c0752cc41cdc32be8b7"
-dependencies = [
- "phf_shared 0.12.1",
+ "phf_shared",
 ]
 
 [[package]]
 name = "phf_codegen"
-version = "0.11.3"
+version = "0.11.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aef8048c789fa5e851558d709946d6d79a8ff88c0440c587967f8e94bfb1216a"
+checksum = "e8d39688d359e6b34654d328e262234662d16cc0f60ec8dcbe5e718709342a5a"
 dependencies = [
- "phf_generator 0.11.3",
- "phf_shared 0.11.3",
-]
-
-[[package]]
-name = "phf_codegen"
-version = "0.12.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "efbdcb6f01d193b17f0b9c3360fa7e0e620991b193ff08702f78b3ce365d7e61"
-dependencies = [
- "phf_generator 0.12.1",
- "phf_shared 0.12.1",
+ "phf_generator",
+ "phf_shared",
 ]
 
 [[package]]
 name = "phf_generator"
-version = "0.11.3"
+version = "0.11.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3c80231409c20246a13fddb31776fb942c38553c51e871f8cbd687a4cfb5843d"
+checksum = "48e4cc64c2ad9ebe670cb8fd69dd50ae301650392e81c05f9bfcb2d5bdbc24b0"
 dependencies = [
- "phf_shared 0.11.3",
+ "phf_shared",
  "rand",
 ]
 
-[[package]]
-name = "phf_generator"
-version = "0.12.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2cbb1126afed61dd6368748dae63b1ee7dc480191c6262a3b4ff1e29d86a6c5b"
-dependencies = [
- "fastrand",
- "phf_shared 0.12.1",
-]
-
 [[package]]
 name = "phf_shared"
-version = "0.11.3"
+version = "0.11.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5"
-dependencies = [
- "siphasher",
-]
-
-[[package]]
-name = "phf_shared"
-version = "0.12.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "06005508882fb681fd97892ecff4b7fd0fee13ef1aa569f8695dae7ab9099981"
+checksum = "90fcb95eef784c2ac79119d1dd819e162b5da872ce6f3c3abe1e8ca1c082f72b"
 dependencies = [
  "siphasher",
 ]
@@ -430,24 +367,24 @@ checksum = "953ec861398dccce10c670dfeaf3ec4911ca479e9c02154b3a215178c5f566f2"
 
 [[package]]
 name = "portable-atomic"
-version = "1.10.0"
+version = "1.9.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "280dc24453071f1b63954171985a0b0d30058d287960968b9b2aca264c8d4ee6"
+checksum = "cc9c68a3f6da06753e9335d63e27f6b9754dd1920d941135b7ea8224f141adb2"
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.95"
+version = "1.0.87"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "02b3e5e68a3a1a02aad3ec490a98007cbc13c37cbe84a3cd7b8e406d76e7f778"
+checksum = "b3e4daa0dcf6feba26f985457cdf104d4b4256fc5a09547140f3631bb076b19a"
 dependencies = [
  "unicode-ident",
 ]
 
 [[package]]
 name = "quote"
-version = "1.0.40"
+version = "1.0.37"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d"
+checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
 dependencies = [
  "proc-macro2",
 ]
@@ -469,9 +406,9 @@ checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
 
 [[package]]
 name = "redox_syscall"
-version = "0.5.8"
+version = "0.5.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "03a862b389f93e68874fbf580b9de08dd02facb9a788ebadaf4a3fd33cf58834"
+checksum = "9b6dfecf2c74bce2466cabf93f6664d6998a69eb21e39f4207930065b27b771f"
 dependencies = [
  "bitflags",
 ]
@@ -487,9 +424,9 @@ dependencies = [
 
 [[package]]
 name = "rust-embed"
-version = "8.7.2"
+version = "8.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "025908b8682a26ba8d12f6f2d66b987584a4a87bc024abc5bbc12553a8cd178a"
+checksum = "fa66af4a4fdd5e7ebc276f115e895611a34739a9c1c01028383d612d550953c0"
 dependencies = [
  "rust-embed-impl",
  "rust-embed-utils",
@@ -498,22 +435,22 @@ dependencies = [
 
 [[package]]
 name = "rust-embed-impl"
-version = "8.7.2"
+version = "8.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6065f1a4392b71819ec1ea1df1120673418bf386f50de1d6f54204d836d4349c"
+checksum = "6125dbc8867951125eec87294137f4e9c2c96566e61bf72c45095a7c77761478"
 dependencies = [
  "proc-macro2",
  "quote",
  "rust-embed-utils",
- "syn",
+ "syn 2.0.79",
  "walkdir",
 ]
 
 [[package]]
 name = "rust-embed-utils"
-version = "8.7.2"
+version = "8.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f6cc0c81648b20b70c491ff8cce00c1c3b223bb8ed2b5d41f0e54c6c4c0a3594"
+checksum = "2e5347777e9aacb56039b0e1f28785929a8a3b709e87482e7442c72e7c12529d"
 dependencies = [
  "sha2",
  "walkdir",
@@ -528,48 +465,33 @@ dependencies = [
  "winapi-util",
 ]
 
-[[package]]
-name = "scc"
-version = "2.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "28e1c91382686d21b5ac7959341fcb9780fa7c03773646995a87c950fa7be640"
-dependencies = [
- "sdd",
-]
-
 [[package]]
 name = "scopeguard"
 version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
-[[package]]
-name = "sdd"
-version = "3.0.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "478f121bb72bbf63c52c93011ea1791dca40140dfe13f8336c4c5ac952c33aa9"
-
 [[package]]
 name = "serial_test"
-version = "3.2.0"
+version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1b258109f244e1d6891bf1053a55d63a5cd4f8f4c30cf9a1280989f80e7a1fa9"
+checksum = "538c30747ae860d6fb88330addbbd3e0ddbe46d662d032855596d8a8ca260611"
 dependencies = [
- "once_cell",
+ "dashmap",
+ "lazy_static",
  "parking_lot",
- "scc",
  "serial_test_derive",
 ]
 
 [[package]]
 name = "serial_test_derive"
-version = "3.2.0"
+version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5d69265a08751de7844521fd15003ae0a888e035773ba05695c5c759a6f89eef"
+checksum = "079a83df15f85d89a68d64ae1238f142f172b1fa915d0d76b26a7cba1b659a69"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn",
+ "syn 1.0.109",
 ]
 
 [[package]]
@@ -591,9 +513,9 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "siphasher"
-version = "1.0.1"
+version = "0.3.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d"
+checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d"
 
 [[package]]
 name = "smallvec"
@@ -603,9 +525,20 @@ checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67"
 
 [[package]]
 name = "syn"
-version = "2.0.95"
+version = "1.0.109"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "46f71c0377baf4ef1cc3e3402ded576dccc315800fbc62dfc7fe04b009773b4a"
+checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.79"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "89132cd0bf050864e1d38dc3bbc07a0eb8e7530af26344d3d2bbbef83499f590"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -620,8 +553,8 @@ checksum = "d4ea810f0692f9f51b382fff5893887bb4580f5fa246fde546e0b13e7fcee662"
 dependencies = [
  "fnv",
  "nom",
- "phf 0.11.3",
- "phf_codegen 0.11.3",
+ "phf",
+ "phf_codegen",
 ]
 
 [[package]]
@@ -632,9 +565,9 @@ checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.14"
+version = "1.0.13"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
+checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe"
 
 [[package]]
 name = "unicode-segmentation"
@@ -648,21 +581,6 @@ version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1fc81956842c57dac11422a97c3b8195a1ff727f06e85c84ed2e8aa277c9a0fd"
 
-[[package]]
-name = "unix_path"
-version = "1.0.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "af8e291873ae77c4c8d9c9b34d0bee68a35b048fb39c263a5155e0e353783eaf"
-dependencies = [
- "unix_str",
-]
-
-[[package]]
-name = "unix_str"
-version = "1.0.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2ace0b4755d0a2959962769239d56267f8a024fef2d9b32666b3dcd0946b0906"
-
 [[package]]
 name = "version_check"
 version = "0.9.5"
@@ -681,9 +599,9 @@ dependencies = [
 
 [[package]]
 name = "widestring"
-version = "1.2.0"
+version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dd7cf3379ca1aac9eea11fba24fd7e315d621f8dfe35c8d7d2be8b793726e07d"
+checksum = "7219d36b6eac893fa81e84ebe06485e7dcbb616177469b142df14f1f4deb1311"
 
 [[package]]
 name = "winapi-util"
@@ -691,7 +609,16 @@ version = "0.1.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb"
 dependencies = [
- "windows-sys",
+ "windows-sys 0.59.0",
+]
+
+[[package]]
+name = "windows-sys"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d"
+dependencies = [
+ "windows-targets",
 ]
 
 [[package]]

Cargo.toml

@@ -1,58 +1,10 @@
 [workspace]
 resolver = "2"
-members = ["crates/*"]
+members = ["printf"]
 
 [workspace.package]
-# To build revisions that use Corrosion (those before 2024-01), use CMake 3.19, Rustc 1.78 and Rustup 1.27.
 rust-version = "1.70"
 edition = "2021"
-repository = "https://github.com/fish-shell/fish-shell"
-
-[workspace.dependencies]
-bitflags = "2.5.0"
-cc = "1.0.94"
-errno = "0.3.0"
-fish-build-helper = { path = "crates/build-helper" }
-fish-build-man-pages = { path = "crates/build-man-pages" }
-fish-gettext-extraction = { path = "crates/gettext-extraction" }
-fish-gettext-maps = { path = "crates/gettext-maps" }
-fish-gettext-mo-file-parser = { path = "crates/gettext-mo-file-parser" }
-fish-printf = { path = "crates/printf", features = ["widestring"] }
-libc = "0.2.155"
-# lru pulls in hashbrown by default, which uses a faster (though less DoS resistant) hashing algo.
-# disabling default features uses the stdlib instead, but it doubles the time to rewrite the history
-# files as of 22 April 2024.
-lru = "0.13.0"
-nix = { version = "0.30.1", default-features = false, features = [
-    "event",
-    "inotify",
-    "resource",
-    "fs",
-] }
-num-traits = "0.2.19"
-once_cell = "1.19.0"
-pcre2 = { git = "https://github.com/fish-shell/rust-pcre2", tag = "0.2.9-utf32", default-features = false, features = [
-    "utf32",
-] }
-phf = { version = "0.12", default-features = false }
-phf_codegen = { version = "0.12" }
-portable-atomic = { version = "1", default-features = false, features = [
-    "fallback",
-] }
-proc-macro2 = "1.0"
-# Don't use the "getrandom" feature as it requires "getentropy" which was not
-# available on macOS < 10.12. We can enable "getrandom" when we raise the
-# minimum supported version to 10.12.
-rand = { version = "0.8.5", default-features = false, features = ["small_rng"] }
-rsconf = "0.2.2"
-rust-embed = { version = "8.7.2", features = ["deterministic-timestamps"] }
-serial_test = { version = "3", default-features = false }
-# We need 0.9.0 specifically for some crash fixes.
-terminfo = "0.9.0"
-widestring = "1.2.0"
-unicode-segmentation = "1.12.0"
-unicode-width = "0.2.0"
-unix_path = "1.0.1"
 
 [profile.release]
 overflow-checks = true
@@ -64,55 +16,60 @@ debug = true
 
 [package]
 name = "fish"
-version = "4.1.0"
+version = "4.0.8"
 edition.workspace = true
 rust-version.workspace = true
 default-run = "fish"
 # see doc_src/license.rst for details
 # don't forget to update COPYING and debian/copyright too
 license = "GPL-2.0-only AND LGPL-2.0-or-later AND MIT AND PSF-2.0"
+repository = "https://github.com/fish-shell/fish-shell"
 homepage = "https://fishshell.com"
 readme = "README.rst"
 
 [dependencies]
-bitflags.workspace = true
-errno.workspace = true
-fish-build-helper.workspace = true
-fish-build-man-pages = { workspace = true, optional = true }
-fish-gettext-extraction = { workspace = true, optional = true }
-fish-gettext-maps = { workspace = true, optional = true }
-fish-printf.workspace = true
-libc.workspace = true
-lru.workspace = true
-nix.workspace = true
-num-traits.workspace = true
-once_cell.workspace = true
-pcre2.workspace = true
-phf = { workspace = true, optional = true }
-rand.workspace = true
-terminfo.workspace = true
-widestring.workspace = true
+pcre2 = { git = "https://github.com/fish-shell/rust-pcre2", tag = "0.2.9-utf32", default-features = false, features = [
+    "utf32",
+] }
+
+bitflags = "2.5.0"
+errno = "0.3.0"
+lazy_static = "1.4.0"
+libc = "0.2.155"
+# lru pulls in hashbrown by default, which uses a faster (though less DoS resistant) hashing algo.
+# disabling default features uses the stdlib instead, but it doubles the time to rewrite the history
+# files as of 22 April 2024.
+lru = "0.12.3"
+nix = { version = "0.29.0", default-features = false, features = [
+    "event",
+    "inotify",
+    "resource",
+    "fs",
+] }
+num-traits = "0.2.19"
+once_cell = "1.19.0"
+fish-printf = { path = "./printf", features = ["widestring"] }
+
+# Don't use the "getrandom" feature as it requires "getentropy" which was not
+# available on macOS < 10.12. We can enable "getrandom" when we raise the
+# minimum supported version to 10.12.
+rand = { version = "0.8.5", default-features = false, features = ["small_rng"] }
+widestring = "1.1.0"
+# We need 0.9.0 specifically for some crash fixes.
+terminfo = "0.9.0"
+rust-embed = { version = "8.2.0", optional = true }
 
 [target.'cfg(not(target_has_atomic = "64"))'.dependencies]
-portable-atomic.workspace = true
-
-[target.'cfg(windows)'.dependencies]
-rust-embed = { workspace = true, optional = true, features = ["deterministic-timestamps", "debug-embed"] }
-[target.'cfg(not(windows))'.dependencies]
-rust-embed = { workspace = true, optional = true, features = ["deterministic-timestamps"] }
+portable-atomic = { version = "1", default-features = false, features = [
+    "fallback",
+] }
 
 [dev-dependencies]
-serial_test.workspace = true
+serial_test = { version = "1.0.0", default-features = false }
 
 [build-dependencies]
-cc.workspace = true
-fish-build-helper.workspace = true
-fish-gettext-mo-file-parser.workspace = true
-phf_codegen = { workspace = true, optional = true }
-rsconf.workspace = true
-
-[target.'cfg(windows)'.build-dependencies]
-unix_path.workspace = true
+cc = "1.0.94"
+rsconf = "0.2.2"
 
 [lib]
 crate-type = ["rlib"]
@@ -131,23 +88,15 @@ name = "fish_key_reader"
 path = "src/bin/fish_key_reader.rs"
 
 [features]
-default = ["embed-data", "localize-messages"]
+default = ["installable"]
 benchmark = []
-embed-data = ["dep:rust-embed", "dep:fish-build-man-pages"]
-# Enable gettext localization at runtime. Requires the `msgfmt` tool to generate catalog data at
-# build time.
-localize-messages = ["dep:phf", "dep:fish-gettext-maps"]
-# This feature is used to enable extracting messages from the source code for localization.
-# It only needs to be enabled if updating these messages (and the corresponding PO files) is
-# desired. This happens when running tests via `build_tools/check.sh` and when calling
-# `build_tools/update_translations.fish`, so there should not be a need to enable it manually.
-gettext-extract = ["dep:fish-gettext-extraction"]
+installable = ["dep:rust-embed"]
 
 # The following features are auto-detected by the build-script and should not be enabled manually.
 asan = []
 tsan = []
 
-[workspace.lints]
+[lints]
 rust.non_camel_case_types = "allow"
 rust.non_upper_case_globals = "allow"
 rust.unknown_lints = "allow"
@@ -155,12 +104,3 @@ rust.unstable_name_collisions = "allow"
 clippy.manual_range_contains = "allow"
 clippy.needless_return = "allow"
 clippy.needless_lifetimes = "allow"
-
-# We do not want to use the e?print(ln)?! macros.
-# These lints flag their use.
-# In the future, they might change to flag other methods of printing.
-clippy.print_stdout = "deny"
-clippy.print_stderr = "deny"
-
-[lints]
-workspace = true

Dockerfile

@@ -16,3 +16,4 @@ WORKDIR /src
 RUN cmake3 . &&\
   make &&\
   make install
+

README.rst

@@ -47,12 +47,12 @@ 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-4>`__,
+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-4
+   sudo apt-add-repository ppa:fish-shell/release-3
    sudo apt update
    sudo apt install fish
 
@@ -66,8 +66,7 @@ Windows
    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/>`__ or `MSYS2 <https://github.com/Berrysoft/fish-msys2>`__.
+-  fish (4.0 on and onwards) cannot be installed in Cygwin, due to a lack of Rust support.
 
 Building from source
 ~~~~~~~~~~~~~~~~~~~~
@@ -76,7 +75,7 @@ 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.
+`Building <#building>`__ section for instructions.
 
 Running fish
 ------------
@@ -88,16 +87,21 @@ Dependencies
 
 Running fish requires:
 
+-  A terminfo database, typically from curses or ncurses (preinstalled on most \*nix systems) - this needs to be the directory tree format, not the "hashed" database.
+   If this is unavailable, fish uses an included xterm-256color definition.
 -  some common \*nix system utilities (currently ``mktemp``), in
    addition to the basic POSIX utilities (``cat``, ``cut``, ``dirname``,
-   ``file``, ``ls``, ``mkdir``, ``mkfifo``, ``rm``, ``sh``, ``sort``, ``tee``, ``tr``,
+   ``file``, ``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 ``man`` for display
+   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
@@ -122,13 +126,13 @@ Compiling fish requires:
 -  CMake (version 3.15 or later)
 -  a C compiler (for system feature detection and the test helper binary)
 -  PCRE2 (headers and libraries) - optional, this will be downloaded if missing
--  gettext (only the msgfmt tool) - optional, for translation support
+-  gettext (headers and libraries) - optional, for translation support
 -  an Internet connection, as other dependencies will be downloaded automatically
 
 Sphinx is also optionally required to build the documentation from a
 cloned git repository.
 
-Additionally, running the full test suite requires Python 3.5+, tmux, and the pexpect package.
+Additionally, running the full test suite requires Python 3, tmux, and the pexpect package.
 
 Building from source with CMake
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -155,42 +159,38 @@ CMake Build options
 
 In addition to the normal CMake build options (like ``CMAKE_INSTALL_PREFIX``), fish's CMake build has some other options available to customize it.
 
-- Rust_COMPILER=path - the path to rustc. If not set, cmake will check $PATH and ~/.cargo/bin
-- Rust_CARGO=path - the path to cargo. If not set, cmake will check $PATH and ~/.cargo/bin
-- Rust_CARGO_TARGET=target - the target to pass to cargo. Set this for cross-compilation.
 - 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 include translations.
+- WITH_GETTEXT=ON|OFF - whether to build with gettext support for translations.
 - extra_functionsdir, extra_completionsdir and extra_confdir - to compile in an additional directory to be searched for functions, completions and configuration snippets
 
-Building fish with embedded data (experimental)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Building fish as self-installable (experimental)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can also build fish with the data files embedded.
+You can also build fish as a self-installing binary.
 
 This will include all the datafiles like the included functions or web configuration tool in the main ``fish`` binary.
 
-Fish will then read these right from its own binary, and print them out when needed. Some files, like the webconfig tool and the manpage completion generator, will be extracted to a temporary directory on-demand. You can list the files with ``status list-files`` and print one with ``status get-file path/to/file`` (e.g. ``status get-file functions/fish_prompt.fish`` to get the default prompt).
+On the first interactive run, and whenever it notices they are out of date, it will extract the datafiles to ~/.local/share/fish/install/ (currently, subject to change). You can do this manually by running ``fish --install``.
 
-To install fish with embedded files, just use ``cargo``, like::
+To install fish as self-installable, just use ``cargo``, like::
 
    cargo install --path /path/to/fish # if you have a git clone
-   cargo install --git https://github.com/fish-shell/fish-shell --tag "$(curl -s https://api.github.com/repos/fish-shell/fish-shell/releases/latest | jq -r .tag_name)" # to build the latest release
-   cargo install --git https://github.com/fish-shell/fish-shell # to build the latest development snapshot
+   cargo install --git https://github.com/fish-shell/fish-shell --tag 4.0 # to build from git once 4.0 is released
+   cargo install --git https://github.com/fish-shell/fish-shell # to build the current development snapshot without cloning
 
 This will place the binaries in ``~/.cargo/bin/``, but you can place them wherever you want.
 
-This build won't have the HTML docs (``help`` will open the online version).
+This build won't have the HTML docs (``help`` will open the online version) or translations.
+
 It will try to build the man pages with sphinx-build. If that is not available and you would like to include man pages, you need to install it and retrigger the build script, e.g. by setting FISH_BUILD_DOCS=1::
 
   FISH_BUILD_DOCS=1 cargo install --path .
 
 Setting it to "0" disables the inclusion of man pages.
 
-To disable translations, disable the ``localize-messages`` feature by passing ``--no-default-features --features=embed-data`` to cargo.
-
 You can also link this build statically (but not against glibc) and move it to other computers.
 
 Contributing Changes to the Code

SECURITY.md

@@ -1,35 +0,0 @@
-# Security Reporting
-
-If you wish to report a security vulnerability privately, we appreciate your diligence. Please follow the guidelines below to submit your report.
-
-## Reporting
-
-To report a security vulnerability, please provide the following information:
-
-1. **PROJECT**
-
-    - Include the URL of the project repository - Example: <https://github.com/fish-shell/fish-shell>
-
-2. **PUBLIC**
-
-    - Indicate whether this vulnerability has already been publicly discussed or disclosed.
-    - If so, provide relevant links.
-
-3. **DESCRIPTION**
-    - Provide a detailed description of the security vulnerability.
-    - Include as much information as possible to help us understand and address the issue.
-
-Send this information, along with any additional relevant details, to <rf@fishshell.com>.
-
-## Confidentiality
-
-We kindly ask you to keep the report confidential until a public announcement is made.
-
-## Notes
-
--   Vulnerabilities will be handled on a best-effort basis.
--   You may request an advance copy of the patched release, but we cannot guarantee early access before the public release.
--   You will be notified via email simultaneously with the public announcement.
--   We will respond within a few weeks to confirm whether your report has been accepted or rejected.
-
-Thank you for helping to improve the security of our project!

benchmarks/benchmarks/load_completions.fish

@@ -8,4 +8,5 @@ for file in *.fish
             echo FAILING FILE $file
         end
     end
+
 end

benchmarks/driver.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-if [ "$#" -gt 2 ] || [ "$#" -eq 0 ]; then
+if [ "$#" -gt 2 -o "$#" -eq 0 ]; then
     echo "Usage: driver.sh /path/to/fish [/path/to/other/fish]"
     exit 1
 fi

build.rs

@@ -1,33 +1,32 @@
 #![allow(clippy::uninlined_format_args)]
 
-use fish_build_helper::{fish_build_dir, workspace_root};
-use rsconf::Target;
+use rsconf::{LinkType, Target};
 use std::env;
 use std::error::Error;
 use std::path::{Path, PathBuf};
 
-fn canonicalize<P: AsRef<Path>>(path: P) -> PathBuf {
-    std::fs::canonicalize(path).unwrap()
-}
-
 fn main() {
     setup_paths();
 
     // Add our default to enable tools that don't go through CMake, like "cargo test" and the
     // language server.
 
-    rsconf::set_env_value(
-        "FISH_BUILD_DIR",
-        // If set by CMake, this might include symlinks. Since we want to compare this to the
-        // dir fish is executed in we need to canonicalize it.
-        canonicalize(fish_build_dir()).to_str().unwrap(),
-    );
-
+    // FISH_BUILD_DIR is set by CMake, if we are using it.
+    // OUT_DIR is set by Cargo when the build script is running (not compiling)
+    let default_build_dir = env::var("OUT_DIR").unwrap();
+    let build_dir = option_env!("FISH_BUILD_DIR").unwrap_or(&default_build_dir);
+    let build_dir = std::fs::canonicalize(build_dir).unwrap();
+    let build_dir = build_dir.to_str().unwrap();
+    rsconf::set_env_value("FISH_BUILD_DIR", build_dir);
     // We need to canonicalize (i.e. realpath) the manifest dir because we want to be able to
     // compare it directly as a string at runtime.
     rsconf::set_env_value(
         "CARGO_MANIFEST_DIR",
-        canonicalize(workspace_root()).to_str().unwrap(),
+        std::fs::canonicalize(env!("CARGO_MANIFEST_DIR"))
+            .unwrap()
+            .as_path()
+            .to_str()
+            .unwrap(),
     );
 
     // Some build info
@@ -42,19 +41,23 @@ fn main() {
 
     std::env::set_var("FISH_BUILD_VERSION", version);
 
-    // These are necessary if built with embedded functions,
-    // but only in release builds (because rust-embed in debug builds reads from the filesystem).
-    #[cfg(feature = "embed-data")]
-    #[cfg(any(windows, not(debug_assertions)))]
-    rsconf::rebuild_if_path_changed("share");
-
-    #[cfg(feature = "gettext-extract")]
-    rsconf::rebuild_if_env_changed("FISH_GETTEXT_EXTRACTION_FILE");
-
+    #[cfg(feature = "installable")]
+    #[cfg(not(clippy))]
+    {
+        let cman = std::fs::canonicalize(env!("CARGO_MANIFEST_DIR")).unwrap();
+        let targetman = cman.as_path().join("target").join("man");
+        build_man(&targetman);
+    }
     rsconf::rebuild_if_path_changed("src/libc.c");
-    cc::Build::new().file("src/libc.c").compile("flibc.a");
+    cc::Build::new()
+        .file("src/libc.c")
+        .include(build_dir)
+        .compile("flibc.a");
 
-    let build = cc::Build::new();
+    let mut build = cc::Build::new();
+    // Add to the default library search path
+    build.flag_if_supported("-L/usr/local/lib/");
+    rsconf::add_library_search_path("/usr/local/lib");
     let mut target = Target::new_from(build).unwrap();
     // Keep verbose mode on until we've ironed out rust build script stuff
     target.set_verbose(true);
@@ -85,9 +88,8 @@ fn detect_cfgs(target: &mut Target) {
             "",
             &(|_: &Target| Ok(false)) as &dyn Fn(&Target) -> Result<bool, Box<dyn Error>>,
         ),
-        ("apple", &detect_apple),
         ("bsd", &detect_bsd),
-        ("cygwin", &detect_cygwin),
+        ("gettext", &have_gettext),
         ("small_main_stack", &has_small_stack),
         // See if libc supports the thread-safe localeconv_l(3) alternative to localeconv(3).
         ("localeconv_l", &|target| {
@@ -121,15 +123,6 @@ fn detect_cfgs(target: &mut Target) {
     }
 }
 
-fn detect_apple(_: &Target) -> Result<bool, Box<dyn Error>> {
-    Ok(cfg!(any(target_os = "ios", target_os = "macos")))
-}
-
-fn detect_cygwin(_: &Target) -> Result<bool, Box<dyn Error>> {
-    // Cygwin target is usually cross-compiled.
-    Ok(std::env::var("CARGO_CFG_TARGET_OS").unwrap() == "cygwin")
-}
-
 /// Detect if we're being compiled for a BSD-derived OS, allowing targeting code conditionally with
 /// `#[cfg(bsd)]`.
 ///
@@ -154,6 +147,51 @@ fn detect_bsd(_: &Target) -> Result<bool, Box<dyn Error>> {
     Ok(is_bsd)
 }
 
+/// Detect libintl/gettext and its needed symbols to enable internationalization/localization
+/// support.
+fn have_gettext(target: &Target) -> Result<bool, Box<dyn Error>> {
+    // The following script correctly detects and links against gettext, but so long as we are using
+    // C++ and generate a static library linked into the C++ binary via CMake, we need to account
+    // for the CMake option WITH_GETTEXT being explicitly disabled.
+    rsconf::rebuild_if_env_changed("CMAKE_WITH_GETTEXT");
+    if let Some(with_gettext) = std::env::var_os("CMAKE_WITH_GETTEXT") {
+        if with_gettext.eq_ignore_ascii_case("0") {
+            return Ok(false);
+        }
+    }
+
+    // In order for fish to correctly operate, we need some way of notifying libintl to invalidate
+    // its localizations when the locale environment variables are modified. Without the libintl
+    // symbol _nl_msg_cat_cntr, we cannot use gettext even if we find it.
+    let mut libraries = Vec::new();
+    let mut found = 0;
+    let symbols = ["gettext", "_nl_msg_cat_cntr"];
+    for symbol in &symbols {
+        // Historically, libintl was required in order to use gettext() and co, but that
+        // functionality was subsumed by some versions of libc.
+        if target.has_symbol(symbol) {
+            // No need to link anything special for this symbol
+            found += 1;
+            continue;
+        }
+        for library in ["intl", "gettextlib"] {
+            if target.has_symbol_in(symbol, &[library]) {
+                libraries.push(library);
+                found += 1;
+                continue;
+            }
+        }
+    }
+    match found {
+        0 => Ok(false),
+        1 => Err(format!("gettext found but cannot be used without {}", symbols[1]).into()),
+        _ => {
+            rsconf::link_libraries(&libraries, LinkType::Default);
+            Ok(true)
+        }
+    }
+}
+
 /// Rust sets the stack size of newly created threads to a sane value, but is at at the mercy of the
 /// OS when it comes to the size of the main stack. Some platforms we support default to a tiny
 /// 0.5 MiB main stack, which is insufficient for fish's MAX_EVAL_DEPTH/MAX_STACK_DEPTH values.
@@ -161,14 +199,14 @@ fn detect_bsd(_: &Target) -> Result<bool, Box<dyn Error>> {
 /// 0.5 MiB is small enough that we'd have to drastically reduce MAX_STACK_DEPTH to less than 10, so
 /// we instead use a workaround to increase the main thread size.
 fn has_small_stack(_: &Target) -> Result<bool, Box<dyn Error>> {
-    #[cfg(not(any(target_os = "ios", target_os = "macos", target_os = "netbsd")))]
+    #[cfg(not(any(target_os = "macos", target_os = "netbsd")))]
     return Ok(false);
 
     // NetBSD 10 also needs this but can't find pthread_get_stacksize_np.
     #[cfg(target_os = "netbsd")]
     return Ok(true);
 
-    #[cfg(any(target_os = "ios", target_os = "macos"))]
+    #[cfg(target_os = "macos")]
     {
         use core::ffi;
 
@@ -189,9 +227,6 @@ fn has_small_stack(_: &Target) -> Result<bool, Box<dyn Error>> {
 }
 
 fn setup_paths() {
-    #[cfg(windows)]
-    use unix_path::{Path, PathBuf};
-
     fn get_path(name: &str, default: &str, onvar: &Path) -> PathBuf {
         let mut var = PathBuf::from(env::var(name).unwrap_or(default.to_string()));
         if var.is_relative() {
@@ -200,44 +235,53 @@ fn get_path(name: &str, default: &str, onvar: &Path) -> PathBuf {
         var
     }
 
-    let prefix = PathBuf::from(env::var("PREFIX").unwrap_or("/usr/local".to_string()));
+    let (prefix_from_home, prefix) = if let Ok(pre) = env::var("PREFIX") {
+        (false, PathBuf::from(pre))
+    } else {
+        (true, PathBuf::from(".local/"))
+    };
+
+    // If someone gives us a $PREFIX, we need it to be absolute.
+    // Otherwise we would try to get it from $HOME and that won't really work.
+    if !prefix_from_home && prefix.is_relative() {
+        panic!("Can't have relative prefix");
+    }
+
     rsconf::rebuild_if_env_changed("PREFIX");
     rsconf::set_env_value("PREFIX", prefix.to_str().unwrap());
 
     let datadir = get_path("DATADIR", "share/", &prefix);
+    rsconf::set_env_value("DATADIR", datadir.to_str().unwrap());
+    rsconf::rebuild_if_env_changed("DATADIR");
+
+    let datadir_subdir = if prefix_from_home {
+        "fish/install"
+    } else {
+        "fish"
+    };
+    rsconf::set_env_value("DATADIR_SUBDIR", datadir_subdir);
+
+    let bindir = get_path("BINDIR", "bin/", &prefix);
+    rsconf::set_env_value("BINDIR", bindir.to_str().unwrap());
+    rsconf::rebuild_if_env_changed("BINDIR");
 
     let sysconfdir = get_path(
         "SYSCONFDIR",
-        // Embedded builds use "/etc," not "./share/etc".
-        if cfg!(feature = "embed-data") {
-            "/etc/"
-        } else {
-            "etc/"
-        },
+        // If we get our prefix from $HOME, we should use the system's /etc/
+        // ~/.local/share/etc/ makes no sense
+        if prefix_from_home { "/etc/" } else { "etc/" },
         &datadir,
     );
     rsconf::set_env_value("SYSCONFDIR", sysconfdir.to_str().unwrap());
     rsconf::rebuild_if_env_changed("SYSCONFDIR");
 
-    #[cfg(not(feature = "embed-data"))]
-    {
-        rsconf::set_env_value("DATADIR", datadir.to_str().unwrap());
-        rsconf::rebuild_if_env_changed("DATADIR");
+    let localedir = get_path("LOCALEDIR", "locale/", &datadir);
+    rsconf::set_env_value("LOCALEDIR", localedir.to_str().unwrap());
+    rsconf::rebuild_if_env_changed("LOCALEDIR");
 
-        let bindir = get_path("BINDIR", "bin/", &prefix);
-        rsconf::set_env_value("BINDIR", bindir.to_str().unwrap());
-        rsconf::rebuild_if_env_changed("BINDIR");
-
-        let localedir = get_path("LOCALEDIR", "locale/", &datadir);
-        let localedir = localedir.to_str().unwrap();
-        assert!(!localedir.is_empty(), "empty LOCALEDIR is not supported");
-        rsconf::set_env_value("LOCALEDIR", localedir);
-        rsconf::rebuild_if_env_changed("LOCALEDIR");
-
-        let docdir = get_path("DOCDIR", "doc/fish", &datadir);
-        rsconf::set_env_value("DOCDIR", docdir.to_str().unwrap());
-        rsconf::rebuild_if_env_changed("DOCDIR");
-    }
+    let docdir = get_path("DOCDIR", "doc/fish", &datadir);
+    rsconf::set_env_value("DOCDIR", docdir.to_str().unwrap());
+    rsconf::rebuild_if_env_changed("DOCDIR");
 }
 
 fn get_version(src_dir: &Path) -> String {
@@ -250,7 +294,7 @@ fn get_version(src_dir: &Path) -> String {
 
     let path = src_dir.join("version");
     if let Ok(strver) = read_to_string(path) {
-        return strver;
+        return strver.to_string();
     }
 
     let args = &["describe", "--always", "--dirty=-dirty"];
@@ -277,37 +321,17 @@ fn get_version(src_dir: &Path) -> String {
     // or because it refused (safe.directory applies to `git describe`!)
     // So we read the SHA ourselves.
     fn get_git_hash() -> Result<String, Box<dyn std::error::Error>> {
-        let workspace_root = workspace_root();
-        let gitdir = workspace_root.join(".git");
-        let jjdir = workspace_root.join(".jj");
-        let commit_id = if gitdir.exists() {
-            // .git/HEAD contains ref: refs/heads/branch
-            let headpath = gitdir.join("HEAD");
-            let headstr = read_to_string(headpath)?;
-            let headref = headstr.split(' ').nth(1).unwrap().trim();
+        let gitdir = Path::new(env!("CARGO_MANIFEST_DIR")).join(".git");
 
-            // .git/refs/heads/branch contains the SHA
-            let refpath = gitdir.join(headref);
-            // Shorten to 9 characters (what git describe does currently)
-            read_to_string(refpath)?
-        } else if jjdir.exists() {
-            let output = Command::new("jj")
-                .args([
-                    "log",
-                    "--revisions",
-                    "@",
-                    "--no-graph",
-                    "--ignore-working-copy",
-                    "--template",
-                    "commit_id",
-                ])
-                .output()
-                .unwrap();
-            String::from_utf8_lossy(&output.stdout).to_string()
-        } else {
-            return Err("did not find either of .git or .jj".into());
-        };
-        let refstr = &commit_id[0..9];
+        // .git/HEAD contains ref: refs/heads/branch
+        let headpath = gitdir.join("HEAD");
+        let headstr = read_to_string(headpath)?;
+        let headref = headstr.split(' ').collect::<Vec<_>>()[1].trim();
+
+        // .git/refs/heads/branch contains the SHA
+        let refpath = gitdir.join(headref);
+        // Shorten to 9 characters (what git describe does currently)
+        let refstr = &read_to_string(refpath)?[0..9];
         let refstr = refstr.trim();
 
         let version = env!("CARGO_PKG_VERSION").to_owned();
@@ -316,3 +340,74 @@ fn get_git_hash() -> Result<String, Box<dyn std::error::Error>> {
 
     get_git_hash().expect("Could not get a version. Either set $FISH_BUILD_VERSION or install git.")
 }
+
+#[cfg(feature = "installable")]
+// disable clippy because otherwise it would panic without sphinx
+#[cfg(not(clippy))]
+fn build_man(build_dir: &Path) {
+    use std::process::Command;
+    let mandir = build_dir;
+    let sec1dir = mandir.join("man1");
+    let docsrc_path = std::fs::canonicalize(env!("CARGO_MANIFEST_DIR"))
+        .unwrap()
+        .as_path()
+        .join("doc_src");
+    let docsrc = docsrc_path.to_str().unwrap();
+    let args = &[
+        "-j",
+        "auto",
+        "-q",
+        "-b",
+        "man",
+        "-c",
+        docsrc,
+        // doctree path - put this *above* the man1 dir to exclude it.
+        // this is ~6M
+        "-d",
+        mandir.to_str().unwrap(),
+        docsrc,
+        sec1dir.to_str().unwrap(),
+    ];
+    let _ = std::fs::create_dir_all(sec1dir.to_str().unwrap());
+
+    rsconf::rebuild_if_env_changed("FISH_BUILD_DOCS");
+    if env::var("FISH_BUILD_DOCS") == Ok("0".to_string()) {
+        println!("cargo:warning=Skipping man pages because $FISH_BUILD_DOCS is set to 0");
+        return;
+    }
+
+    // We run sphinx to build the man pages.
+    // Every error here is fatal so cargo doesn't cache the result
+    // - if we skipped the docs with sphinx not installed, installing it would not then build the docs.
+    // That means you need to explicitly set $FISH_BUILD_DOCS=0 (`FISH_BUILD_DOCS=0 cargo install --path .`),
+    // which is unfortunate - but the docs are pretty important because they're also used for --help.
+    match Command::new("sphinx-build").args(args).spawn() {
+        Err(x) if x.kind() == std::io::ErrorKind::NotFound => {
+            if env::var("FISH_BUILD_DOCS") == Ok("1".to_string()) {
+                panic!("Could not find sphinx-build to build man pages.\nInstall sphinx or disable building the docs by setting $FISH_BUILD_DOCS=0.");
+            }
+            println!("cargo:warning=Cannot find sphinx-build to build man pages.");
+            println!("cargo:warning=If you install it now you need to run `cargo clean` and rebuild, or set $FISH_BUILD_DOCS=1 explicitly.");
+        }
+        Err(x) => {
+            // Another error - permissions wrong etc
+            panic!("Error starting sphinx-build to build man pages: {:?}", x);
+        }
+        Ok(mut x) => match x.wait() {
+            Err(err) => {
+                panic!(
+                    "Error waiting for sphinx-build to build man pages: {:?}",
+                    err
+                );
+            }
+            Ok(out) => {
+                if out.success() {
+                    // Success!
+                    return;
+                } else {
+                    panic!("sphinx-build failed to build the man pages.");
+                }
+            }
+        },
+    }
+}

build_tools/check.sh

@@ -1,62 +0,0 @@
-#!/bin/sh
-
-{
-set -ex
-
-lint=true
-if [ "$FISH_CHECK_LINT" = false ]; then
-    lint=false
-fi
-
-cargo_args=$FISH_CHECK_CARGO_ARGS
-target_triple=$FISH_CHECK_TARGET_TRIPLE
-if [ -n "$target_triple" ]; then
-    cargo_args="$cargo_args --target=$FISH_CHECK_TARGET_TRIPLE"
-fi
-
-cargo() {
-    subcmd=$1
-    shift
-    # shellcheck disable=2086
-    command cargo "$subcmd" $cargo_args "$@"
-}
-
-cleanup () {
-    if [ -n "$template_file" ] && [ -e "$template_file" ]; then
-        rm "$template_file"
-    fi
-}
-
-trap cleanup EXIT INT TERM HUP
-
-if $lint; then
-    export RUSTFLAGS="--deny=warnings ${RUSTFLAGS}"
-    export RUSTDOCFLAGS="--deny=warnings ${RUSTDOCFLAGS}"
-fi
-
-workspace_root="$(dirname "$0")/.."
-target_dir=${CARGO_TARGET_DIR:-$workspace_root/target}
-if [ -n "$target_triple" ]; then
-    target_dir="$target_dir/$target_triple"
-fi
-# The directory containing the binaries produced by cargo/rustc.
-# Currently, all builds are debug builds.
-build_dir="$target_dir/debug"
-
-template_file=$(mktemp)
-FISH_GETTEXT_EXTRACTION_FILE=$template_file cargo build --workspace --all-targets --features=gettext-extract
-if $lint; then
-    PATH="$build_dir:$PATH" "$workspace_root/build_tools/style.fish" --all --check
-    for features in "" --no-default-features; do
-        cargo clippy --workspace --all-targets $features
-    done
-fi
-cargo test --no-default-features --workspace --all-targets
-cargo test --doc --workspace
-if $lint; then
-    cargo doc --workspace
-fi
-FISH_GETTEXT_EXTRACTION_FILE=$template_file "$workspace_root/tests/test_driver.py" "$build_dir"
-
-exit
-}

build_tools/diff_profiles.fish

@@ -5,13 +5,6 @@
 #
 # Usage: ./diff_profiles.fish profile1.log profile2.log > profile_diff.log
 
-if test (count $argv) -ne 2
-
-    echo "Incorrect number of arguments."
-    echo "Usage: "(status filename)" profile1.log profile2.log"
-    exit 1
-end
-
 set -l profile1 (cat $argv[1])
 set -l profile2 (cat $argv[2])
 
@@ -22,13 +15,13 @@ while set -l next_line_no (math $line_no + 1) && set -q profile1[$next_line_no]
     set -l line1 $profile1[$line_no]
     set -l line2 $profile2[$line_no]
 
-    if not string match -qr '^\s*\d+\s+\d+' $line1
+    if not string match -qr '^\d+\t\d+' $line1
         echo $line1
         continue
     end
 
-    set -l results1 (string match -r '^\s*(\d+)\s+(\d+)\s+(.*)' $line1)
-    set -l results2 (string match -r '^\s*(\d+)\s+(\d+)\s+(.*)' $line2)
+    set -l results1 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line1)
+    set -l results2 (string match -r '^(\d+)\t(\d+)\s+(.*)' $line2)
 
     # times from both files
     set -l time1 $results1[2..3]
@@ -49,5 +42,5 @@ while set -l next_line_no (math $line_no + 1) && set -q profile1[$next_line_no]
     set diff[1] (math $time1[1] - $time2[1])
     set diff[2] (math $time1[2] - $time2[2])
 
-    printf '%10d %10d %s\n' $diff[1] $diff[2] $remainder1
+    echo $diff[1] $diff[2] $remainder1
 end

build_tools/fish_xgettext.fish

@@ -1,87 +1,68 @@
 #!/usr/bin/env fish
 #
-# Tool to generate gettext messages template file.
-# Writes to stdout.
-# Intended to be called from `update_translations.fish`.
+# Tool to generate messages.pot
 
-argparse use-existing-template= -- $argv
-or exit $status
+# Create temporary directory for these operations. OS X `mktemp` is somewhat restricted, so this block
+# works around that - based on share/functions/funced.fish.
+set -q TMPDIR
+or set -l TMPDIR /tmp
+set -l tmpdir (mktemp -d $TMPDIR/fish.XXXXXX)
+or exit 1
 
-begin
-    # Write header. This is required by msguniq.
-    # Note that this results in the file being overwritten.
-    # This is desired behavior, to get rid of the results of prior invocations
-    # of this script.
-    begin
-        echo 'msgid ""'
-        echo 'msgstr ""'
-        echo '"Content-Type: text/plain; charset=UTF-8\n"'
-        echo ""
-    end
+# This is a gigantic crime.
+# xgettext still does not support rust *at all*, so we use cargo-expand to get all our wgettext invocations.
+set -l expanded (cargo expand --lib; for f in fish{,_indent,_key_reader}; cargo expand --bin $f; end)
 
-    set -g workspace_root (status dirname)/..
+# Extract any gettext call
+set -l strs (printf '%s\n' $expanded | grep -A1 wgettext_static_str |
+             grep 'widestring::internals::core::primitive::str =' |
+             string match -rg '"(.*)"' | string match -rv '^%ls$|^$' |
+             # escaping difference between gettext and cargo-expand: single-quotes
+             string replace -a "\'" "'" | sort -u)
 
-    set -l rust_extraction_file
-    if set -l --query _flag_use_existing_template
-        set rust_extraction_file $_flag_use_existing_template
-    else
-        set rust_extraction_file (mktemp)
-        # We need to build to ensure that the proc macro for extracting strings runs.
-        FISH_GETTEXT_EXTRACTION_FILE=$rust_extraction_file cargo check --features=gettext-extract
-        or exit 1
-    end
+# Extract any constants
+set -a strs (string match -rv 'BUILD_VERSION:|PACKAGE_NAME' -- $expanded |
+             string match -rg 'const [A-Z_]*: &str = "(.*)"' | string replace -a "\'" "'")
 
-    # Get rid of duplicates and sort.
-    msguniq --no-wrap --strict --sort-output $rust_extraction_file
-    or exit 1
+# We construct messages.pot ourselves instead of forcing this into msgmerge or whatever.
+# The escaping so far works out okay.
+for str in $strs
+    # grep -P needed for string escape to be compatible (PCRE-style),
+    # -H gives the filename, -n the line number.
+    # If you want to run this on non-GNU grep: Don't.
+    echo "#:" (grep -PHn -r -- (string escape --style=regex -- $str) src/ |
+    head -n1 | string replace -r ':\s.*' '')
+    echo "msgid \"$str\""
+    echo 'msgstr ""'
+end >messages.pot
 
-    if not set -l --query _flag_use_existing_template
-        rm $rust_extraction_file
-    end
+# This regex handles descriptions for `complete` and `function` statements. These messages are not
+# particularly important to translate. Hence the "implicit" label.
+set -l implicit_regex '(?:^| +)(?:complete|function).*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
 
-    function extract_fish_script_messages --argument-names regex
+# This regex handles explicit requests to translate a message. These are more important to translate
+# than messages which should be implicitly translated.
+set -l explicit_regex '.*\( *_ (([\'"]).+?(?<!\\\\)\\2) *\).*'
 
-        # Using xgettext causes more trouble than it helps.
-        # This is due to handling of escaping in fish differing from formats xgettext understands
-        # (e.g. POSIX shell strings).
-        # We work around this issue by manually writing the file content.
+mkdir -p $tmpdir/implicit/share/completions $tmpdir/implicit/share/functions
+mkdir -p $tmpdir/explicit/share/completions $tmpdir/explicit/share/functions
 
-        # Steps:
-        # 1. We extract strings to be translated from the relevant files and drop the rest. This step
-        #    depends on the regex matching the entire line, and the first capture group matching the
-        #    string.
-        # 2. We unescape. This gets rid of some escaping necessary in fish strings.
-        # 3. The resulting strings are sorted alphabetically. This step is optional. Not sorting would
-        #    result in strings from the same file appearing together. Removing duplicates is also
-        #    optional, since msguniq takes care of that later on as well.
-        # 4. Single backslashes are replaced by double backslashes. This results in the backslashes
-        #    being interpreted as literal backslashes by gettext tooling.
-        # 5. Double quotes are escaped, such that they are not interpreted as the start or end of
-        #    a msgid.
-        # 6. We transform the string into the format expected in a PO file.
-        cat $share_dir/config.fish $share_dir/completions/*.fish $share_dir/functions/*.fish |
-            string replace --filter --regex $regex '$1' |
-            string unescape |
-            sort -u |
-            sed -E -e 's_\\\\_\\\\\\\\_g' -e 's_"_\\\\"_g' -e 's_^(.*)$_msgid "\1"\nmsgstr ""\n_'
-    end
+for f in share/config.fish share/completions/*.fish share/functions/*.fish
+    # Extract explicit attempts to translate a message. That is, those that are of the form
+    # `(_ "message")`.
+    string replace --filter --regex $explicit_regex '$1' <$f | string unescape \
+        | string replace --all '"' '\\"' | string replace -r '(.*)' 'N_ "$1"' >$tmpdir/explicit/$f
 
-    set -g share_dir $workspace_root/share
+    # Handle `complete` / `function` description messages. The `| fish` is subtle. It basically
+    # avoids the need to use `source` with a command substitution that could affect the current
+    # shell.
+    string replace --filter --regex $implicit_regex '$1' <$f | string unescape \
+        | string replace --all '"' '\\"' | string replace -r '(.*)' 'N_ "$1"' >$tmpdir/implicit/$f
+end
 
-    # This regex handles explicit requests to translate a message. These are more important to translate
-    # than messages which should be implicitly translated.
-    set -l explicit_regex '.*\( *_ (([\'"]).+?(?<!\\\\)\\2) *\).*'
-    extract_fish_script_messages $explicit_regex
+xgettext -j -k -kN_ -LShell --from-code=UTF-8 -cDescription --no-wrap -o messages.pot $tmpdir/{ex,im}plicit/share/*/*.fish
 
-    # This regex handles descriptions for `complete` and `function` statements. These messages are not
-    # particularly important to translate. Hence the "implicit" label.
-    set -l implicit_regex '^(?:\s|and |or )*(?:complete|function).*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
-    extract_fish_script_messages $implicit_regex
-end |
-    # At this point, all extracted strings have been written to stdout,
-    # starting with the ones taken from the Rust sources,
-    # followed by strings explicitly marked for translation in fish scripts,
-    # and finally the strings from fish scripts which get translated implicitly.
-    # Because we do not eliminate duplicates across these categories,
-    # we do it here, since other gettext tools expect no duplicates.
-    msguniq --no-wrap
+# Remove the tmpdir from the location to avoid churn
+sed -i 's_^#: /.*/share/_#: share/_' messages.pot
+
+rm -r $tmpdir

build_tools/git_version_gen.sh

@@ -47,7 +47,7 @@ then
     # HACK: Git failed, so we keep the current version file.
     # This helps in case you built fish as a normal user
     # and then try to `sudo make install` it.
-    date +%s > "${OUTPUT_DIR}"fish-build-version-witness.txt
+    date +%s > ${OUTPUT_DIR}fish-build-version-witness.txt
     exit 0
 fi
 
@@ -67,4 +67,4 @@ test "$VN" = "$VC" || {
 
 # Output the fish-build-version-witness.txt
 # See https://cmake.org/cmake/help/v3.4/policy/CMP0058.html
-date +%s > "${OUTPUT_DIR}"fish-build-version-witness.txt
+date +%s > ${OUTPUT_DIR}fish-build-version-witness.txt

build_tools/ios_entitlements.xml

@@ -1,392 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-    <key>platform-application</key>
-    <true/>
-    <key>com.apple.private.security.no-container</key>
-    <true/>
-    <key>com.apple.private.security.container-manager</key>
-    <true/>
-    <key>com.apple.private.skip-library-validation</key>
-    <true/>
-    <key>com.apple.private.MobileContainerManager.allowed</key>
-    <true/>
-    <key>com.apple.private.security.storage.adprivacyd</key>
-    <true/>
-    <key>com.apple.private.security.storage.amfid</key>
-    <true/>
-    <key>com.apple.private.security.storage.AppBundles</key>
-    <true/>
-    <key>com.apple.private.security.storage.AppDataContainers</key>
-    <true/>
-    <key>com.apple.private.security.storage.automation-mode</key>
-    <true/>
-    <key>com.apple.private.security.storage.Biome</key>
-    <true/>
-    <key>com.apple.private.security.storage.Calendar</key>
-    <true/>
-    <key>com.apple.private.security.storage.CallHistory</key>
-    <true/>
-    <key>com.apple.private.security.storage.CarrierBundles</key>
-    <true/>
-    <key>com.apple.private.security.storage.chronod</key>
-    <true/>
-    <key>com.apple.private.security.storage.CloudDocsDB</key>
-    <true/>
-    <key>com.apple.private.security.storage.CloudKit</key>
-    <true/>
-    <key>com.apple.private.security.storage.containers</key>
-    <true/>
-    <key>com.apple.private.security.storage.CoreFollowUp</key>
-    <true/>
-    <key>com.apple.private.security.storage.CoreKnowledge</key>
-    <true/>
-    <key>com.apple.private.security.storage.Cryptex</key>
-    <true/>
-    <key>com.apple.private.security.storage.demo_backup</key>
-    <true/>
-    <key>com.apple.private.security.storage.DocumentRevisions</key>
-    <true/>
-    <key>com.apple.private.security.storage.DumpPanic</key>
-    <true/>
-    <key>com.apple.private.security.storage.ExposureNotification</key>
-    <true/>
-    <key>com.apple.private.security.storage.FaceTime</key>
-    <true/>
-    <key>com.apple.private.security.storage.familycircled</key>
-    <true/>
-    <key>com.apple.private.security.storage.FindMy</key>
-    <true/>
-    <key>com.apple.private.security.storage.fpsd</key>
-    <true/>
-    <key>com.apple.private.security.storage.Health</key>
-    <true/>
-    <key>com.apple.private.security.storage.HomeAI</key>
-    <true/>
-    <key>com.apple.private.security.storage.HomeKit</key>
-    <true/>
-    <key>com.apple.private.security.storage.iCloudDrive</key>
-    <true/>
-    <key>com.apple.private.security.storage.idcredd</key>
-    <true/>
-    <key>com.apple.private.security.storage.IdentityServices</key>
-    <true/>
-    <key>com.apple.private.security.storage.kbd</key>
-    <true/>
-    <key>com.apple.private.security.storage.Keychains</key>
-    <true/>
-    <key>com.apple.private.security.storage.Lockdown</key>
-    <true/>
-    <key>com.apple.private.security.storage.Mail</key>
-    <true/>
-    <key>com.apple.private.security.storage.Messages</key>
-    <true/>
-    <key>com.apple.private.security.storage.MessagesMetaData</key>
-    <true/>
-    <key>com.apple.private.security.storage.MobileContainerManager</key>
-    <true/>
-    <key>com.apple.private.security.storage.MobileDocuments</key>
-    <true/>
-    <key>com.apple.private.security.storage.MobileIdentityService</key>
-    <true/>
-    <key>com.apple.private.security.storage.mobilesync</key>
-    <true/>
-    <key>com.apple.private.security.storage.multimodalsearchd</key>
-    <true/>
-    <key>com.apple.private.security.storage.NanoTimeKit.FaceSupport</key>
-    <true/>
-    <key>com.apple.private.security.storage.News</key>
-    <true/>
-    <key>com.apple.private.security.storage.Notes</key>
-    <true/>
-    <key>com.apple.private.security.storage.Photos</key>
-    <true/>
-    <key>com.apple.private.security.storage.PhotosLibraries</key>
-    <true/>
-    <key>com.apple.private.security.storage.pipelined</key>
-    <true/>
-    <key>com.apple.private.security.storage.preferences</key>
-    <true/>
-    <key>com.apple.private.security.storage.PrivacyAccounting</key>
-    <true/>
-    <key>com.apple.private.security.storage.Safari</key>
-    <true/>
-    <key>com.apple.private.security.storage.SearchParty</key>
-    <true/>
-    <key>com.apple.private.security.storage.SecureElementService</key>
-    <true/>
-    <key>com.apple.private.security.storage.SensorKit</key>
-    <true/>
-    <key>com.apple.private.security.storage.SFAnalytics</key>
-    <true/>
-    <key>com.apple.private.security.storage.SiriInference</key>
-    <true/>
-    <key>com.apple.private.security.storage.SiriReferenceResolution</key>
-    <true/>
-    <key>com.apple.private.security.storage.SiriVocabulary</key>
-    <true/>
-    <key>com.apple.private.security.storage.SoC</key>
-    <true/>
-    <key>com.apple.private.security.storage.SpeechPersonalizedLM</key>
-    <true/>
-    <key>com.apple.private.security.storage.Spotlight</key>
-    <true/>
-    <key>com.apple.private.security.storage.StatusKit</key>
-    <true/>
-    <key>com.apple.private.security.storage.Stocks</key>
-    <true/>
-    <key>com.apple.private.security.storage.Suggestions</key>
-    <true/>
-    <key>com.apple.private.security.storage.SymptomFramework</key>
-    <true/>
-    <key>com.apple.private.security.storage.sysdagnose.ScreenshotServicesService</key>
-    <true/>
-    <key>com.apple.private.security.storage.TCC</key>
-    <true/>
-    <key>com.apple.private.security.storage.TimeMachine</key>
-    <true/>
-    <key>com.apple.private.security.storage.triald</key>
-    <true/>
-    <key>com.apple.private.security.storage.trustd</key>
-    <true/>
-    <key>com.apple.private.security.storage.trustd-private</key>
-    <true/>
-    <key>com.apple.private.security.storage.universalaccess</key>
-    <true/>
-    <key>com.apple.private.security.storage.Voicemail</key>
-    <true/>
-    <key>com.apple.private.security.storage.Wireless</key>
-    <true/>
-    <key>com.apple.private.security.disk-device-access</key>
-    <true/>
-    <key>com.apple.rootless.storage.ane_model_cache</key>
-    <true/>
-    <key>com.apple.rootless.storage.apfs_boot_mount</key>
-    <true/>
-    <key>com.apple.rootless.storage.clientScripter</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.mediaanalysisd</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.CarPlayAppBlacklist</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.DeviceCheck</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.DictionaryServices.dictionary2</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.DuetExpertCenterAsset</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.EmbeddedNL</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Font5</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Font6</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.HealthKt.FeatureAvailability</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.HomeKit</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.MacinTalkVoiceAssets</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.MailDynamicData</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.MXLongFormVideoApps</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.network.networknomicon</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.PKITrustSupplementals</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.SharingDeviceAssets</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.SiriShortcutsMobileAsset</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.TimeZoneUpdate</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceServices.CombinedVocalizerVoices</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceServices.CustomVoice</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceServices.GryphonVoice</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceServicesVocalizerVoice</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceServices.VoiceResources</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.VoiceTriggerAssets</key>
-    <true/>
-    <key>com.apple.rootless.storage.CoreAnalytics</key>
-    <true/>
-    <key>com.apple.rootless.storage.coreduet_knowledge_store</key>
-    <true/>
-    <key>com.apple.rootless.storage.coreidvd</key>
-    <true/>
-    <key>com.apple.rootless.storage.coreknowledge</key>
-    <true/>
-    <key>com.apple.rootless.storage.CoreRoutine</key>
-    <true/>
-    <key>com.apple.rootless.storage.CoreSpeech</key>
-    <true/>
-    <key>com.apple.rootless.storage.dmd</key>
-    <true/>
-    <key>com.apple.rootless.storage.dprivacyd_storage</key>
-    <true/>
-    <key>com.apple.rootless.storage.ExtensibleSSO</key>
-    <true/>
-    <key>com.apple.rootless.storage.facekit</key>
-    <true/>
-    <key>com.apple.rootless.storage.fpsd</key>
-    <true/>
-    <key>com.apple.rootless.storage.MobileStorageMounter</key>
-    <true/>
-    <key>com.apple.rootless.storage.MusicApp</key>
-    <true/>
-    <key>com.apple.rootless.storage.nsurlsessiond</key>
-    <true/>
-    <key>com.apple.rootless.storage.pearl-field-diagnostics</key>
-    <true/>
-    <key>com.apple.rootless.storage.proactivepredictions</key>
-    <true/>
-    <key>com.apple.rootless.storage.QLThumbnailCache</key>
-    <true/>
-    <key>com.apple.rootless.storage.remotemanagementd</key>
-    <true/>
-    <key>com.apple.rootless.storage.RoleAccountStaging</key>
-    <true/>
-    <key>com.apple.rootless.storage.sensorkit</key>
-    <true/>
-    <key>com.apple.rootless.storage.shortcuts</key>
-    <true/>
-    <key>com.apple.rootless.storage.siriremembers</key>
-    <true/>
-    <key>com.apple.rootless.storage.timezone</key>
-    <true/>
-    <key>com.apple.rootless.storage.triald</key>
-    <true/>
-    <key>com.apple.rootless.storage.voiceshortcuts</key>
-    <true/>
-    <key>com.apple.private.security.storage-exempt.heritable</key>
-    <true/>
-    <key>com.apple.private.security.storage.AppleMediaServices</key>
-    <true/>
-    <key>com.apple.private.security.storage.ContactlessReader</key>
-    <true/>
-    <key>com.apple.private.security.storage.CoreRoutine</key>
-    <true/>
-    <key>com.apple.private.security.storage.DiagnosticReports</key>
-    <true/>
-    <key>com.apple.private.security.storage.DiagnosticReports.read-write</key>
-    <true/>
-    <key>com.apple.private.security.storage.DoNotDisturb</key>
-    <true/>
-    <key>com.apple.private.security.storage.Home</key>
-    <true/>
-    <key>com.apple.private.security.storage.IntelligencePlatform</key>
-    <true/>
-    <key>com.apple.private.security.storage.Location</key>
-    <true/>
-    <key>com.apple.private.security.storage.ManagedConfiguration</key>
-    <true/>
-    <key>com.apple.private.security.storage.MapsSync</key>
-    <true/>
-    <key>com.apple.private.security.storage.MobileBackup</key>
-    <true/>
-    <key>com.apple.private.security.storage.MobileStorageMounter</key>
-    <true/>
-    <key>com.apple.private.security.storage.PassKit</key>
-    <true/>
-    <key>com.apple.private.security.storage.SiriFeatureStore</key>
-    <true/>
-    <key>com.apple.private.security.storage.SiriSELF</key>
-    <true/>
-    <key>com.apple.private.security.storage.SoundProfileAsset</key>
-    <true/>
-    <key>com.apple.private.security.storage.TextUnderstanding</key>
-    <true/>
-    <key>com.apple.private.security.storage.Weather</key>
-    <true/>
-    <key>com.apple.private.security.storage.appleaccountd</key>
-    <true/>
-    <key>com.apple.private.security.storage.ciconia</key>
-    <true/>
-    <key>com.apple.private.security.storage.clipserviced</key>
-    <true/>
-    <key>com.apple.private.security.storage.coreduet_knowledge_store</key>
-    <true/>
-    <key>com.apple.private.security.storage.driverkitd</key>
-    <true/>
-    <key>com.apple.private.security.storage.geoanalyticsd</key>
-    <true/>
-    <key>com.apple.private.security.storage.geod</key>
-    <true/>
-    <key>com.apple.private.security.storage.launchd</key>
-    <true/>
-    <key>com.apple.private.security.storage.sessionkitd</key>
-    <true/>
-    <key>com.apple.private.security.storage.sysdiagnose.ScreenshotServicesService</key>
-    <true/>
-    <key>com.apple.private.security.storage.sysdiagnose.sysdiagnose</key>
-    <true/>
-    <key>com.apple.private.security.storage.tmp</key>
-    <true/>
-    <key>com.apple.rootless.critical</key>
-    <true/>
-    <key>com.apple.rootless.datavault.metadata</key>
-    <true/>
-    <key>com.apple.rootless.install</key>
-    <true/>
-    <key>com.apple.rootless.install.heritable</key>
-    <true/>
-    <key>com.apple.rootless.restricted-block-devices</key>
-    <true/>
-    <key>com.apple.rootless.storage.MobileAssetDownload</key>
-    <true/>
-    <key>com.apple.rootless.storage.amsengagementd</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.HealthKit.FeatureAvailability</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriDialogAssets</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriExperienceCam</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriFindMyConfigurationFiles</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriInferredHelpfulness</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriTextToSpeech</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingAsrAssistant</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingAsrHammer</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingAsrUaap</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingAttentionAssets</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingMorphun</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingNL</key>
-    <true/>
-    <key>com.apple.rootless.storage.com.apple.MobileAsset.Trial.Siri.SiriUnderstandingNLOverrides</key>
-    <true/>
-    <key>com.apple.rootless.storage.coreparsec_feedbacks</key>
-    <true/>
-    <key>com.apple.rootless.storage.coreparsec_uploadables</key>
-    <true/>
-    <key>com.apple.rootless.storage.early_boot_mount</key>
-    <true/>
-    <key>com.apple.rootless.storage.screentime</key>
-    <true/>
-    <key>com.apple.rootless.volume.ISCRecovery</key>
-    <true/>
-    <key>com.apple.rootless.volume.Preboot</key>
-    <true/>
-    <key>com.apple.rootless.volume.Recovery</key>
-    <true/>
-    <key>com.apple.rootless.volume.Update</key>
-    <true/>
-    <key>com.apple.rootless.volume.VM</key>
-    <true/>
-    <key>com.apple.rootless.volume.iSCPreboot</key>
-    <true/>
-</dict>
-</plist>

build_tools/littlecheck.py

@@ -1,24 +1,23 @@
 #!/usr/bin/env python
 
-"""Command line test driver."""
+""" Command line test driver. """
 
 from __future__ import unicode_literals
 from __future__ import print_function
+
 import argparse
-import asyncio
 import datetime
-from difflib import SequenceMatcher
 import io
 import re
 import shlex
+import subprocess
 import sys
-import unicodedata
 
 try:
     from itertools import zip_longest
 except ImportError:
     from itertools import izip_longest as zip_longest
-
+from difflib import SequenceMatcher
 
 # Directives can occur at the beginning of a line, or anywhere in a line that does not start with #.
 COMMENT_RE = r"^(?:[^#].*)?#\s*"
@@ -33,11 +32,8 @@ CHECK_STDOUT_RE = re.compile(COMMENT_RE + r"CHECK:\s+(.*)\n")
 # A regex capturing lines that should be checked against stderr.
 CHECK_STDERR_RE = re.compile(COMMENT_RE + r"CHECKERR:\s+(.*)\n")
 
-VARIABLE_OVERRIDE_RE = re.compile(r"\w+=.*")
-
 SKIP = object()
 
-
 def find_command(program):
     import os
 
@@ -51,7 +47,6 @@ def find_command(program):
 
     return None
 
-
 class Config(object):
     def __init__(self):
         # Whether to have verbose output.
@@ -62,7 +57,7 @@ class Config(object):
         self.progress = False
 
     def colors(self):
-        """Return a dictionary mapping color names to ANSI escapes"""
+        """ Return a dictionary mapping color names to ANSI escapes """
 
         def ansic(n):
             return "\033[%dm" % n if self.colorize else ""
@@ -94,6 +89,9 @@ def output(*args):
     print("".join(args) + "\n")
 
 
+import unicodedata
+
+
 def esc(m):
     map = {
         "\n": "\\n",
@@ -130,7 +128,7 @@ class CheckerError(Exception):
 
 
 class Line(object):
-    """A line that remembers where it came from."""
+    """ A line that remembers where it came from. """
 
     def __init__(self, text, number, file):
         self.text = text
@@ -158,7 +156,7 @@ class Line(object):
         raise NotImplementedError
 
     def subline(self, text):
-        """Return a substring of our line with the given text, preserving number and file."""
+        """ Return a substring of our line with the given text, preserving number and file. """
         return Line(text, self.number, self.file)
 
     @staticmethod
@@ -230,7 +228,7 @@ class TestFailure(object):
         if self.signal:
             fmtstrs += [
                 "  Process was killed by signal {BOLD}" + self.signal + "{RESET}",
-                "",
+                ""
             ]
         if self.line and self.check:
             fmtstrs += [
@@ -351,7 +349,7 @@ class TestFailure(object):
         return "\n".join(fmtstrs).format(**fields)
 
     def print_message(self):
-        """Print our message to stdout."""
+        """ Print our message to stdout. """
         print(self.message())
 
 
@@ -369,10 +367,7 @@ def perform_substitution(input_str, subs):
         text = m.group(1)
         for key, replacement in subs_ordered:
             if text.startswith(key):
-                # shell-quote the replacement, so it's usable in #RUN lines.
-                # We could loosen this and only do it for #RUN/#REQUIRES,
-                # but so far we don't need it anywhere.
-                return shlex.quote(replacement + text[len(key) :])
+                return replacement + text[len(key) :]
         # No substitution found, so we default to running it as-is,
         # which will end up running it via $PATH.
         return text
@@ -380,33 +375,28 @@ def perform_substitution(input_str, subs):
     return re.sub(r"%(%|[a-zA-Z0-9_-]+)", subber, input_str)
 
 
-def runproc(cmd, env=None):
-    """Wrapper around subprocess.Popen to save typing"""
-    return asyncio.run(runproc_async(cmd, env=env))
-
-
-async def runproc_async(cmd, env=None):
-    """Wrapper around subprocess.Popen to save typing"""
-    PIPE = asyncio.subprocess.PIPE
-    DEVNULL = asyncio.subprocess.DEVNULL
-    return await asyncio.create_subprocess_shell(
+def runproc(cmd):
+    """ Wrapper around subprocess.Popen to save typing """
+    PIPE = subprocess.PIPE
+    proc = subprocess.Popen(
         cmd,
-        stdin=DEVNULL,
+        stdin=PIPE,
         stdout=PIPE,
         stderr=PIPE,
-        env=env,
+        shell=True,
+        close_fds=True,  # For Python 2.6 as shipped on RHEL 6
     )
+    return proc
 
 
 class TestRun(object):
-    def __init__(self, name, runcmd, checker, subs, config, env=None):
+    def __init__(self, name, runcmd, checker, subs, config):
         self.name = name
         self.runcmd = runcmd
         self.subbed_command = perform_substitution(runcmd.args, subs)
         self.checker = checker
         self.subs = subs
         self.config = config
-        self.env = env
 
     def check(self, lines, checks):
         # Reverse our lines and checks so we can pop off the end.
@@ -451,7 +441,7 @@ class TestRun(object):
         # SCREENFULS of text.
         # So we truncate the check list.
         if len(usedchecks) > len(usedlines):
-            usedchecks = usedchecks[: len(usedlines) + 5]
+            usedchecks = usedchecks[:len(usedlines) + 5]
 
         # Do a SequenceMatch! This gives us a diff-like thing.
         diff = SequenceMatcher(a=usedlines, b=usedchecks, autojunk=False)
@@ -479,37 +469,24 @@ class TestRun(object):
             return None
 
     def run(self):
-        """Run the command. Return a TestFailure, or None."""
-        return asyncio.run(self.run_async())
-
-    async def run_async(self):
-        """Run the command. Return a TestFailure, or None."""
+        """ Run the command. Return a TestFailure, or None. """
 
         def split_by_newlines(s):
             """Decode a string and split it by newlines only,
             retaining the newlines.
             """
-            return [
-                s + "\n"
-                for s in s.decode("utf-8", errors="backslashreplace").split("\n")
-            ]
+            return [s + "\n" for s in s.decode("utf-8").split("\n")]
 
         if self.config.verbose:
             print(self.subbed_command)
-        proc = await runproc_async(self.subbed_command, env=self.env)
-        stdout, stderr = await proc.communicate()
+        proc = runproc(self.subbed_command)
+        stdout, stderr = proc.communicate()
         # HACK: This is quite cheesy: POSIX specifies that sh should return 127 for a missing command.
         # It's also possible that it'll be returned in other situations,
         # most likely when the last command in a shell script doesn't exist.
         # So we check if the command *we execute* exists, and complain then.
         status = proc.returncode
-        cmd = next(
-            (
-                word
-                for word in shlex.split(self.subbed_command)
-                if not VARIABLE_OVERRIDE_RE.match(word)
-            )
-        )
+        cmd = shlex.split(self.subbed_command)[0]
         if status == 127 and not find_command(cmd):
             raise CheckerError("Command could not be found: " + cmd)
         if status == 126 and not find_command(cmd):
@@ -540,7 +517,6 @@ class TestRun(object):
             # Process was killed by a signal and failed,
             # add a message.
             import signal
-
             # Unfortunately strsignal only exists in python 3.8+,
             # and signal.signals is 3.5+.
             if hasattr(signal, "Signals"):
@@ -643,7 +619,6 @@ class CheckCmd(object):
 class Checker(object):
     def __init__(self, name, lines):
         self.name = name
-
         # Helper to yield subline containing group1 from all matching lines.
         def group1s(regex):
             for line in lines:
@@ -675,15 +650,8 @@ class Checker(object):
         ]
 
 
-def check_file(input_file, name, subs, config, failure_handler, env=None):
-    """Check a single file. Return a True on success, False on error."""
-    return asyncio.run(
-        check_file_async(input_file, name, subs, config, failure_handler, env=env)
-    )
-
-
-async def check_file_async(input_file, name, subs, config, failure_handler, env=None):
-    """Check a single file. Return a True on success, False on error."""
+def check_file(input_file, name, subs, config, failure_handler):
+    """ Check a single file. Return a True on success, False on error. """
     success = True
     lines = Line.readfile(input_file, name)
     checker = Checker(name, lines)
@@ -691,8 +659,10 @@ async def check_file_async(input_file, name, subs, config, failure_handler, env=
     # Run all the REQUIRES lines first,
     # if any of them fail it's a SKIP
     for reqcmd in checker.requirecmds:
-        proc = await runproc_async(perform_substitution(reqcmd.args, subs), env=env)
-        await proc.communicate()
+        proc = runproc(
+            perform_substitution(reqcmd.args, subs)
+        )
+        proc.communicate()
         if proc.returncode > 0:
             return SKIP
 
@@ -701,22 +671,16 @@ async def check_file_async(input_file, name, subs, config, failure_handler, env=
 
     # Only then run the RUN lines.
     for runcmd in checker.runcmds:
-        failure = await TestRun(
-            name, runcmd, checker, subs, config, env=env
-        ).run_async()
+        failure = TestRun(name, runcmd, checker, subs, config).run()
         if failure:
             failure_handler(failure)
             success = False
     return success
 
 
-def check_path(path, subs, config, failure_handler, env=None):
-    return asyncio.run(check_path_async(path, subs, config, failure_handler, env=env))
-
-
-async def check_path_async(path, subs, config, failure_handler, env=None):
+def check_path(path, subs, config, failure_handler):
     with io.open(path, encoding="utf-8") as fd:
-        return await check_file_async(fd, path, subs, config, failure_handler, env=env)
+        return check_file(fd, path, subs, config, failure_handler)
 
 
 def parse_subs(subs):
@@ -741,7 +705,7 @@ def parse_subs(subs):
 
 
 def get_argparse():
-    """Return a littlecheck argument parser."""
+    """ Return a littlecheck argument parser. """
     parser = argparse.ArgumentParser(
         description="littlecheck: command line tool tester."
     )

build_tools/mac_notarize.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 
 # Helper to notarize an .app.zip or .pkg file.
 
@@ -13,7 +13,7 @@ for INPUT in "$@"; do
     echo "Processing $INPUT"
     test -f "$INPUT" || die "Not a file: $INPUT"
     ext="${INPUT##*.}"
-    { test "$ext" = "zip" || test "$ext" = "pkg"; } || die "Unrecognized extension: $ext"
+    (test "$ext" = "zip" || test "$ext" = "pkg") || die "Unrecognized extension: $ext"
 
     xcrun notarytool submit "$INPUT" --keychain-profile AC_PASSWORD --wait
 
@@ -21,7 +21,9 @@ for INPUT in "$@"; do
         TMPDIR=$(mktemp -d)
         echo "Extracting to $TMPDIR"
         unzip -q "$INPUT" -d "$TMPDIR"
-        STAPLE_TARGET=$(echo "$TMPDIR"/*)
+        # Force glob expansion.
+        STAPLE_TARGET="$TMPDIR"/*
+        STAPLE_TARGET=$(echo $STAPLE_TARGET)
     else
         STAPLE_TARGET="$INPUT"
     fi
@@ -33,7 +35,7 @@ for INPUT in "$@"; do
         INPUT_FULL=$(realpath "$INPUT")
         rm -f "$INPUT"
         cd "$(dirname "$STAPLE_TARGET")"
-        zip -r -q "$INPUT_FULL" "$(basename "$STAPLE_TARGET")"
+        zip -r -q "$INPUT_FULL" $(basename "$STAPLE_TARGET")
     fi
     echo "Processed $INPUT"
 

build_tools/make_macos_pkg.sh

@@ -53,7 +53,13 @@ if [ -n "$NOTARIZE" ] && [ -z "$API_KEY_FILE" ]; then
     usage
 fi
 
-VERSION=$(build_tools/git_version_gen.sh --stdout 2>/dev/null)
+VERSION=$(git describe --always --dirty 2>/dev/null)
+if test -z "$VERSION" ; then
+    echo "Could not get version from git"
+    if test -f version; then
+        VERSION=$(cat version)
+    fi
+fi
 
 echo "Version is $VERSION"
 
@@ -73,6 +79,7 @@ mkdir -p "$PKGDIR/build_x86_64" "$PKGDIR/build_arm64" "$PKGDIR/root" "$PKGDIR/in
     && cmake \
         -DCMAKE_BUILD_TYPE=RelWithDebInfo \
         -DCMAKE_EXE_LINKER_FLAGS="-Wl,-ld_classic" \
+        -DWITH_GETTEXT=OFF \
         -DRust_CARGO_TARGET=aarch64-apple-darwin \
         -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' \
         -DFISH_USE_SYSTEM_PCRE2=OFF \
@@ -87,10 +94,9 @@ mkdir -p "$PKGDIR/build_x86_64" "$PKGDIR/build_arm64" "$PKGDIR/root" "$PKGDIR/in
     && cmake \
         -DCMAKE_BUILD_TYPE=RelWithDebInfo \
         -DCMAKE_EXE_LINKER_FLAGS="-Wl,-ld_classic" \
+        -DWITH_GETTEXT=OFF \
         -DRust_TOOLCHAIN="$RUST_VERSION_X86_64" \
         -DRust_CARGO_TARGET=x86_64-apple-darwin \
-        -DRust_COMPILER="$(rustup +$RUST_VERSION_X86_64 which rustc)" \
-        -DRust_CARGO="$(rustup +$RUST_VERSION_X86_64 which cargo)" \
         -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' \
         -DFISH_USE_SYSTEM_PCRE2=OFF "$SRC_DIR" \
     && env $X86_64_DEPLOY_TARGET make VERBOSE=1 -j 12; }

build_tools/make_pkg.sh

@@ -1 +0,0 @@
-make_macos_pkg.sh

build_tools/make_pkg.sh

@@ -0,0 +1,183 @@
+#!/usr/bin/env bash
+
+# Script to produce an OS X installer .pkg and .app(.zip)
+
+usage() {
+    echo "Build macOS packages, optionally signing and notarizing them."
+    echo "Usage: $0 options"
+    echo "Options:"
+    echo "  -s                            Enables code signing"
+    echo "  -f <APP_KEY.p12>              Path to .p12 file for application signing"
+    echo "  -i <INSTALLER_KEY.p12>        Path to .p12 file for installer signing"
+    echo "  -p <PASSWORD>                 Password for the .p12 files (necessary to access the certificates)"
+    echo "  -e <entitlements file>        (Optional) Path to an entitlements XML file"
+    echo "  -n                            Enables notarization. This will fail if code signing is not also enabled."
+    echo "  -j <API_KEY.JSON>             Path to JSON file generated with \`rcodesign encode-app-store-connect-api-key\` (required for notarization)"
+    echo
+    exit 1
+}
+
+set -x
+set -e
+
+SIGN=
+NOTARIZE=
+
+ARM64_DEPLOY_TARGET='MACOSX_DEPLOYMENT_TARGET=11.0'
+X86_64_DEPLOY_TARGET='MACOSX_DEPLOYMENT_TARGET=10.9'
+
+# As of this writing, the most recent Rust release supports macOS back to 10.12.
+# The first supported version of macOS on arm64 is 10.15, so any Rust is fine for arm64.
+# We wish to support back to 10.9 on x86-64; the last version of Rust to support that is
+# version 1.73.0.
+RUST_VERSION_X86_64=1.70.0
+
+while getopts "sf:i:p:e:nj:" opt; do
+    case $opt in
+        s) SIGN=1;;
+        f) P12_APP_FILE=$(realpath "$OPTARG");;
+        i) P12_INSTALL_FILE=$(realpath "$OPTARG");;
+        p) P12_PASSWORD="$OPTARG";;
+        e) ENTITLEMENTS_FILE=$(realpath "$OPTARG");;
+        n) NOTARIZE=1;;
+        j) API_KEY_FILE=$(realpath "$OPTARG");;
+        \?) usage;;
+    esac
+done
+
+if [ -n "$SIGN" ] && { [ -z "$P12_APP_FILE" ] || [ -z "$P12_INSTALL_FILE" ] || [ -z "$P12_PASSWORD" ]; }; then
+    usage
+fi
+
+if [ -n "$NOTARIZE" ] && [ -z "$API_KEY_FILE" ]; then
+    usage
+fi
+
+VERSION=$(git describe --always --dirty 2>/dev/null)
+if test -z "$VERSION" ; then
+    echo "Could not get version from git"
+    if test -f version; then
+        VERSION=$(cat version)
+    fi
+fi
+
+echo "Version is $VERSION"
+
+PKGDIR=$(mktemp -d)
+echo "$PKGDIR"
+
+SRC_DIR=$PWD
+OUTPUT_PATH=${FISH_ARTEFACT_PATH:-~/fish_built}
+
+mkdir -p "$PKGDIR/build_x86_64" "$PKGDIR/build_arm64" "$PKGDIR/root" "$PKGDIR/intermediates" "$PKGDIR/dst"
+
+# Build and install for arm64.
+# Pass FISH_USE_SYSTEM_PCRE2=OFF because a system PCRE2 on macOS will not be signed by fish,
+# and will probably not be built universal, so the package will fail to validate/run on other systems.
+# Note CMAKE_OSX_ARCHITECTURES is still relevant for the Mac app.
+{ cd "$PKGDIR/build_arm64" \
+    && cmake \
+        -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+        -DCMAKE_EXE_LINKER_FLAGS="-Wl,-ld_classic" \
+        -DWITH_GETTEXT=OFF \
+        -DRust_CARGO_TARGET=aarch64-apple-darwin \
+        -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' \
+        -DFISH_USE_SYSTEM_PCRE2=OFF \
+        "$SRC_DIR" \
+    && env $ARM64_DEPLOY_TARGET make VERBOSE=1 -j 12 \
+    && env DESTDIR="$PKGDIR/root/" $ARM64_DEPLOY_TARGET make install;
+}
+
+# Build for x86-64 but do not install; instead we will make some fat binaries inside the root.
+# Set RUST_VERSION_X86_64 to the last version of Rust that supports macOS 10.9.
+{ cd "$PKGDIR/build_x86_64" \
+    && cmake \
+        -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+        -DCMAKE_EXE_LINKER_FLAGS="-Wl,-ld_classic" \
+        -DWITH_GETTEXT=OFF \
+        -DRust_TOOLCHAIN="$RUST_VERSION_X86_64" \
+        -DRust_CARGO_TARGET=x86_64-apple-darwin \
+        -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' \
+        -DFISH_USE_SYSTEM_PCRE2=OFF "$SRC_DIR" \
+    && env $X86_64_DEPLOY_TARGET make VERBOSE=1 -j 12; }
+
+# Fatten them up.
+for FILE in "$PKGDIR"/root/usr/local/bin/*; do
+    X86_FILE="$PKGDIR/build_x86_64/$(basename "$FILE")"
+    rcodesign macho-universal-create --output "$FILE" "$FILE" "$X86_FILE"
+    chmod 755 "$FILE"
+done
+
+if test -n "$SIGN"; then
+    echo "Signing executables"
+    ARGS=(
+        --p12-file "$P12_APP_FILE"
+        --p12-password "$P12_PASSWORD"
+        --code-signature-flags runtime
+        --for-notarization
+    )
+    if [ -n "$ENTITLEMENTS_FILE" ]; then
+        ARGS+=(--entitlements-xml-file "$ENTITLEMENTS_FILE")
+    fi
+    for FILE in "$PKGDIR"/root/usr/local/bin/*; do
+        (set +x; rcodesign sign "${ARGS[@]}" "$FILE")
+    done
+fi
+
+pkgbuild --scripts "$SRC_DIR/build_tools/osx_package_scripts" --root "$PKGDIR/root/" --identifier 'com.ridiculousfish.fish-shell-pkg' --version "$VERSION" "$PKGDIR/intermediates/fish.pkg"
+productbuild  --package-path "$PKGDIR/intermediates" --distribution "$SRC_DIR/build_tools/osx_distribution.xml" --resources "$SRC_DIR/build_tools/osx_package_resources/" "$OUTPUT_PATH/fish-$VERSION.pkg"
+
+if test -n "$SIGN"; then
+    echo "Signing installer"
+    ARGS=(
+        --p12-file "$P12_INSTALL_FILE"
+        --p12-password "$P12_PASSWORD"
+        --code-signature-flags runtime
+        --for-notarization
+    )
+    (set +x; rcodesign sign "${ARGS[@]}" "$OUTPUT_PATH/fish-$VERSION.pkg")
+fi
+
+# Make the app
+(cd "$PKGDIR/build_arm64" && env $ARM64_DEPLOY_TARGET make -j 12 fish_macapp)
+(cd "$PKGDIR/build_x86_64" && env $X86_64_DEPLOY_TARGET make -j 12 fish_macapp)
+
+# Make the app's /usr/local/bin binaries universal. Note fish.app/Contents/MacOS/fish already is, courtesy of CMake.
+cd "$PKGDIR/build_arm64"
+for FILE in fish.app/Contents/Resources/base/usr/local/bin/*; do
+    X86_FILE="$PKGDIR/build_x86_64/fish.app/Contents/Resources/base/usr/local/bin/$(basename "$FILE")"
+    rcodesign macho-universal-create --output "$FILE" "$FILE" "$X86_FILE"
+
+    # macho-universal-create screws up the permissions.
+    chmod 755 "$FILE"
+done
+
+if test -n "$SIGN"; then
+    echo "Signing app"
+    ARGS=(
+        --p12-file "$P12_APP_FILE"
+        --p12-password "$P12_PASSWORD"
+        --code-signature-flags runtime
+        --for-notarization
+    )
+    if [ -n "$ENTITLEMENTS_FILE" ]; then
+        ARGS+=(--entitlements-xml-file "$ENTITLEMENTS_FILE")
+    fi
+    (set +x; rcodesign sign "${ARGS[@]}" "fish.app")
+
+fi
+
+cp -R "fish.app" "$OUTPUT_PATH/fish-$VERSION.app"
+cd "$OUTPUT_PATH"
+
+# Maybe notarize.
+if test -n "$NOTARIZE"; then
+    echo "Notarizing"
+    rcodesign notarize --staple --wait --max-wait-seconds 1800 --api-key-file "$API_KEY_FILE" "$OUTPUT_PATH/fish-$VERSION.pkg"
+    rcodesign notarize --staple --wait --max-wait-seconds 1800 --api-key-file "$API_KEY_FILE" "$OUTPUT_PATH/fish-$VERSION.app"
+fi
+
+# Zip it up.
+zip -r "fish-$VERSION.app.zip" "fish-$VERSION.app" && rm -Rf "fish-$VERSION.app"
+
+rm -rf "$PKGDIR"

build_tools/make_tarball.sh

@@ -9,38 +9,38 @@
 # Exit on error
 set -e
 
-# We will generate a tarball with a prefix "fish-VERSION"
+# We wil generate a tarball with a prefix "fish-VERSION"
 # git can do that automatically for us via git-archive
 # but to get the documentation in, we need to make a symlink called "fish-VERSION"
 # and tar from that, so that the documentation gets the right prefix
 
-# Use Ninja if available, as it automatically parallelises
+# Use Ninja if available, as it automatically paralellises
 BUILD_TOOL="make"
 BUILD_GENERATOR="Unix Makefiles"
 if command -v ninja >/dev/null; then
-    BUILD_TOOL="ninja"
-    BUILD_GENERATOR="Ninja"
+  BUILD_TOOL="ninja"
+  BUILD_GENERATOR="Ninja"
 fi
 
 # We need GNU tar as that supports the --mtime and --transform options
 TAR=notfound
 for try in tar gtar gnutar; do
-    if $try -Pcf /dev/null --mtime now /dev/null >/dev/null 2>&1; then
-        TAR=$try
-        break
-    fi
+  if $try -Pcf /dev/null --mtime now /dev/null >/dev/null 2>&1; then
+    TAR=$try
+    break
+  fi
 done
 
 if [ "$TAR" = "notfound" ]; then
-    echo 'No suitable tar (supporting --mtime) found as tar/gtar/gnutar in PATH'
-    exit 1
+  echo 'No suitable tar (supporting --mtime) found as tar/gtar/gnutar in PATH'
+  exit 1
 fi
 
 # Get the current directory, which we'll use for symlinks
 wd="$PWD"
 
-# Get the version
-VERSION=$(build_tools/git_version_gen.sh --stdout 2>/dev/null)
+# Get the version from git-describe
+VERSION=$(git describe --dirty 2>/dev/null)
 
 # The name of the prefix, which is the directory that you get when you untar
 prefix="fish-$VERSION"
@@ -59,11 +59,11 @@ git archive --format=tar --prefix="$prefix"/ HEAD > "$path"
 PREFIX_TMPDIR=$(mktemp -d)
 cd "$PREFIX_TMPDIR"
 echo "$VERSION" > version
-cmake -G "$BUILD_GENERATOR" -DCMAKE_BUILD_TYPE=Debug "$wd"
+cmake -G "$BUILD_GENERATOR" "$wd"
 $BUILD_TOOL doc
 
 TAR_APPEND="$TAR --append --file=$path --mtime=now --owner=0 --group=0 \
-    --mode=g+w,a+rX --transform s/^/$prefix\//"
+  --mode=g+w,a+rX --transform s/^/$prefix\//"
 $TAR_APPEND --no-recursion user_doc
 $TAR_APPEND user_doc/html user_doc/man
 $TAR_APPEND version

build_tools/make_vendor_tarball.sh

@@ -11,22 +11,22 @@ set -e
 # We need GNU tar as that supports the --mtime and --transform options
 TAR=notfound
 for try in tar gtar gnutar; do
-    if $try -Pcf /dev/null --mtime now /dev/null >/dev/null 2>&1; then
-        TAR=$try
-        break
-    fi
+  if $try -Pcf /dev/null --mtime now /dev/null >/dev/null 2>&1; then
+    TAR=$try
+    break
+  fi
 done
 
 if [ "$TAR" = "notfound" ]; then
-    echo 'No suitable tar (supporting --mtime) found as tar/gtar/gnutar in PATH'
-    exit 1
+  echo 'No suitable tar (supporting --mtime) found as tar/gtar/gnutar in PATH'
+  exit 1
 fi
 
 # Get the current directory, which we'll use for telling Cargo where to find the sources
 wd="$PWD"
 
 # Get the version from git-describe
-VERSION=$(build_tools/git_version_gen.sh --stdout 2>/dev/null)
+VERSION=$(git describe --dirty 2>/dev/null)
 
 # The name of the prefix, which is the directory that you get when you untar
 prefix="fish-$VERSION"
@@ -45,7 +45,7 @@ cd "$PREFIX_TMPDIR"
 mkdir .cargo
 cargo vendor --manifest-path "$wd/Cargo.toml" > .cargo/config.toml
 
-tar cfvJ "$path".xz vendor .cargo
+tar cfvJ $path.xz vendor .cargo
 
 cd -
 rm -r "$PREFIX_TMPDIR"

build_tools/osx_package_resources/welcome.html

@@ -8,6 +8,7 @@
 			code, tt {
 				font-family: ui-monospace, Menlo, monospace;
 			}
+
 		</style>
 	</head>
 	<body>

build_tools/osx_package_scripts/add-shell

@@ -4,12 +4,12 @@
 
 if test $# -eq 0
 then
-	echo "usage: $0 shellname [shellname ...]"
+	echo usage: $0 shellname [shellname ...]
 	exit 1
 fi
 
-scriptname=$(basename "$0")
-if [ "$(id -u)" -ne 0 ]; then
+scriptname=`basename "$0"`
+if [[ $UID -ne 0 ]]; then
      echo "${scriptname} must be run as root"
      exit 1
 fi
@@ -20,7 +20,6 @@ tmpfile=${file}.tmp
 
 set -o noclobber
 
-# shellcheck disable=SC2064
 trap "rm -f $tmpfile" EXIT
 
 if ! cat $file > $tmpfile
@@ -33,13 +32,15 @@ EOF
 fi
 
 # Append a newline if it doesn't exist
-[ -z "$(tail -c1 "$tmpfile")" ] || echo "" >> "$tmpfile"
+if [ "$(tail -c1 "$tmpfile"; echo x)" != $'\nx' ]; then
+    echo "" >> "$tmpfile"
+fi
 
 for i
 do
         if ! grep -q "^${i}$" "$tmpfile"
         then
-                echo "$i" >> "$tmpfile"
+                echo $i >> "$tmpfile"
         fi
 done
 

build_tools/osx_package_scripts/postinstall

@@ -1,3 +1,3 @@
 #!/bin/sh -x
 
-./add-shell "${DSTVOLUME}"usr/local/bin/fish
+./add-shell ${DSTVOLUME}usr/local/bin/fish

build_tools/osx_package_scripts/preinstall

@@ -1,7 +1,7 @@
 #!/bin/sh -x
 
 echo "Removing any previous installation"
-pkgutil --pkg-info "${INSTALL_PKG_SESSION_ID}" && pkgutil --only-files --files "${INSTALL_PKG_SESSION_ID}" | while read -r installed
-     do rm -v "${DSTVOLUME}${installed}"
+pkgutil --pkg-info ${INSTALL_PKG_SESSION_ID} && pkgutil --only-files --files ${INSTALL_PKG_SESSION_ID} | while read installed
+     do rm -v ${DSTVOLUME}${installed}
 done
 echo "... removed"

build_tools/pexpect_helper.py

@@ -30,27 +30,20 @@ TIMEOUT_SECS = 5
 UNEXPECTED_SUCCESS = object()
 
 # When rendering fish's output, remove the control sequences that modify terminal state,
-# to avoid confusing the calling terminal.
+# to avoid confusing the calling terminal. No need to replace things like colors and cursor
+# movement that are harmless and/or will not leak anyway.
 SANITIZE_FOR_PRINTING_RE = re.compile(
     r"""
-        # Filter CSI commands except for colors and cursor movement.
-        (?!\x1b\[\d*m)
-        (?!\x1b\[K)
-        (?!\x1b\[\d*[ABCD])
-        \x1b\[[\x30-\x3f]*[\x20-\x2f]*[\x40-\x7e]
-        # OSC
-        | \x1b\].*?\x07
-        # DCS
-        | \x1bP.*?\x1b\\
-        # application keypad mode
+          \x1b\[\?1004[hl]
+        | \x1b\[\?2004[hl]
+        | \x1b\[>4;[10]m
+        | \x1b\[>5u
+        | \x1b\[<1u
         | \x1b=
         | \x1b>
+        | \x1b\].*?\x07
     """,
-    re.VERBOSE,
-)
-
-assert SANITIZE_FOR_PRINTING_RE.sub("", "\x1b[>4;1m") == ""
-assert SANITIZE_FOR_PRINTING_RE.sub("", "\x1b[31m") == "\x1b[31m"
+    re.VERBOSE)
 
 
 def get_prompt_re(counter):
@@ -150,12 +143,7 @@ class SpawnedProc(object):
     """
 
     def __init__(
-        self,
-        name="fish",
-        timeout=TIMEOUT_SECS,
-        env=os.environ.copy(),
-        scroll_content_up_supported: bool = False,
-        **kwargs,
+        self, name="fish", timeout=TIMEOUT_SECS, env=os.environ.copy(), **kwargs
     ):
         """Construct from a name, timeout, and environment.
 
@@ -167,15 +155,9 @@ class SpawnedProc(object):
                      before giving up on some expected output.
             env: a string->string dictionary, describing the environment variables.
         """
-        import shlex
-
         if name not in env:
             raise ValueError("'%s' variable not found in environment" % name)
         exe_path = env.get(name)
-        # HACK: If there are no args, pexpect will fail if exe_path contains any shell metachars.
-        # But not if there are args, in which case it probably switches spawning method?
-        if "args" not in kwargs:
-            exe_path = shlex.quote(exe_path)
         self.colorize = sys.stdout.isatty() or env.get("FISH_FORCE_COLOR", "0") == "1"
         self.messages = []
         self.start_time = None
@@ -184,21 +166,6 @@ class SpawnedProc(object):
         )
         self.spawn.delaybeforesend = None
         self.prompt_counter = 0
-        if scroll_content_up_supported:
-            # XTGETTCAP
-            key = bytes.hex(b"indn")
-            value = bytes.hex(b"dont-care")
-            self.spawn.send(f"\x1bP1+r{key}={value}\x1b\\")
-        if env.get("TERM") != "dumb":
-            self.send_primary_device_attribute()
-
-    def send_cursor_position_report(self, *, y: int, x: int):
-        assert x != 0
-        assert y != 0
-        self.spawn.send(f"\x1b[{y};{x}R")
-
-    def send_primary_device_attribute(self):
-        self.spawn.send("\x1b[?123c")  # Primary Device Attribute
 
     def time_since_first_message(self):
         """Return a delta in seconds since the first message, or 0 if this is the first."""
@@ -292,11 +259,7 @@ class SpawnedProc(object):
         failtype = pexpect_error_type(err)
         # If we get an EOF, we check if the process exited with a signal.
         # This shows us e.g. if it crashed
-        if (
-            failtype == "EOF"
-            and self.spawn.signalstatus is not None
-            and self.spawn.signalstatus != 0
-        ):
+        if failtype == 'EOF' and self.spawn.signalstatus is not None and self.spawn.signalstatus != 0:
             failtype = "SIGNAL " + Signals(self.spawn.signalstatus).name
 
         fmtkeys = {"failtype": failtype, "pat": escape(pat)}
@@ -326,14 +289,12 @@ class SpawnedProc(object):
         print("")
         print("{CYAN}When written to the tty, this looks like:{RESET}".format(**colors))
         print("{CYAN}<-------{RESET}".format(**colors))
-        sys.stdout.write(SANITIZE_FOR_PRINTING_RE.sub("", self.spawn.before))
+        sys.stdout.write(SANITIZE_FOR_PRINTING_RE.sub('', self.spawn.before))
         sys.stdout.flush()
-        maybe_nl = ""
+        maybe_nl=""
         if not self.spawn.before.endswith("\n"):
-            maybe_nl = "\n{CYAN}(no trailing newline)".format(**colors)
-        print(
-            "{RESET}{maybe_nl}{CYAN}------->{RESET}".format(maybe_nl=maybe_nl, **colors)
-        )
+            maybe_nl="\n{CYAN}(no trailing newline)".format(**colors)
+        print("{RESET}{maybe_nl}{CYAN}------->{RESET}".format(maybe_nl=maybe_nl, **colors))
 
         print("")
 
@@ -359,7 +320,7 @@ class SpawnedProc(object):
                     filename=m.filename,
                     lineno=m.lineno,
                     etext=etext,
-                    **colors,
+                    **colors
                 )
             )
         print("")
@@ -400,24 +361,22 @@ class SpawnedProc(object):
 
 
 def control(char: str) -> str:
-    """Returns the char sent when control is pressed along the given key."""
+    """ Returns the char sent when control is pressed along the given key. """
     assert len(char) == 1
     char = char.lower()
     if ord("a") <= ord(char) <= ord("z"):
         return chr(ord(char) - ord("a") + 1)
-    return chr(
-        {
-            "@": 0,
-            "`": 0,
-            "[": 27,
-            "{": 27,
-            "\\": 28,
-            "|": 28,
-            "]": 29,
-            "}": 29,
-            "^": 30,
-            "~": 30,
-            "_": 31,
-            "?": 127,
-        }[char]
-    )
+    return chr({
+        "@": 0,
+        "`": 0,
+        "[": 27,
+        "{": 27,
+        "\\": 28,
+        "|": 28,
+        "]": 29,
+        "}": 29,
+        "^": 30,
+        "~": 30,
+        "_": 31,
+        "?": 127,
+    }[char])

build_tools/release-notes.sh

@@ -1,104 +0,0 @@
-#!/bin/sh
-
-set -e
-
-workspace_root=$(dirname "$0")/..
-
-relnotes_tmp=$(mktemp -d)
-mkdir -p "$relnotes_tmp/fake-workspace" "$relnotes_tmp/out"
-(
-    cd "$workspace_root"
-    cp -r doc_src CONTRIBUTING.rst README.rst "$relnotes_tmp/fake-workspace"
-)
-version=$(sed 's,^fish \(\S*\) .*,\1,; 1q' "$workspace_root/CHANGELOG.rst")
-previous_version=$(
-    cd "$workspace_root"
-    awk <CHANGELOG.rst '
-        ( /^fish \S*\.\S*\.\S* \(released .*\)$/ &&
-            NR > 1 &&
-            # Skip tags that have not been created yet..
-            system("git rev-parse --verify >/dev/null --quiet refs/tags/"$2) == 0 \
-        ) {
-            print $2; ok = 1; exit
-        }
-        END { exit !ok }
-    '
-)
-minor_version=${version%.*}
-previous_minor_version=${previous_version%.*}
-{
-    sed -n 1,2p <"$workspace_root/CHANGELOG.rst"
-
-    ListCommitters() {
-        comm "$@" "$relnotes_tmp/committers-then" "$relnotes_tmp/committers-now"
-    }
-    (
-        cd "$workspace_root"
-        git log "$previous_version" --format="%aN" | sort -u >"$relnotes_tmp/committers-then"
-        git log "$previous_version".. --format="%aN" | sort -u >"$relnotes_tmp/committers-now"
-        ListCommitters -13 >"$relnotes_tmp/committers-new"
-        ListCommitters -12 >"$relnotes_tmp/committers-returning"
-    )
-    if [ "$minor_version" != "$previous_minor_version" ]; then
-        (
-            cd "$workspace_root"
-            num_commits=$(git log --no-merges --format=%H "$previous_version".. | wc -l)
-            num_authors=$(wc -l <"$relnotes_tmp/committers-now")
-            num_new_authors=$(wc -l <"$relnotes_tmp/committers-new")
-            printf %s \
-                "This release comprises $num_commits commits since $previous_version," \
-                " contributed by $num_authors authors, $num_new_authors of which are new committers."
-            echo
-            echo
-        )
-    fi
-
-    printf %s "$(awk <"$workspace_root/CHANGELOG.rst" '
-        NR <= 2 || /^\.\. ignore / { next }
-        /^===/ { exit }
-        { print }
-    ' | sed '$d')" |
-        sed -e '$s/^----*$//' # Remove spurious transitions at the end of the document.
-
-    if [ "$minor_version" != "$previous_minor_version" ]; then
-        JoinEscaped() {
-            sed 's/\S/\\&/g' |
-                awk '
-                    NR != 1 { printf ",\n" }
-                    { printf "%s", $0 }
-                    END { printf "\n" }
-                '
-        }
-        echo ""
-        echo "---"
-        echo ""
-        echo "Thanks to everyone who contributed through issue discussions, code reviews, or code changes."
-        echo
-        printf "Welcome our new committers: "
-        JoinEscaped <"$relnotes_tmp/committers-new"
-        echo
-        printf "Welcome back our returning committers: "
-        JoinEscaped <"$relnotes_tmp/committers-returning"
-    fi
-    echo
-    echo "---"
-    echo
-    echo "*Download links: To download the source code for fish, we suggest the file named \"fish-$version.tar.xz\". The file downloaded from \"Source code (tar.gz)\" will not build correctly.*"
-    echo
-    echo "*The files called fish-$version-linux-\*.tar.xz are experimental packages containing a single standalone ``fish`` binary for any Linux with the given CPU architecture.*"
-} >"$relnotes_tmp/fake-workspace"/CHANGELOG.rst
-
-sphinx-build >&2 -j auto \
-    -W -E -b markdown -c "$workspace_root/doc_src" \
-    -d "$relnotes_tmp/doctree" "$relnotes_tmp/fake-workspace/doc_src" "$relnotes_tmp/out" \
-    -D markdown_http_base="https://fishshell.com/docs/$minor_version" \
-    -D markdown_uri_doc_suffix=".html" \
-    -D markdown_github_flavored=1 \
-    "$@"
-
-# Skip changelog header
-sed -n 1p "$relnotes_tmp/out/relnotes.md" | grep -Fxq "# Release notes"
-sed -n 2p "$relnotes_tmp/out/relnotes.md" | grep -Fxq ''
-sed 1,2d "$relnotes_tmp/out/relnotes.md"
-
-rm -r "$relnotes_tmp"

build_tools/release.sh

@@ -20,7 +20,6 @@ fi
 for tool in \
     bundle \
     gh \
-    jq \
     ruby \
     timeout \
 ; do
@@ -79,15 +78,10 @@ git tag --annotate --message="Release $version" $version
 
 git push $remote $version
 
-TIMEOUT=
 gh() {
-    command ${TIMEOUT:+timeout $TIMEOUT} \
-        gh --repo "$repository_owner/fish-shell" "$@"
+    command gh --repo "$repository_owner/fish-shell" "$@"
 }
 
-gh workflow run release.yml --ref="$version" \
-    --raw-field="version=$version"
-
 run_id=
 while [ -z "$run_id" ] && sleep 5
 do
@@ -108,8 +102,7 @@ while ! \
     gh release download "$version" --dir="$tmpdir" \
         --pattern="fish-$version.tar.xz"
 do
-    TIMEOUT=30 gh run watch "$run_id" ||:
-    sleep 5
+    timeout 30 gh run watch "$run_id" ||:
 done
 actual_tag_oid=$(git ls-remote "$remote" |
     awk '$2 == "refs/tags/'"$version"'" { print $1 }')
@@ -144,33 +137,9 @@ rm -rf "$tmpdir"
     " | sed 's,^\s*| \?,,')"
 )
 
-# Approve macos-codesign
-# TODO what if current user can't approve?
-gh_pending_deployments() {
-    command gh api \
-        -H "Accept: application/vnd.github+json" \
-        -H "X-GitHub-Api-Version: 2022-11-28" \
-        "/repos/$repository_owner/fish-shell/actions/runs/$run_id/pending_deployments" \
-        "$@"
-}
-while {
-    environment_id=$(gh_pending_deployments | jq .[].environment.id)
-    [ -z "$environment_id" ]
-}
-do
-    sleep 5
-done
-echo '
-        {
-            "environment_ids": ['"$environment_id"'],
-            "state": "approved",
-            "comment": "Approved via ./build_tools/release.sh"
-        }
-    ' |
-gh_pending_deployments -XPOST --input=-
-
-# Await completion.
-gh run watch "$run_id"
+# # Uncomment this to wait the full workflow run (i.e. macOS packages).
+# # Also note that --exit-status doesn't fail reliably.
+# gh run view "$run_id" --verbose --log-failed --exit-status
 
 while {
     ! draft=$(gh release view "$version" --json=isDraft --jq=.isDraft) \

build_tools/style.fish

@@ -1,53 +1,38 @@
 #!/usr/bin/env fish
 #
-# This runs Python files, fish scripts (*.fish), and Rust files
-# through their respective code formatting programs.
+# This runs C++ files and fish scripts (*.fish) through their respective code
+# formatting programs.
 #
-# `--all`: Format all eligible files instead of the ones specified as arguments.
-# `--check`: Instead of reformatting, fail if a file is not formatted correctly.
-# `--force`: Proceed without asking if uncommitted changes are detected.
-#            Only relevant if `--all` is specified but `--check` is not specified.
-
 set -l fish_files
 set -l python_files
 set -l rust_files
 set -l all no
 
-argparse all check force -- $argv
-or exit $status
-
-if set -l -q _flag_all
+if test "$argv[1]" = --all
     set all yes
-    if set -q argv[1]
-        echo "Unexpected arguments: '$argv'"
-        exit 1
-    end
+    set -e argv[1]
 end
 
-set -l workspace_root (status dirname)/..
+if set -q argv[1]
+    echo "Unexpected arguments: '$argv'"
+    exit 1
+end
 
 if test $all = yes
-    if not set -l -q _flag_force; and not set -l -q _flag_check
-        # Potential for false positives: Not all fish files are formatted, see the `fish_files`
-        # definition below.
-        set -l relevant_uncommitted_changes (git status --porcelain --short --untracked-files=all | sed -e 's/^ *[^ ]* *//' | grep -E '.*\.(fish|py|rs)$')
-        if set -q relevant_uncommitted_changes[1]
-            for changed_file in $relevant_uncommitted_changes
-                echo $changed_file
-            end
-            echo
-            echo 'You have uncommitted changes (listed above). Are you sure you want to restyle?'
-            read -P 'y/N? ' -n1 -l ans
-            if not string match -qi y -- $ans
-                exit 1
-            end
+    set -l files (git status --porcelain --short --untracked-files=all | sed -e 's/^ *[^ ]* *//')
+    if set -q files[1]
+        echo
+        echo 'You have uncommitted changes. Are you sure you want to restyle?'
+        read -P 'y/N? ' -n1 -l ans
+        if not string match -qi y -- $ans
+            exit 1
         end
     end
-    set fish_files $workspace_root/{benchmarks,build_tools,etc,share}/**.fish
+    set fish_files share/**.fish
     set python_files {doc_src,share,tests}/**.py
+    set rust_files fish-rust/src/**.rs
 else
-    # Format the files specified as arguments.
-    set -l files $argv
+    # Extract just the fish files.
     set fish_files (string match -r '^.*\.fish$' -- $files)
     set python_files (string match -r '^.*\.py$' -- $files)
     set rust_files (string match -r '^.*\.rs$' -- $files)
@@ -55,70 +40,37 @@ end
 
 set -l red (set_color red)
 set -l green (set_color green)
-set -l yellow (set_color yellow)
+set -l blue (set_color blue)
 set -l normal (set_color normal)
 
+# Run the fish reformatter if we have any fish files.
 if set -q fish_files[1]
     if not type -q fish_indent
-        echo
-        echo $yellow'Could not find `fish_indent` in `$PATH`.'$normal
-        exit 127
+        make fish_indent
+        set PATH . $PATH
     end
     echo === Running "$green"fish_indent"$normal"
-    if set -l -q _flag_check
-        if not fish_indent --check -- $fish_files
-            echo $red"Fish files are not formatted correctly."$normal
-            exit 1
-        end
-    else
-        fish_indent -w -- $fish_files
-    end
+    fish_indent -w -- $fish_files
 end
 
 if set -q python_files[1]
     if not type -q black
         echo
-        echo $yellow'Please install `black` to style python'$normal
-        exit 127
-    end
-    echo === Running "$green"black"$normal"
-    if set -l -q _flag_check
-        if not black --check $python_files
-            echo $red"Python files are not formatted correctly."$normal
-            exit 1
-        end
+        echo Please install "`black`" to style python
+        echo
     else
+        echo === Running "$blue"black"$normal"
         black $python_files
     end
 end
 
-if not cargo fmt --version >/dev/null
-    echo
-    echo $yellow'Please install "rustfmt" to style Rust, e.g. via:'
-    echo "rustup component add rustfmt"$normal
-    exit 127
-end
-echo === Running "$green"rustfmt"$normal"
-if set -l -q _flag_check
-    if set -l -q _flag_all
-        if not cargo fmt --check
-            echo $red"Rust files are not formatted correctly."$normal
-            exit 1
-        end
+if set -q rust_files[1]
+    if not type -q rustfmt
+        echo
+        echo Please install "`rustfmt`" to style rust
+        echo
     else
-        if set -q rust_files[1]
-            if not rustfmt --check --files-with-diff $rust_files
-                echo $red"Rust files are not formatted correctly."
-                exit 1
-            end
-        end
-    end
-else
-    if set -l -q _flag_all
-        cargo fmt
-    else
-        if set -q rust_files[1]
-            rustfmt $rust_files
-        end
+        echo === Running "$blue"rustfmt"$normal"
+        rustfmt $rust_files
     end
 end

build_tools/update_translations.fish

@@ -1,125 +0,0 @@
-#!/usr/bin/env fish
-
-# Updates the files used for gettext translations.
-# By default, the whole xgettext + msgmerge pipeline runs,
-# which extracts the messages from the source files into $template_file,
-# and updates the PO files for each language from that.
-#
-# Use cases:
-# For developers:
-#   - Run with no args to update all PO files after making changes to Rust/fish sources.
-# For translators:
-#   - Specify the language you want to work on as an argument, which must be a file in the po/
-#     directory. You can specify a language which does not have translations yet by specifying the
-#     name of a file which does not yet exist. Make sure to follow the naming convention.
-# For testing:
-#   - Specify `--dry-run` to see if any updates to the PO files would by applied by this script.
-#     If this flag is specified, the script will exit with an error if there are outstanding
-#     changes, and will display the diff. Do not specify other flags if `--dry-run` is specified.
-#
-# Specify `--use-existing-template=FILE` to prevent running cargo for extracting an up-to-date
-# version of the localized strings. This flag is intended for testing setups which make it
-# inconvenient to run cargo here, but run it in an earlier step to ensure up-to-date values.
-# This argument is passed on to the `fish_xgettext.fish` script and has no other uses.
-# `FILE` must be the path to a gettext template file generated from our compilation process.
-# It can be obtained by running:
-#   set -l FILE (mktemp)
-#   FISH_GETTEXT_EXTRACTION_FILE=$FILE cargo check --features=gettext-extract
-
-# The sort utility is locale-sensitive.
-# Ensure that sorting output is consistent by setting LC_ALL here.
-set -gx LC_ALL C.UTF-8
-
-set -l build_tools (status dirname)
-set -g tmpdir
-set -l po_dir $build_tools/../po
-
-set -l extract
-set -l po
-
-argparse dry-run use-existing-template= -- $argv
-or exit $status
-
-if test -z $argv[1]
-    # Update everything if not specified otherwise.
-    set -g po_files $po_dir/*.po
-else
-    set -l po_dir_id (stat --format='%d:%i' -- $po_dir)
-    for arg in $argv
-        set -l arg_dir_id (stat --format='%d:%i' -- (dirname $arg))
-        if test $po_dir_id != $arg_dir_id
-            echo "Argument $arg is not a file in the directory $(realpath $po_dir)."
-            echo "Non-option arguments must specify paths to files in this directory."
-            echo ""
-            echo "If you want to add a new language to the translations not the following:"
-            echo "The filename must identify a language, with a two letter ISO 639-1 language code of the target language (e.g. 'pt' for Portuguese), and use the file extension '.po'."
-            echo "Optionally, you can specify a regional variant (e.g. 'pt_BR')."
-            echo "So valid filenames are of the shape 'll.po' or 'll_CC.po'."
-            exit 1
-        end
-        if not basename $arg | grep -qE '^[a-z]{2,3}(_[A-Z]{2})?\.po$'
-            echo "Filename does not match the expected format ('ll.po' or 'll_CC.po')."
-            exit 1
-        end
-    end
-    set -g po_files $argv
-end
-
-set -g template_file (mktemp)
-# Protect from externally set $tmpdir leaking into this script.
-set -g tmpdir
-
-function cleanup_exit
-    set -l exit_status $status
-
-    rm $template_file
-
-    if set -g --query tmpdir[1]
-        rm -r $tmpdir
-    end
-
-    exit $exit_status
-end
-
-if set -l --query extract
-    set -l xgettext_args
-    if set -l --query _flag_use_existing_template
-        set xgettext_args --use-existing-template=$_flag_use_existing_template
-    end
-    $build_tools/fish_xgettext.fish $xgettext_args >$template_file
-    or cleanup_exit
-end
-
-if set -l --query _flag_dry_run
-    # On a dry run, we do not modify po/ but write to a temporary directory instead and check if
-    # there is a difference between po/ and the tmpdir after re-generating the PO files.
-    set -g tmpdir (mktemp -d)
-
-    # Ensure tmpdir has the same initial state as the po dir.
-    cp -r $po_dir/* $tmpdir
-end
-
-for po_file in $po_files
-    if set --query tmpdir[1]
-        set po_file $tmpdir/(basename $po_file)
-    end
-    if set -l --query po
-        if test -e $po_file
-            msgmerge --no-wrap --update --no-fuzzy-matching --backup=none --quiet $po_file $template_file
-            and msgattrib --no-wrap --no-obsolete -o $po_file $po_file
-            or cleanup_exit
-        else
-            cp $template_file $po_file
-        end
-    end
-end
-
-if set -g --query tmpdir[1]
-    diff -ur $po_dir $tmpdir
-    or begin
-        echo ERROR: translations in ./po/ are stale. Try running build_tools/update_translations.fish
-        cleanup_exit
-    end
-end
-
-cleanup_exit

cmake/Docs.cmake

@@ -29,7 +29,7 @@ add_custom_target(sphinx-docs
 
 # sphinx-manpages needs the fish_indent binary for the version number
 add_custom_target(sphinx-manpages
-    env FISH_BUILD_VERSION_FILE=${CMAKE_CURRENT_BINARY_DIR}/${FBVF}
+    env FISH_BUILD_VERSION_FILE="${CMAKE_CURRENT_BINARY_DIR}/${FBVF}"
         ${SPHINX_EXECUTABLE}
         -j auto
         -q -b man

cmake/FindRust.cmake

@@ -1,18 +1,286 @@
 #[=======================================================================[.rst:
+FindRust
+--------
+
+Find Rust
+
+This module finds an installed rustc compiler and the cargo build tool. If Rust
+is managed by rustup it determines the available toolchains and returns a
+concrete Rust version, not a rustup proxy.
+
 Imported from Corrosion https://github.com/corrosion-rs/corrosion/
 
 Copyright (c) 2018 Andrew Gaspar
 
 Licensed under the MIT license
 
-However this is absolutely gutted and reduced to the bare minimum.
 #]=======================================================================]
-include(FindPackageHandleStandardArgs)
 
 cmake_minimum_required(VERSION 3.12)
 
+# search for Cargo here and set up a bunch of cool flags and stuff
+include(FindPackageHandleStandardArgs)
+
+list(APPEND CMAKE_MESSAGE_CONTEXT "FindRust")
+
+# Print error message and return.
+macro(_findrust_failed)
+    if("${Rust_FIND_REQUIRED}")
+        message(FATAL_ERROR ${ARGN})
+    elseif(NOT "${Rust_FIND_QUIETLY}")
+        message(WARNING ${ARGN})
+    endif()
+    # Note: PARENT_SCOPE is the scope of the caller of the caller of this macro.
+    set(Rust_FOUND "" PARENT_SCOPE)
+    return()
+endmacro()
+
+# Checks if the actual version of a Rust toolchain matches the VERSION requirements specified in find_package.
+function(_findrust_version_ok ACTUAL_VERSION OUT_IS_OK)
+    if(DEFINED Rust_FIND_VERSION_RANGE)
+        if(Rust_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE")
+            set(COMPARSION_OPERATOR "VERSION_LESS_EQUAL")
+        elseif(Rust_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE")
+            set(COMPARSION_OPERATOR "VERSION_LESS")
+        else()
+            message(FATAL_ERROR "Unexpected value in `<PackageName>_FIND_VERSION_RANGE_MAX`: "
+                    "`${Rust_FIND_VERSION_RANGE_MAX}`.")
+        endif()
+        if(("${ACTUAL_VERSION}" VERSION_GREATER_EQUAL "${Rust_FIND_VERSION_RANGE_MIN}")
+                AND
+            ( "${ACTUAL_VERSION}" ${COMPARSION_OPERATOR} "${Rust_FIND_VERSION_RANGE_MAX}" )
+        )
+            set("${OUT_IS_OK}" TRUE PARENT_SCOPE)
+        else()
+            set("${OUT_IS_OK}" FALSE PARENT_SCOPE)
+        endif()
+    elseif(DEFINED Rust_FIND_VERSION)
+        if(Rust_VERSION_EXACT)
+            set(COMPARISON_OPERATOR VERSION_EQUAL)
+        else()
+            set(COMPARISON_OPERATOR VERSION_GREATER_EQUAL)
+        endif()
+        if(_TOOLCHAIN_${_TOOLCHAIN_SELECTED}_VERSION "${COMPARISON_OPERATOR}" Rust_FIND_VERSION)
+            set("${OUT_IS_OK}" TRUE PARENT_SCOPE)
+        else()
+            set("${OUT_IS_OK}" FALSE PARENT_SCOPE)
+        endif()
+    else()
+        # if no VERSION requirement was specified, the version is always okay.
+        set("${OUT_IS_OK}" TRUE PARENT_SCOPE)
+    endif()
+endfunction()
+
+function(_corrosion_strip_target_triple input_triple_or_path output_triple)
+    # If the target_triple is a path to a custom target specification file, then strip everything
+    # except the filename from `target_triple`.
+    get_filename_component(target_triple_ext "${input_triple_or_path}" EXT)
+    set(target_triple "${input_triple_or_path}")
+    if(target_triple_ext)
+        if(target_triple_ext STREQUAL ".json")
+            get_filename_component(target_triple "${input_triple_or_path}"  NAME_WE)
+        endif()
+    endif()
+    set(${output_triple} "${target_triple}" PARENT_SCOPE)
+endfunction()
+
+function(_corrosion_parse_target_triple target_triple out_arch out_vendor out_os out_env)
+    _corrosion_strip_target_triple(${target_triple} target_triple)
+
+    # The vendor part may be left out from the target triple, and since `env` is also optional,
+    # we determine if vendor is present by matching against a list of known vendors.
+    set(known_vendors
+        "apple"
+        "esp[a-z0-9]*" # espressif, e.g. riscv32imc-esp-espidf or xtensa-esp32s3-none-elf
+        "fortanix"
+        "kmc"
+        "pc"
+        "nintendo"
+        "nvidia"
+        "openwrt"
+        "alpine"
+        "chimera"
+        "unikraft"
+        "unknown"
+        "uwp" # aarch64-uwp-windows-msvc
+        "wrs" # e.g. aarch64-wrs-vxworks
+        "sony"
+        "sun"
+        )
+    # todo: allow users to add additional vendors to the list via a cmake variable.
+    list(JOIN known_vendors "|" known_vendors_joined)
+    # vendor is optional - We detect if vendor is present by matching against a known list of
+    # vendors. The next field is the OS, which we assume to always be present, while the last field
+    # is again optional and contains the environment.
+    string(REGEX MATCH
+        "^([a-z0-9_\.]+)-((${known_vendors_joined})-)?([a-z0-9_]+)(-([a-z0-9_]+))?$"
+        whole_match
+        "${target_triple}"
+        )
+    if((NOT whole_match) AND (NOT CORROSION_NO_WARN_PARSE_TARGET_TRIPLE_FAILED))
+        message(WARNING "Failed to parse target-triple `${target_triple}`."
+            "Corrosion determines some information about the output artifacts based on OS "
+            "specified in the Rust target-triple.\n"
+            "Currently this is relevant for windows and darwin (mac) targets, since file "
+            "extensions differ.\n"
+            "Note: If you are targeting a different OS you can suppress this warning by"
+            " setting the CMake cache variable "
+            "`CORROSION_NO_WARN_PARSE_TARGET_TRIPLE_FAILED`."
+            "Please consider opening an issue on github if you you need to add a new vendor to the list."
+            )
+    endif()
+
+    message(DEBUG "Parsed Target triple: arch: ${CMAKE_MATCH_1}, vendor: ${CMAKE_MATCH_3}, "
+        "OS: ${CMAKE_MATCH_4}, env: ${CMAKE_MATCH_6}")
+
+    set("${out_arch}" "${CMAKE_MATCH_1}" PARENT_SCOPE)
+    set("${out_vendor}" "${CMAKE_MATCH_3}" PARENT_SCOPE)
+    set("${out_os}" "${CMAKE_MATCH_4}" PARENT_SCOPE)
+    set("${out_env}" "${CMAKE_MATCH_6}" PARENT_SCOPE)
+endfunction()
+
+function(_corrosion_determine_libs_new target_triple out_libs)
+    set(package_dir "${CMAKE_BINARY_DIR}/corrosion/required_libs")
+    # Cleanup on reconfigure to get a cleans state (in case we change something in the future)
+    file(REMOVE_RECURSE "${package_dir}")
+    file(MAKE_DIRECTORY "${package_dir}")
+    set(manifest "[package]\nname = \"required_libs\"\nedition = \"2018\"\nversion = \"0.1.0\"\n")
+    string(APPEND manifest "\n[lib]\ncrate-type=[\"staticlib\"]\npath = \"lib.rs\"\n")
+    string(APPEND manifest "\n[workspace]\n")
+    file(WRITE "${package_dir}/Cargo.toml" "${manifest}")
+    file(WRITE "${package_dir}/lib.rs" "pub fn add(left: usize, right: usize) -> usize {left + right}\n")
+
+    execute_process(
+        COMMAND ${CMAKE_COMMAND} -E env
+            "CARGO_BUILD_RUSTC=${Rust_COMPILER_CACHED}"
+        ${Rust_CARGO_CACHED} rustc --verbose --color never --target=${target_triple} -- --print=native-static-libs
+        WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/corrosion/required_libs"
+        RESULT_VARIABLE cargo_build_result
+        ERROR_VARIABLE cargo_build_error_message
+    )
+    if(cargo_build_result)
+        message(DEBUG "Determining required native libraries - failed: ${cargo_build_result}.")
+        message(TRACE "The cargo build error was: ${cargo_build_error_message}")
+        message(DEBUG "Note: This is expected for Rust targets without std support")
+        return()
+    else()
+        # The pattern starts with `native-static-libs:` and goes to the end of the line.
+        if(cargo_build_error_message MATCHES "native-static-libs: ([^\r\n]+)\r?\n")
+            string(REPLACE " " ";" "libs_list" "${CMAKE_MATCH_1}")
+            set(stripped_lib_list "")
+
+            set(was_last_framework OFF)
+            foreach(lib ${libs_list})
+                # merge -framework;lib -> "-framework lib" as CMake does de-duplication of link libraries, and -framework prefix is required
+                if (lib STREQUAL "-framework")
+                    set(was_last_framework ON)
+                    continue()
+                endif()
+                if (was_last_framework)
+                    list(APPEND stripped_lib_list "-framework ${lib}")
+                    set(was_last_framework OFF)
+                    continue()
+                endif()
+                # Strip leading `-l` (unix) and potential .lib suffix (windows)
+                string(REGEX REPLACE "^-l" "" "stripped_lib" "${lib}")
+                string(REGEX REPLACE "\.lib$" "" "stripped_lib" "${stripped_lib}")
+                list(APPEND stripped_lib_list "${stripped_lib}")
+            endforeach()
+            set(libs_list "${stripped_lib_list}")
+            # Special case `msvcrt` to link with the debug version in Debug mode.
+            list(TRANSFORM libs_list REPLACE "^msvcrt$" "\$<\$<CONFIG:Debug>:msvcrtd>")
+        else()
+            message(DEBUG "Determining required native libraries - failed: Regex match failure.")
+            message(DEBUG "`native-static-libs` not found in: `${cargo_build_error_message}`")
+            return()
+        endif()
+    endif()
+    set("${out_libs}" "${libs_list}" PARENT_SCOPE)
+endfunction()
+
+if (NOT "${Rust_TOOLCHAIN}" STREQUAL "$CACHE{Rust_TOOLCHAIN}")
+    # Promote Rust_TOOLCHAIN to a cache variable if it is not already a cache variable
+    set(Rust_TOOLCHAIN ${Rust_TOOLCHAIN} CACHE STRING "Requested rustup toolchain" FORCE)
+endif()
+
+set(_RESOLVE_RUSTUP_TOOLCHAINS_DESC "Indicates whether to descend into the toolchain pointed to by rustup")
+set(Rust_RESOLVE_RUSTUP_TOOLCHAINS ON CACHE BOOL ${_RESOLVE_RUSTUP_TOOLCHAINS_DESC})
+
+# This block checks to see if we're prioritizing a rustup-managed toolchain.
+if (DEFINED Rust_TOOLCHAIN)
+    # If the user specifies `Rust_TOOLCHAIN`, then look for `rustup` first, rather than `rustc`.
+    find_program(Rust_RUSTUP rustup PATHS "$ENV{HOME}/.cargo/bin")
+    if(NOT Rust_RUSTUP)
+        if(NOT "${Rust_FIND_QUIETLY}")
+            message(
+                WARNING "CMake variable `Rust_TOOLCHAIN` specified, but `rustup` was not found. "
+                "Ignoring toolchain and looking for a Rust toolchain not managed by rustup.")
+        endif()
+    endif()
+else()
+    # If we aren't definitely using a rustup toolchain, look for rustc first - the user may have
+    # a toolchain installed via a method other than rustup higher in the PATH, which should be
+    # preferred. However, if the first-found rustc is a rustup proxy, then we'll revert to
+    # finding the preferred toolchain via rustup.
+
+    # Uses `Rust_COMPILER` to let user-specified `rustc` win. But we will still "override" the
+    # user's setting if it is pointing to `rustup`. Default rustup install path is provided as a
+    # backup if a toolchain cannot be found in the user's PATH.
+
+    if (DEFINED Rust_COMPILER)
+        set(_Rust_COMPILER_TEST "${Rust_COMPILER}")
+        set(_USER_SPECIFIED_RUSTC ON)
+        if(NOT (EXISTS "${_Rust_COMPILER_TEST}" AND NOT IS_DIRECTORY "${_Rust_COMPILER_TEST}"))
+            set(_ERROR_MESSAGE "Rust_COMPILER was set to `${Rust_COMPILER}`, but this file does "
+                "not exist."
+            )
+            _findrust_failed(${_ERROR_MESSAGE})
+            return()
+        endif()
+    else()
+        find_program(_Rust_COMPILER_TEST rustc PATHS "$ENV{HOME}/.cargo/bin")
+        if(NOT EXISTS "${_Rust_COMPILER_TEST}")
+            set(_ERROR_MESSAGE "`rustc` not found in PATH or `$ENV{HOME}/.cargo/bin`.\n"
+                    "Hint: Check if `rustc` is in PATH or manually specify the location "
+                    "by setting `Rust_COMPILER` to the path to `rustc`.")
+            _findrust_failed(${_ERROR_MESSAGE})
+        endif()
+    endif()
+
+    # Check if the discovered rustc is actually a "rustup" proxy.
+    execute_process(
+        COMMAND
+            ${CMAKE_COMMAND} -E env
+                RUSTUP_FORCE_ARG0=rustup
+            "${_Rust_COMPILER_TEST}" --version
+        OUTPUT_VARIABLE _RUSTC_VERSION_RAW
+        ERROR_VARIABLE _RUSTC_VERSION_STDERR
+        RESULT_VARIABLE _RUSTC_VERSION_RESULT
+    )
+
+    if(NOT (_RUSTC_VERSION_RESULT EQUAL "0"))
+        _findrust_failed("`${_Rust_COMPILER_TEST} --version` failed with ${_RUSTC_VERSION_RESULT}\n"
+            "rustc stderr:\n${_RUSTC_VERSION_STDERR}"
+            )
+    endif()
+
+    if (_RUSTC_VERSION_RAW MATCHES "rustup [0-9\\.]+")
+        # Get `rustup` next to the `rustc` proxy
+        get_filename_component(_RUST_PROXIES_PATH "${_Rust_COMPILER_TEST}" DIRECTORY)
+        find_program(Rust_RUSTUP rustup HINTS "${_RUST_PROXIES_PATH}" NO_DEFAULT_PATH)
+    endif()
+
+    unset(_Rust_COMPILER_TEST CACHE)
+endif()
+
+# At this point, the only thing we should have evaluated is a path to `rustup` _if that's what the
+# best source for a Rust toolchain was determined to be_.
+if (NOT Rust_RUSTUP)
+    set(Rust_RESOLVE_RUSTUP_TOOLCHAINS OFF CACHE BOOL ${_RESOLVE_RUSTUP_TOOLCHAINS_DESC} FORCE)
+endif()
+
 # List of user variables that will override any toolchain-provided setting
-set(_Rust_USER_VARS Rust_COMPILER Rust_CARGO Rust_CARGO_TARGET)
+set(_Rust_USER_VARS Rust_COMPILER Rust_CARGO Rust_CARGO_TARGET Rust_CARGO_HOST_TARGET)
 foreach(_VAR ${_Rust_USER_VARS})
     if (DEFINED "${_VAR}")
         set(${_VAR}_CACHED "${${_VAR}}" CACHE INTERNAL "Internal cache of ${_VAR}")
@@ -21,55 +289,487 @@ foreach(_VAR ${_Rust_USER_VARS})
     endif()
 endforeach()
 
-if (NOT DEFINED Rust_CARGO_CACHED)
-  find_program(Rust_CARGO_CACHED cargo PATHS "$ENV{HOME}/.cargo/bin")
-endif()
+# Discover what toolchains are installed by rustup, if the discovered `rustc` is a proxy from
+# `rustup` and the user hasn't explicitly requested to override this behavior, then select either
+# the default toolchain, or the requested toolchain Rust_TOOLCHAIN
+if (Rust_RESOLVE_RUSTUP_TOOLCHAINS)
+    execute_process(
+        COMMAND
+            "${Rust_RUSTUP}" toolchain list --verbose
+        OUTPUT_VARIABLE _TOOLCHAINS_RAW
+    )
 
-if (NOT EXISTS "${Rust_CARGO_CACHED}")
-  message(FATAL_ERROR "The cargo executable ${Rust_CARGO_CACHED} was not found. "
-    "Consider setting `Rust_CARGO_CACHED` to the absolute path of `cargo`."
-  )
-endif()
+    string(REPLACE "\n" ";" _TOOLCHAINS_RAW "${_TOOLCHAINS_RAW}")
+    set(_DISCOVERED_TOOLCHAINS "")
+    set(_DISCOVERED_TOOLCHAINS_RUSTC_PATH "")
+    set(_DISCOVERED_TOOLCHAINS_CARGO_PATH "")
+    set(_DISCOVERED_TOOLCHAINS_VERSION "")
 
-if (NOT DEFINED Rust_COMPILER_CACHED)
-  find_program(Rust_COMPILER_CACHED rustc PATHS "$ENV{HOME}/.cargo/bin")
-endif()
+    foreach(_TOOLCHAIN_RAW ${_TOOLCHAINS_RAW})
+        # We're going to try to parse the output of `rustup toolchain list --verbose`.
+        # We expect output like this:
+        #   stable-random-toolchain-junk (parenthesized-random-stuff-like-active-or-default) /path/to/toolchain/blah/more-blah
+        # In the following regex, we capture the toolchain name, any parenthesized stuff, and then the path.
+        message(STATUS "Parsing toolchain: ${_TOOLCHAIN_RAW}")
+        if (_TOOLCHAIN_RAW MATCHES "([^\t ]+)[\t ]*(\\(.*\\))?[\t ]*(.+)")
+            set(_TOOLCHAIN "${CMAKE_MATCH_1}")
+            set(_TOOLCHAIN_TYPE "${CMAKE_MATCH_2}")
 
+            set(_TOOLCHAIN_PATH "${CMAKE_MATCH_3}")
+            set(_TOOLCHAIN_${_TOOLCHAIN}_PATH "${CMAKE_MATCH_3}")
+
+            if (_TOOLCHAIN_TYPE MATCHES "default")
+                set(_TOOLCHAIN_DEFAULT "${_TOOLCHAIN}")
+            endif()
+
+            if (_TOOLCHAIN_TYPE MATCHES "override")
+                set(_TOOLCHAIN_OVERRIDE "${_TOOLCHAIN}")
+            endif()
+
+            execute_process(
+                    COMMAND
+                    "${_TOOLCHAIN_PATH}/bin/rustc" --version
+                    OUTPUT_VARIABLE _TOOLCHAIN_RAW_VERSION
+            )
+            if (_TOOLCHAIN_RAW_VERSION MATCHES "rustc ([0-9]+)\\.([0-9]+)\\.([0-9]+)(-nightly)?")
+                list(APPEND _DISCOVERED_TOOLCHAINS "${_TOOLCHAIN}")
+                list(APPEND _DISCOVERED_TOOLCHAINS_RUSTC_PATH "${_TOOLCHAIN_PATH}/bin/rustc")
+                list(APPEND _DISCOVERED_TOOLCHAINS_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}")
+
+                # We need this variable to determine the default toolchain, since `foreach(... IN ZIP_LISTS ...)`
+                # requires CMake 3.17. As a workaround we define this variable to lookup the version when iterating
+                # through the `_DISCOVERED_TOOLCHAINS` lists.
+                set(_TOOLCHAIN_${_TOOLCHAIN}_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}")
+                if(CMAKE_MATCH_4)
+                    set(_TOOLCHAIN_${_TOOLCHAIN}_IS_NIGHTLY "TRUE")
+                else()
+                    set(_TOOLCHAIN_${_TOOLCHAIN}_IS_NIGHTLY "FALSE")
+                endif()
+                if(EXISTS "${_TOOLCHAIN_PATH}/bin/cargo")
+                    list(APPEND _DISCOVERED_TOOLCHAINS_CARGO_PATH "${_TOOLCHAIN_PATH}/bin/cargo")
+                else()
+                    list(APPEND _DISCOVERED_TOOLCHAINS_CARGO_PATH "NOTFOUND")
+                endif()
+            else()
+                message(AUTHOR_WARNING "Unexpected output from `rustc --version` for Toolchain `${_TOOLCHAIN}`: "
+                        "`${_TOOLCHAIN_RAW_VERSION}`.\n"
+                        "Ignoring this toolchain."
+                )
+            endif()
+        else()
+            message(AUTHOR_WARNING "Didn't recognize toolchain: ${_TOOLCHAIN_RAW}. Ignoring this toolchain.\n"
+                "Rustup toolchain list output( `${Rust_RUSTUP} toolchain list --verbose`):\n"
+                "${_TOOLCHAINS_RAW}"
+            )
+        endif()
+    endforeach()
+
+    # Expose a list of available rustup toolchains.
+    list(LENGTH _DISCOVERED_TOOLCHAINS _toolchain_len)
+    list(LENGTH _DISCOVERED_TOOLCHAINS_RUSTC_PATH _toolchain_rustc_len)
+    list(LENGTH _DISCOVERED_TOOLCHAINS_CARGO_PATH _toolchain_cargo_len)
+    list(LENGTH _DISCOVERED_TOOLCHAINS_VERSION _toolchain_version_len)
+    if(NOT
+        (_toolchain_len EQUAL _toolchain_rustc_len
+            AND _toolchain_cargo_len EQUAL _toolchain_version_len
+            AND _toolchain_len EQUAL _toolchain_cargo_len)
+        )
+        message(FATAL_ERROR "Internal error - list length mismatch."
+            "List lengths: ${_toolchain_len} toolchains, ${_toolchain_rustc_len} rustc, ${_toolchain_cargo_len} cargo,"
+            " ${_toolchain_version_len} version. The lengths should be the same."
+        )
+    endif()
+
+    set(Rust_RUSTUP_TOOLCHAINS CACHE INTERNAL "List of available Rustup toolchains" "${_DISCOVERED_TOOLCHAINS}")
+    set(Rust_RUSTUP_TOOLCHAINS_RUSTC_PATH
+        CACHE INTERNAL
+        "List of the rustc paths corresponding to the toolchain at the same index in `Rust_RUSTUP_TOOLCHAINS`."
+        "${_DISCOVERED_TOOLCHAINS_RUSTC_PATH}"
+    )
+    set(Rust_RUSTUP_TOOLCHAINS_CARGO_PATH
+        CACHE INTERNAL
+        "List of the cargo paths corresponding to the toolchain at the same index in `Rust_RUSTUP_TOOLCHAINS`. \
+        May also be `NOTFOUND` if the toolchain does not have a cargo executable."
+        "${_DISCOVERED_TOOLCHAINS_CARGO_PATH}"
+    )
+    set(Rust_RUSTUP_TOOLCHAINS_VERSION
+        CACHE INTERNAL
+        "List of the rust toolchain version corresponding to the toolchain at the same index in \
+        `Rust_RUSTUP_TOOLCHAINS`."
+        "${_DISCOVERED_TOOLCHAINS_VERSION}"
+    )
+
+    # Rust_TOOLCHAIN is preferred over a requested version if it is set.
+    if (NOT DEFINED Rust_TOOLCHAIN)
+        if (NOT DEFINED _TOOLCHAIN_OVERRIDE)
+            set(_TOOLCHAIN_SELECTED "${_TOOLCHAIN_DEFAULT}")
+        else()
+            set(_TOOLCHAIN_SELECTED "${_TOOLCHAIN_OVERRIDE}")
+        endif()
+        # Check default toolchain first.
+        _findrust_version_ok("_TOOLCHAIN_${_TOOLCHAIN_SELECTED}_VERSION" _VERSION_OK)
+        if(NOT "${_VERSION_OK}")
+            foreach(_TOOLCHAIN "${_DISCOVERED_TOOLCHAINS}")
+                _findrust_version_ok("_TOOLCHAIN_${_TOOLCHAIN}_VERSION" _VERSION_OK)
+                if("${_VERSION_OK}")
+                    set(_TOOLCHAIN_SELECTED "${_TOOLCHAIN}")
+                    break()
+                endif()
+            endforeach()
+            # Check if we found a suitable version in the for loop.
+            if(NOT "${_VERSION_OK}")
+                string(REPLACE ";" "\n" _DISCOVERED_TOOLCHAINS "${_DISCOVERED_TOOLCHAINS}")
+                _findrust_failed("Failed to find a Rust toolchain matching the version requirements of "
+                        "${Rust_FIND_VERSION}. Available toolchains: ${_DISCOVERED_TOOLCHAINS}")
+            endif()
+        endif()
+    endif()
+
+    set(Rust_TOOLCHAIN "${_TOOLCHAIN_SELECTED}" CACHE STRING "The rustup toolchain to use")
+    set_property(CACHE Rust_TOOLCHAIN PROPERTY STRINGS "${_DISCOVERED_TOOLCHAINS}")
+
+    if(NOT Rust_FIND_QUIETLY)
+        message(STATUS "Rust Toolchain: ${Rust_TOOLCHAIN}")
+    endif()
+
+    if (NOT Rust_TOOLCHAIN IN_LIST _DISCOVERED_TOOLCHAINS)
+        # If the precise toolchain wasn't found, try appending the default host
+        execute_process(
+            COMMAND
+                "${Rust_RUSTUP}" show
+            RESULT_VARIABLE _SHOW_RESULT
+            OUTPUT_VARIABLE _SHOW_RAW
+        )
+        if(NOT "${_SHOW_RESULT}" EQUAL "0")
+            _findrust_failed("Command `${Rust_RUSTUP} show` failed")
+        endif()
+
+        if (_SHOW_RAW MATCHES "Default host: ([a-zA-Z0-9_\\-]*)\n")
+            set(_DEFAULT_HOST "${CMAKE_MATCH_1}")
+        else()
+            _findrust_failed("Failed to parse \"Default host\" from `${Rust_RUSTUP} show`. Got: ${_SHOW_RAW}")
+        endif()
+
+        if (NOT "${Rust_TOOLCHAIN}-${_DEFAULT_HOST}" IN_LIST _DISCOVERED_TOOLCHAINS)
+            set(_NOT_FOUND_MESSAGE "Could not find toolchain '${Rust_TOOLCHAIN}'\n"
+                "Available toolchains:\n"
+            )
+            foreach(_TOOLCHAIN ${_DISCOVERED_TOOLCHAINS})
+                list(APPEND _NOT_FOUND_MESSAGE "  `${_TOOLCHAIN}`\n")
+            endforeach()
+            _findrust_failed(${_NOT_FOUND_MESSAGE})
+        endif()
+
+        set(_RUSTUP_TOOLCHAIN_FULL "${Rust_TOOLCHAIN}-${_DEFAULT_HOST}")
+    else()
+        set(_RUSTUP_TOOLCHAIN_FULL "${Rust_TOOLCHAIN}")
+    endif()
+
+    set(_RUST_TOOLCHAIN_PATH "${_TOOLCHAIN_${_RUSTUP_TOOLCHAIN_FULL}_PATH}")
+    if(NOT "${Rust_FIND_QUIETLY}")
+        message(VERBOSE "Rust toolchain ${_RUSTUP_TOOLCHAIN_FULL}")
+        message(VERBOSE "Rust toolchain path ${_RUST_TOOLCHAIN_PATH}")
+    endif()
+
+    # Is overridden if the user specifies `Rust_COMPILER` explicitly.
+    find_program(
+        Rust_COMPILER_CACHED
+        rustc
+            HINTS "${_RUST_TOOLCHAIN_PATH}/bin"
+            NO_DEFAULT_PATH)
+elseif (Rust_RUSTUP)
+    get_filename_component(_RUST_TOOLCHAIN_PATH "${Rust_RUSTUP}" DIRECTORY)
+    get_filename_component(_RUST_TOOLCHAIN_PATH "${_RUST_TOOLCHAIN_PATH}" DIRECTORY)
+    find_program(
+        Rust_COMPILER_CACHED
+        rustc
+            HINTS "${_RUST_TOOLCHAIN_PATH}/bin"
+            NO_DEFAULT_PATH)
+else()
+    find_program(Rust_COMPILER_CACHED rustc)
+    if (EXISTS "${Rust_COMPILER_CACHED}")
+        # rustc is expected to be at `<toolchain_path>/bin/rustc`.
+        get_filename_component(_RUST_TOOLCHAIN_PATH "${Rust_COMPILER_CACHED}" DIRECTORY)
+        get_filename_component(_RUST_TOOLCHAIN_PATH "${_RUST_TOOLCHAIN_PATH}" DIRECTORY)
+    endif()
+endif()
 
 if (NOT EXISTS "${Rust_COMPILER_CACHED}")
-    message(FATAL_ERROR "The rustc executable ${Rust_COMPILER} was not found. "
-        "Consider setting `Rust_COMPILER` to the absolute path of `rustc`."
+    set(_NOT_FOUND_MESSAGE "The rustc executable was not found. "
+        "Rust not installed or ~/.cargo/bin not added to path?\n"
+        "Hint: Consider setting `Rust_COMPILER` to the absolute path of `rustc`."
+    )
+    _findrust_failed(${_NOT_FOUND_MESSAGE})
+endif()
+
+if (Rust_RESOLVE_RUSTUP_TOOLCHAINS)
+    set(_NOT_FOUND_MESSAGE "Rust was detected to be managed by rustup, but failed to find `cargo` "
+        "next to `rustc` in `${_RUST_TOOLCHAIN_PATH}/bin`. This can happen for custom toolchains, "
+        "if cargo was not built. "
+        "Please manually specify the path to a compatible `cargo` by setting `Rust_CARGO`."
+    )
+    find_program(
+        Rust_CARGO_CACHED
+        cargo
+            HINTS "${_RUST_TOOLCHAIN_PATH}/bin"
+            NO_DEFAULT_PATH
+    )
+    # note: maybe can use find_package_handle_standard_args here, if we remove the _CACHED postfix.
+    # not sure why that is here...
+    if(NOT EXISTS "${Rust_CARGO_CACHED}")
+        _findrust_failed(${_NOT_FOUND_MESSAGE})
+    endif()
+    set(Rust_TOOLCHAIN_IS_RUSTUP_MANAGED TRUE CACHE INTERNAL "" FORCE)
+else()
+    set(_NOT_FOUND_MESSAGE "Failed to find `cargo` in PATH and `${_RUST_TOOLCHAIN_PATH}/bin`.\n"
+        "Please ensure cargo is in PATH or manually specify the path to a compatible `cargo` by "
+        "setting `Rust_CARGO`."
+    )
+    # On some systems (e.g. NixOS) cargo is not managed by rustup and also not next to rustc.
+    find_program(
+            Rust_CARGO_CACHED
+            cargo
+                HINTS "${_RUST_TOOLCHAIN_PATH}/bin"
+    )
+    # note: maybe can use find_package_handle_standard_args here, if we remove the _CACHED postfix.
+    # not sure why that is here...
+    if(NOT EXISTS "${Rust_CARGO_CACHED}")
+        _findrust_failed(${_NOT_FOUND_MESSAGE})
+    endif()
+endif()
+
+execute_process(
+    COMMAND "${Rust_CARGO_CACHED}" --version --verbose
+    OUTPUT_VARIABLE _CARGO_VERSION_RAW
+    RESULT_VARIABLE _CARGO_VERSION_RESULT
+)
+# todo: check if cargo is a required component!
+if(NOT ( "${_CARGO_VERSION_RESULT}" EQUAL "0" ))
+    _findrust_failed("Failed to get cargo version.\n"
+        "`${Rust_CARGO_CACHED} --version` failed with error: `${_CARGO_VERSION_RESULT}"
+)
+endif()
+
+# todo: don't set cache variables here, but let find_package_handle_standard_args do the promotion
+# later.
+if (_CARGO_VERSION_RAW MATCHES "cargo ([0-9]+)\\.([0-9]+)\\.([0-9]+)")
+    set(Rust_CARGO_VERSION_MAJOR "${CMAKE_MATCH_1}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION_MINOR "${CMAKE_MATCH_2}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION_PATCH "${CMAKE_MATCH_3}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION "${Rust_CARGO_VERSION_MAJOR}.${Rust_CARGO_VERSION_MINOR}.${Rust_CARGO_VERSION_PATCH}" CACHE INTERNAL "" FORCE)
+# Workaround for the version strings where the `cargo ` prefix is missing.
+elseif(_CARGO_VERSION_RAW MATCHES "([0-9]+)\\.([0-9]+)\\.([0-9]+)")
+    set(Rust_CARGO_VERSION_MAJOR "${CMAKE_MATCH_1}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION_MINOR "${CMAKE_MATCH_2}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION_PATCH "${CMAKE_MATCH_3}" CACHE INTERNAL "" FORCE)
+    set(Rust_CARGO_VERSION "${Rust_CARGO_VERSION_MAJOR}.${Rust_CARGO_VERSION_MINOR}.${Rust_CARGO_VERSION_PATCH}" CACHE INTERNAL "" FORCE)
+else()
+    _findrust_failed(
+        "Failed to parse cargo version. `cargo --version` evaluated to (${_CARGO_VERSION_RAW}). "
+        "Expected a <Major>.<Minor>.<Patch> version triple."
     )
 endif()
 
-# Figure out the target by just using the host target.
-# If you want to cross-compile, you'll have to set Rust_CARGO_TARGET
-if(NOT Rust_CARGO_TARGET_CACHED)
-  execute_process(
+execute_process(
     COMMAND "${Rust_COMPILER_CACHED}" --version --verbose
     OUTPUT_VARIABLE _RUSTC_VERSION_RAW
     RESULT_VARIABLE _RUSTC_VERSION_RESULT
-  )
+)
 
-  if(NOT ( "${_RUSTC_VERSION_RESULT}" EQUAL "0" ))
-    message(FATAL_ERROR "Failed to get rustc version.\n"
-      "${Rust_COMPILER} --version failed with error: `${_RUSTC_VERSION_RESULT}`")
-  endif()
+if(NOT ( "${_RUSTC_VERSION_RESULT}" EQUAL "0" ))
+    _findrust_failed("Failed to get rustc version.\n"
+        "${Rust_COMPILER_CACHED} --version failed with error: `${_RUSTC_VERSION_RESULT}`")
+endif()
 
-  if (_RUSTC_VERSION_RAW MATCHES "host: ([a-zA-Z0-9_\\-]*)\n")
+if (_RUSTC_VERSION_RAW MATCHES "rustc ([0-9]+)\\.([0-9]+)\\.([0-9]+)(-nightly)?")
+    set(Rust_VERSION_MAJOR "${CMAKE_MATCH_1}" CACHE INTERNAL "" FORCE)
+    set(Rust_VERSION_MINOR "${CMAKE_MATCH_2}" CACHE INTERNAL "" FORCE)
+    set(Rust_VERSION_PATCH "${CMAKE_MATCH_3}" CACHE INTERNAL "" FORCE)
+    set(Rust_VERSION "${Rust_VERSION_MAJOR}.${Rust_VERSION_MINOR}.${Rust_VERSION_PATCH}" CACHE INTERNAL "" FORCE)
+    if(CMAKE_MATCH_4)
+        set(Rust_IS_NIGHTLY 1 CACHE INTERNAL "" FORCE)
+    else()
+        set(Rust_IS_NIGHTLY 0 CACHE INTERNAL "" FORCE)
+    endif()
+else()
+    _findrust_failed("Failed to parse rustc version. `${Rust_COMPILER_CACHED} --version --verbose` "
+        "evaluated to:\n`${_RUSTC_VERSION_RAW}`"
+    )
+endif()
+
+if (_RUSTC_VERSION_RAW MATCHES "host: ([a-zA-Z0-9_\\-]*)\n")
     set(Rust_DEFAULT_HOST_TARGET "${CMAKE_MATCH_1}")
-  else()
-    message(FATAL_ERROR
-      "Failed to parse rustc host target. `rustc --version --verbose` evaluated to:\n${_RUSTC_VERSION_RAW}"
+    set(Rust_CARGO_HOST_TARGET_CACHED "${Rust_DEFAULT_HOST_TARGET}" CACHE STRING "Host triple")
+else()
+    _findrust_failed(
+        "Failed to parse rustc host target. `rustc --version --verbose` evaluated to:\n${_RUSTC_VERSION_RAW}"
     )
-  endif()
+endif()
 
-  if(CMAKE_CROSSCOMPILING)
-    message(FATAL_ERROR "CMake is in cross-compiling mode."
-      "Manually set `Rust_CARGO_TARGET`."
+if (_RUSTC_VERSION_RAW MATCHES "LLVM version: ([0-9]+)\\.([0-9]+)(\\.([0-9]+))?")
+    set(Rust_LLVM_VERSION_MAJOR "${CMAKE_MATCH_1}" CACHE INTERNAL "" FORCE)
+    set(Rust_LLVM_VERSION_MINOR "${CMAKE_MATCH_2}" CACHE INTERNAL "" FORCE)
+    # With the Rust toolchain 1.44.1 the reported LLVM version is 9.0, i.e. without a patch version.
+    # Since cmake regex does not support non-capturing groups, just ignore Match 3.
+    set(Rust_LLVM_VERSION_PATCH "${CMAKE_MATCH_4}" CACHE INTERNAL "" FORCE)
+    set(Rust_LLVM_VERSION "${Rust_LLVM_VERSION_MAJOR}.${Rust_LLVM_VERSION_MINOR}.${Rust_LLVM_VERSION_PATCH}" CACHE INTERNAL "" FORCE)
+elseif(NOT Rust_FIND_QUIETLY)
+    message(
+            WARNING
+            "Failed to parse rustc LLVM version. `rustc --version --verbose` evaluated to:\n${_RUSTC_VERSION_RAW}"
     )
-  endif()
-  set(Rust_CARGO_TARGET_CACHED "${Rust_DEFAULT_HOST_TARGET}" CACHE STRING "Target triple")
+endif()
+
+if (NOT Rust_CARGO_TARGET_CACHED)
+    unset(_CARGO_ARCH)
+    unset(_CARGO_ABI)
+    if (WIN32)
+        if (CMAKE_VS_PLATFORM_NAME)
+            string(TOLOWER "${CMAKE_VS_PLATFORM_NAME}" LOWER_VS_PLATFORM_NAME)
+            if ("${LOWER_VS_PLATFORM_NAME}" STREQUAL "win32")
+                set(_CARGO_ARCH i686)
+            elseif("${LOWER_VS_PLATFORM_NAME}" STREQUAL "x64")
+                set(_CARGO_ARCH x86_64)
+            elseif("${LOWER_VS_PLATFORM_NAME}" STREQUAL "arm64")
+                set(_CARGO_ARCH aarch64)
+            else()
+                message(WARNING "VS Platform '${CMAKE_VS_PLATFORM_NAME}' not recognized")
+            endif()
+        endif()
+        # Fallback path
+        if(NOT DEFINED _CARGO_ARCH)
+            # Possible values for windows when not cross-compiling taken from here:
+            # https://learn.microsoft.com/en-us/windows/win32/winprog64/wow64-implementation-details
+            # When cross-compiling the user is expected to supply the value, so we match more variants.
+            if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(AMD64|amd64|x86_64)$")
+                set(_CARGO_ARCH x86_64)
+            elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(ARM64|arm64|aarch64)$")
+                set(_CARGO_ARCH aarch64)
+            elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^(X86|x86|i686)$")
+                set(_CARGO_ARCH i686)
+            elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "i586")
+                set(_CARGO_ARCH i586)
+            elseif(CMAKE_SYSTEM_PROCESSOR STREQUAL "IA64")
+                message(FATAL_ERROR "No rust target for Intel Itanium.")
+            elseif(NOT "${CMAKE_SYSTEM_PROCESSOR}")
+                message(WARNING "Failed to detect target architecture. Please set `CMAKE_SYSTEM_PROCESSOR`"
+                    " to your target architecture or set `Rust_CARGO_TARGET` to your cargo target triple."
+                )
+            else()
+                message(WARNING "Failed to detect target architecture. Please set "
+                    "`Rust_CARGO_TARGET` to your cargo target triple."
+                )
+            endif()
+        endif()
+
+        set(_CARGO_VENDOR "pc-windows")
+
+        # The MSVC Generators will always target the msvc ABI.
+        # For other generators we check the compiler ID and compiler target (if present)
+        # If no compiler is set and we are not cross-compiling then we just choose the
+        # default rust host target.
+        if(DEFINED MSVC
+            OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC"
+            OR "${CMAKE_C_COMPILER_ID}" STREQUAL "MSVC"
+            OR "${CMAKE_CXX_COMPILER_TARGET}" MATCHES "-msvc$"
+            OR "${CMAKE_C_COMPILER_TARGET}" MATCHES "-msvc$"
+        )
+            set(_CARGO_ABI msvc)
+        elseif("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU"
+            OR "${CMAKE_C_COMPILER_ID}" STREQUAL "GNU"
+            OR "${CMAKE_CXX_COMPILER_TARGET}" MATCHES "-gnu$"
+            OR "${CMAKE_C_COMPILER_TARGET}" MATCHES "-gnu$"
+            OR (NOT CMAKE_CROSSCOMPILING AND "${Rust_DEFAULT_HOST_TARGET}" MATCHES "-gnu$")
+            )
+            set(_CARGO_ABI gnu)
+        elseif(NOT "${CMAKE_CROSSCOMPILING}" AND "${Rust_DEFAULT_HOST_TARGET}" MATCHES "-msvc$")
+            # We first check if the gnu branch matches to ensure this fallback is only used
+            # if no compiler is enabled.
+            set(_CARGO_ABI msvc)
+        else()
+            message(WARNING "Could not determine the target ABI. Please specify `Rust_CARGO_TARGET` manually.")
+        endif()
+
+        if(DEFINED _CARGO_ARCH AND DEFINED _CARGO_VENDOR AND DEFINED _CARGO_ABI)
+            set(Rust_CARGO_TARGET_CACHED "${_CARGO_ARCH}-${_CARGO_VENDOR}-${_CARGO_ABI}"
+                CACHE STRING "Target triple")
+        endif()
+    elseif (ANDROID)
+        if (CMAKE_ANDROID_ARCH_ABI STREQUAL armeabi-v7a)
+            if (CMAKE_ANDROID_ARM_MODE)
+                set(_Rust_ANDROID_TARGET armv7-linux-androideabi)
+            else ()
+                set(_Rust_ANDROID_TARGET thumbv7neon-linux-androideabi)
+            endif()
+        elseif (CMAKE_ANDROID_ARCH_ABI STREQUAL arm64-v8a)
+            set(_Rust_ANDROID_TARGET aarch64-linux-android)
+        elseif (CMAKE_ANDROID_ARCH_ABI STREQUAL x86)
+            set(_Rust_ANDROID_TARGET i686-linux-android)
+        elseif (CMAKE_ANDROID_ARCH_ABI STREQUAL x86_64)
+            set(_Rust_ANDROID_TARGET x86_64-linux-android)
+        endif()
+
+        if (_Rust_ANDROID_TARGET)
+            set(Rust_CARGO_TARGET_CACHED "${_Rust_ANDROID_TARGET}" CACHE STRING "Target triple")
+        endif()
+    endif()
+    # Fallback to the default host target
+    if(NOT Rust_CARGO_TARGET_CACHED)
+        if(CMAKE_CROSSCOMPILING)
+            message(WARNING "CMake is in cross-compiling mode, but the cargo target-triple could not be inferred."
+                "Falling back to the default host target. Please consider manually setting `Rust_CARGO_TARGET`."
+            )
+        endif()
+        set(Rust_CARGO_TARGET_CACHED "${Rust_DEFAULT_HOST_TARGET}" CACHE STRING "Target triple")
+    endif()
+
+    message(STATUS "Rust Target: ${Rust_CARGO_TARGET_CACHED}")
+endif()
+
+if(Rust_CARGO_TARGET_CACHED STREQUAL Rust_DEFAULT_HOST_TARGET)
+    set(Rust_CROSSCOMPILING FALSE CACHE INTERNAL "Rust is configured for cross-compiling")
+else()
+    set(Rust_CROSSCOMPILING TRUE  CACHE INTERNAL "Rust is configured for cross-compiling")
+endif()
+
+_corrosion_parse_target_triple("${Rust_CARGO_TARGET_CACHED}" rust_arch rust_vendor rust_os rust_env)
+_corrosion_parse_target_triple("${Rust_CARGO_HOST_TARGET_CACHED}" rust_host_arch rust_host_vendor rust_host_os rust_host_env)
+
+set(Rust_CARGO_TARGET_ARCH "${rust_arch}" CACHE INTERNAL "Target architecture")
+set(Rust_CARGO_TARGET_VENDOR "${rust_vendor}" CACHE INTERNAL "Target vendor")
+set(Rust_CARGO_TARGET_OS "${rust_os}" CACHE INTERNAL "Target Operating System")
+set(Rust_CARGO_TARGET_ENV "${rust_env}" CACHE INTERNAL "Target environment")
+
+set(Rust_CARGO_HOST_ARCH "${rust_host_arch}" CACHE INTERNAL "Host architecture")
+set(Rust_CARGO_HOST_VENDOR "${rust_host_vendor}" CACHE INTERNAL "Host vendor")
+set(Rust_CARGO_HOST_OS "${rust_host_os}" CACHE INTERNAL "Host Operating System")
+set(Rust_CARGO_HOST_ENV "${rust_host_env}" CACHE INTERNAL "Host environment")
+
+if(NOT DEFINED CACHE{Rust_CARGO_TARGET_LINK_NATIVE_LIBS})
+    message(STATUS "Determining required link libraries for target ${Rust_CARGO_TARGET_CACHED}")
+    unset(required_native_libs)
+    _corrosion_determine_libs_new("${Rust_CARGO_TARGET_CACHED}" required_native_libs)
+    if(DEFINED required_native_libs)
+        message(STATUS "Required static libs for target ${Rust_CARGO_TARGET_CACHED}: ${required_native_libs}" )
+    endif()
+    # In very recent corrosion versions it is possible to override the rust compiler version
+    # per target, so to be totally correct we would need to determine the libraries for
+    # every installed Rust version, that the user could choose from.
+    # In practice there aren't likely going to be any major differences, so we just do it once
+    # for the target and once for the host target (if cross-compiling).
+    set(Rust_CARGO_TARGET_LINK_NATIVE_LIBS "${required_native_libs}" CACHE INTERNAL
+            "Required native libraries when linking Rust static libraries")
+endif()
+
+if(Rust_CROSSCOMPILING AND NOT DEFINED CACHE{Rust_CARGO_HOST_TARGET_LINK_NATIVE_LIBS})
+    message(STATUS "Determining required link libraries for target ${Rust_CARGO_HOST_TARGET_CACHED}")
+    unset(host_libs)
+    _corrosion_determine_libs_new("${Rust_CARGO_HOST_TARGET_CACHED}" host_libs)
+    if(DEFINED host_libs)
+        message(STATUS "Required static libs for host target ${Rust_CARGO_HOST_TARGET_CACHED}: ${host_libs}" )
+    endif()
+    set(Rust_CARGO_HOST_TARGET_LINK_NATIVE_LIBS "${host_libs}" CACHE INTERNAL
+        "Required native libraries when linking Rust static libraries for the host target")
 endif()
 
 # Set the input variables as non-cache variables so that the variables are available after
@@ -82,6 +782,24 @@ endforeach()
 
 find_package_handle_standard_args(
     Rust
-    REQUIRED_VARS Rust_COMPILER Rust_CARGO Rust_CARGO_TARGET
+    REQUIRED_VARS Rust_COMPILER Rust_VERSION Rust_CARGO Rust_CARGO_VERSION Rust_CARGO_TARGET Rust_CARGO_HOST_TARGET
+    VERSION_VAR Rust_VERSION
 )
 
+
+if(NOT TARGET Rust::Rustc)
+    add_executable(Rust::Rustc IMPORTED GLOBAL)
+    set_property(
+        TARGET Rust::Rustc
+        PROPERTY IMPORTED_LOCATION "${Rust_COMPILER_CACHED}"
+    )
+
+    add_executable(Rust::Cargo IMPORTED GLOBAL)
+    set_property(
+        TARGET Rust::Cargo
+        PROPERTY IMPORTED_LOCATION "${Rust_CARGO_CACHED}"
+    )
+    set(Rust_FOUND true)
+endif()
+
+list(POP_BACK CMAKE_MESSAGE_CONTEXT)

cmake/Install.cmake

@@ -37,12 +37,10 @@ set(MANUALS ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-tutorial.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-language.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-interactive.1
-            ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-terminal-compatibility.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-completions.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-prompt-tutorial.1
             ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-for-bash-users.1
-            ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-faq.1
-)
+            ${CMAKE_CURRENT_BINARY_DIR}/user_doc/man/man1/fish-faq.1)
 
 # Determine which man page we don't want to install.
 # On OS X, don't install a man page for open, since we defeat fish's open
@@ -156,8 +154,24 @@ install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/user_doc/html/ # Trailing slash is
         DESTINATION ${docdir} OPTIONAL)
 install(FILES CHANGELOG.rst DESTINATION ${docdir})
 
+# These files are built by cmake/gettext.cmake, but using GETTEXT_PROCESS_PO_FILES's
+# INSTALL_DESTINATION leads to them being installed as ${lang}.gmo, not fish.mo
+# The ${languages} array comes from cmake/gettext.cmake
+if(GETTEXT_FOUND)
+  foreach(lang ${languages})
+    install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${lang}.gmo DESTINATION
+            ${CMAKE_INSTALL_LOCALEDIR}/${lang}/LC_MESSAGES/ RENAME fish.mo)
+  endforeach()
+endif()
+
+if (NOT APPLE)
+    install(FILES fish.desktop DESTINATION ${rel_datadir}/applications)
+    install(FILES ${SPHINX_SRC_DIR}/python_docs_theme/static/fish.png DESTINATION ${rel_datadir}/pixmaps)
+endif()
+
 # Group install targets into a InstallTargets folder
 set_property(TARGET build_fish_pc CHECK-FISH-BUILD-VERSION-FILE
+                    tests_buildroot_target
              PROPERTY FOLDER cmake/InstallTargets)
 
 # Make a target build_root that installs into the buildroot directory, for testing.

cmake/Rust.cmake

@@ -1,3 +1,7 @@
+# Trying to build using the resolved toolchain causes all kinds of weird errors
+# Just let rustup do its job
+set(Rust_RESOLVE_RUSTUP_TOOLCHAINS Off)
+
 include(FindRust)
 find_package(Rust REQUIRED)
 
@@ -5,11 +9,11 @@ set(FISH_RUST_BUILD_DIR "${CMAKE_BINARY_DIR}/cargo/build")
 
 if(DEFINED ASAN)
     list(APPEND CARGO_FLAGS "-Z" "build-std")
-    list(APPEND FISH_CARGO_FEATURES_LIST "asan")
+    list(APPEND FISH_CRATE_FEATURES "asan")
 endif()
 if(DEFINED TSAN)
     list(APPEND CARGO_FLAGS "-Z" "build-std")
-    list(APPEND FISH_CARGO_FEATURES_LIST "tsan")
+    list(APPEND FISH_CRATE_FEATURES "tsan")
 endif()
 
 if (Rust_CARGO_TARGET)
@@ -21,26 +25,39 @@ endif()
 set(rust_profile $<IF:$<CONFIG:Debug>,debug,$<IF:$<CONFIG:RelWithDebInfo>,release-with-debug,release>>)
 set(rust_debugflags "$<$<CONFIG:Debug>:-g>$<$<CONFIG:RelWithDebInfo>:-g>")
 
-option(WITH_GETTEXT "Build with gettext localization support. Requires `msgfmt` to work." ON)
-# Enable gettext feature unless explicitly disabled.
-if(NOT DEFINED WITH_GETTEXT OR "${WITH_GETTEXT}")
-    list(APPEND FISH_CARGO_FEATURES_LIST "localize-messages")
+
+# Temporary hack to propogate CMake flags/options to build.rs. We need to get CMake to evaluate the
+# truthiness of the strings if they are set.
+set(CMAKE_WITH_GETTEXT "1")
+if(DEFINED WITH_GETTEXT AND NOT "${WITH_GETTEXT}")
+    set(CMAKE_WITH_GETTEXT "0")
 endif()
 
-list(JOIN FISH_CARGO_FEATURES_LIST , FISH_CARGO_FEATURES)
+if(FISH_CRATE_FEATURES)
+    set(FEATURES_ARG ${FISH_CRATE_FEATURES})
+    list(PREPEND FEATURES_ARG "--features")
+endif()
+
+get_property(
+    RUSTC_EXECUTABLE
+    TARGET Rust::Rustc PROPERTY IMPORTED_LOCATION
+)
 
 # Tell Cargo where our build directory is so it can find Cargo.toml.
 set(VARS_FOR_CARGO
     "FISH_BUILD_DIR=${CMAKE_BINARY_DIR}"
     "PREFIX=${CMAKE_INSTALL_PREFIX}"
+    # Temporary hack to propogate CMake flags/options to build.rs.
+    "CMAKE_WITH_GETTEXT=${CMAKE_WITH_GETTEXT}"
     # Cheesy so we can tell cmake was used to build
     "CMAKE=1"
     "DOCDIR=${CMAKE_INSTALL_FULL_DOCDIR}"
     "DATADIR=${CMAKE_INSTALL_FULL_DATADIR}"
     "SYSCONFDIR=${CMAKE_INSTALL_FULL_SYSCONFDIR}"
     "BINDIR=${CMAKE_INSTALL_FULL_BINDIR}"
+    "LOCALEDIR=${CMAKE_INSTALL_FULL_LOCALEDIR}"
     "CARGO_TARGET_DIR=${FISH_RUST_BUILD_DIR}"
-    "CARGO_BUILD_RUSTC=${Rust_COMPILER}"
+    "CARGO_BUILD_RUSTC=${RUSTC_EXECUTABLE}"
     "${FISH_PCRE2_BUILDFLAG}"
     "RUSTFLAGS=$ENV{RUSTFLAGS} ${rust_debugflags}"
 )

cmake/Tests.cmake

@@ -1,33 +1,127 @@
-add_executable(fish_test_helper tests/fish_test_helper.c)
+# This adds ctest support to the project
+enable_testing()
+
+# Put in a tests folder to reduce the top level targets in IDEs.
+set(CMAKE_FOLDER tests)
+
+# We will use 125 as a reserved exit code to indicate that a test has been skipped, i.e. it did not
+# pass but it should not be considered a failed test run, either.
+set(SKIP_RETURN_CODE 125)
+
+# Even though we are using CMake's ctest for testing, we still define our own `make fish_run_tests` target
+# rather than use its default for many reasons:
+#  * CMake doesn't run tests in-proc or even add each tests as an individual node in the ninja
+#    dependency tree, instead it just bundles all tests into a target called `test` that always just
+#    shells out to `ctest`, so there are no build-related benefits to not doing that ourselves.
+#  * The only way to have a test depend on a binary is to add a fake test with a name like
+#    "build_fish" that executes CMake recursively to build the `fish` target.
+#  * Circling back to the point about individual tests not being actual Makefile targets, CMake does
+#    not offer any way to execute a named test via the `make`/`ninja`/whatever interface; the only
+#    way to manually invoke test `foo` is to to manually run `ctest` and specify a regex matching
+#    `foo` as an argument, e.g. `ctest -R ^foo$`... which is really crazy.
+
+# The top-level test target is "fish_run_tests".
+add_custom_target(fish_run_tests
+  COMMAND env FISH_FORCE_COLOR=1
+          FISH_SOURCE_DIR=${CMAKE_SOURCE_DIR}
+          ${CMAKE_CTEST_COMMAND} --force-new-ctest-process # --verbose
+          --output-on-failure --progress
+  DEPENDS tests_dir funcs_dir tests_buildroot_target
+  USES_TERMINAL
+)
+
+# The "test" directory.
+set(TEST_DIR ${CMAKE_CURRENT_BINARY_DIR}/test)
+
+# The directory into which fish is installed.
+set(TEST_INSTALL_DIR ${TEST_DIR}/buildroot)
+
+# The directory where the tests expect to find the fish root (./bin, etc)
+set(TEST_ROOT_DIR ${TEST_DIR}/root)
+
+# Copy needed directories for out-of-tree builds
+if(NOT FISH_IN_TREE_BUILD)
+  add_custom_target(funcs_dir)
+  add_custom_command(TARGET funcs_dir
+    POST_BUILD
+    COMMAND mkdir -p ${CMAKE_BINARY_DIR}/share
+    # Don't run ln twice or it will create a new link in the link.
+    COMMAND test -e ${CMAKE_BINARY_DIR}/share/functions || ln -sf
+                          ${CMAKE_SOURCE_DIR}/share/functions/ ${CMAKE_BINARY_DIR}/share/functions
+                       COMMENT "Symlinking fish functions to binary dir"
+                       VERBATIM)
+
+  add_custom_target(tests_dir DEPENDS tests)
+  add_custom_command(TARGET tests_dir
+                       POST_BUILD
+                       COMMAND ${CMAKE_COMMAND} -E copy_directory
+                       ${CMAKE_SOURCE_DIR}/tests/ ${CMAKE_BINARY_DIR}/tests/
+                       COMMENT "Copying test files to binary dir"
+                       VERBATIM)
+endif()
+
+# Copy littlecheck.py
+configure_file(build_tools/littlecheck.py littlecheck.py COPYONLY)
+
+# Copy pexpect_helper.py
+configure_file(build_tools/pexpect_helper.py pexpect_helper.py COPYONLY)
+
+# Suppress generating Xcode schemes for all tests, there's too many.
+set(CMAKE_XCODE_GENERATE_SCHEME 0)
+
+# CMake being CMake, you can't just add a DEPENDS argument to add_test to make it depend on any of
+# your binaries actually being built before `make fish_run_tests` is executed (requiring `make all` first),
+# and the only dependency a test can have is on another test. So we make building fish
+# prerequisites to our entire top-level `test` target.
+function(add_test_target NAME)
+  string(REPLACE "/" "-" NAME ${NAME})
+  add_custom_target("test_${NAME}" COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure -R "^${NAME}$$"
+    DEPENDS tests_dir funcs_dir tests_buildroot_target USES_TERMINAL )
+endfunction()
+
+add_custom_target(tests_buildroot_target
+                  # Make the directory in which to run tests:
+                  COMMAND ${CMAKE_COMMAND} -E make_directory ${TEST_INSTALL_DIR}
+                  COMMAND env DESTDIR=${TEST_INSTALL_DIR} ${CMAKE_COMMAND}
+                          --build ${CMAKE_CURRENT_BINARY_DIR} --target install
+                  # Put fish_test_helper there too:
+                  COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/fish_test_helper
+                          ${TEST_INSTALL_DIR}/${CMAKE_INSTALL_PREFIX}/bin
+                  # Also symlink fish to where the tests expect it to be:
+                  COMMAND ${CMAKE_COMMAND} -E create_symlink
+                          ${TEST_INSTALL_DIR}/${CMAKE_INSTALL_PREFIX}
+                          ${TEST_ROOT_DIR}
+                  DEPENDS fish fish_test_helper)
 
 FILE(GLOB FISH_CHECKS CONFIGURE_DEPENDS ${CMAKE_SOURCE_DIR}/tests/checks/*.fish)
 foreach(CHECK ${FISH_CHECKS})
   get_filename_component(CHECK_NAME ${CHECK} NAME)
-  add_custom_target(
-    test_${CHECK_NAME}
-    COMMAND ${CMAKE_SOURCE_DIR}/tests/test_driver.py ${CMAKE_CURRENT_BINARY_DIR}
-                checks/${CHECK_NAME}
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tests
-    DEPENDS fish fish_indent fish_key_reader fish_test_helper
-    USES_TERMINAL
+  get_filename_component(CHECK ${CHECK} NAME_WE)
+  add_test(NAME ${CHECK_NAME}
+    COMMAND sh ${CMAKE_CURRENT_BINARY_DIR}/tests/test_driver.sh
+               ${CMAKE_CURRENT_BINARY_DIR}/tests/test.fish ${CHECK}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tests
   )
+  set_tests_properties(${CHECK_NAME} PROPERTIES SKIP_RETURN_CODE ${SKIP_RETURN_CODE})
+  set_tests_properties(${CHECK_NAME} PROPERTIES ENVIRONMENT FISH_FORCE_COLOR=1)
+  add_test_target("${CHECK_NAME}")
 endforeach(CHECK)
 
 FILE(GLOB PEXPECTS CONFIGURE_DEPENDS ${CMAKE_SOURCE_DIR}/tests/pexpects/*.py)
 foreach(PEXPECT ${PEXPECTS})
   get_filename_component(PEXPECT ${PEXPECT} NAME)
-  add_custom_target(
-    test_${PEXPECT}
-    COMMAND ${CMAKE_SOURCE_DIR}/tests/test_driver.py ${CMAKE_CURRENT_BINARY_DIR}
-                pexpects/${PEXPECT}
-    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tests
-    DEPENDS fish fish_indent fish_key_reader fish_test_helper
-    USES_TERMINAL
+  add_test(NAME ${PEXPECT}
+    COMMAND sh ${CMAKE_CURRENT_BINARY_DIR}/tests/test_driver.sh
+      ${CMAKE_CURRENT_BINARY_DIR}/tests/interactive.fish ${PEXPECT}
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tests
   )
+  set_tests_properties(${PEXPECT} PROPERTIES SKIP_RETURN_CODE ${SKIP_RETURN_CODE})
+  set_tests_properties(${PEXPECT} PROPERTIES ENVIRONMENT FISH_FORCE_COLOR=1)
+  add_test_target("${PEXPECT}")
 endforeach(PEXPECT)
 
-# Rust stuff.
 set(cargo_test_flags)
+# Rust stuff.
 if(DEFINED ASAN)
     # Rust w/ -Zsanitizer=address requires explicitly specifying the --target triple or else linker
     # errors pertaining to asan symbols will ensue.
@@ -48,17 +142,10 @@ if(DEFINED Rust_CARGO_TARGET)
     list(APPEND cargo_test_flags "--lib")
 endif()
 
-set(max_concurrency_flag)
-if(DEFINED ENV{FISH_TEST_MAX_CONCURRENCY})
-    list(APPEND max_concurrency_flag "--max-concurrency" $ENV{FISH_TEST_MAX_CONCURRENCY})
-endif()
-
-# The top-level test target is "fish_run_tests".
-add_custom_target(fish_run_tests
-  # TODO: This should be replaced with a unified solution, possibly build_tools/check.sh.
-  COMMAND ${CMAKE_SOURCE_DIR}/tests/test_driver.py ${max_concurrency_flag} ${CMAKE_CURRENT_BINARY_DIR}
-  COMMAND env ${VARS_FOR_CARGO} cargo test --no-default-features ${CARGO_FLAGS} --workspace --target-dir ${rust_target_dir} ${cargo_test_flags}
-  WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
-  DEPENDS fish fish_indent fish_key_reader fish_test_helper
-  USES_TERMINAL
+add_test(
+    NAME "cargo-test"
+    COMMAND env ${VARS_FOR_CARGO} cargo test --no-default-features ${CARGO_FLAGS} --workspace --target-dir ${rust_target_dir} ${cargo_test_flags}
+    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
 )
+set_tests_properties("cargo-test" PROPERTIES SKIP_RETURN_CODE ${SKIP_RETURN_CODE})
+add_test_target("cargo-test")

cmake/gettext.cmake

@@ -0,0 +1,22 @@
+set(languages de en fr pl pt_BR sv zh_CN)
+
+include(FeatureSummary)
+
+option(WITH_GETTEXT "translate messages if gettext is available" ON)
+if(WITH_GETTEXT)
+  find_package(Gettext)
+endif()
+add_feature_info(gettext GETTEXT_FOUND "translate messages with gettext")
+
+# Define translations
+if(GETTEXT_FOUND)
+  # Group pofile targets into their own folder, as there's a lot of them.
+  set(CMAKE_FOLDER pofiles)
+  foreach(lang ${languages})
+    # Our translations aren't set up entirely as CMake expects, so installation is done in
+    # cmake/Install.cmake instead of using INSTALL_DESTINATION
+    gettext_process_po_files(${lang} ALL
+                             PO_FILES po/${lang}.po)
+  endforeach()
+  set(CMAKE_FOLDER)
+endif()

crates/build-helper/Cargo.toml

@@ -1,12 +0,0 @@
-[package]
-name = "fish-build-helper"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.0.0"
-repository.workspace = true
-
-[dependencies]
-rsconf.workspace = true
-
-[lints]
-workspace = true

crates/build-helper/src/lib.rs

@@ -1,31 +0,0 @@
-use std::{borrow::Cow, env, path::Path};
-
-pub fn workspace_root() -> &'static Path {
-    let manifest_dir = Path::new(env!("CARGO_MANIFEST_DIR"));
-    manifest_dir.ancestors().nth(2).unwrap()
-}
-
-fn cargo_target_dir() -> Cow<'static, Path> {
-    option_env!("CARGO_TARGET_DIR")
-        .map(|d| Cow::Borrowed(Path::new(d)))
-        .unwrap_or(Cow::Owned(workspace_root().join("target")))
-}
-
-pub fn fish_build_dir() -> Cow<'static, Path> {
-    // FISH_BUILD_DIR is set by CMake, if we are using it.
-    option_env!("FISH_BUILD_DIR")
-        .map(|d| Cow::Borrowed(Path::new(d)))
-        .unwrap_or(cargo_target_dir())
-}
-
-// TODO Move this to rsconf
-pub fn rebuild_if_path_changed<P: AsRef<Path>>(path: P) {
-    rsconf::rebuild_if_path_changed(path.as_ref().to_str().unwrap());
-}
-
-// TODO Move this to rsconf
-pub fn rebuild_if_paths_changed<P: AsRef<Path>, I: IntoIterator<Item = P>>(paths: I) {
-    for path in paths {
-        rsconf::rebuild_if_path_changed(path.as_ref().to_str().unwrap());
-    }
-}

crates/build-man-pages/Cargo.toml

@@ -1,13 +0,0 @@
-[package]
-name = "fish-build-man-pages"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.0.0"
-repository.workspace = true
-
-[build-dependencies]
-fish-build-helper.workspace = true
-rsconf.workspace = true
-
-[lints]
-workspace = true

crates/build-man-pages/build.rs

@@ -1,98 +0,0 @@
-#[cfg(not(clippy))]
-use std::path::Path;
-
-fn main() {
-    let mandir = fish_build_helper::fish_build_dir().join("fish-man");
-    let sec1dir = mandir.join("man1");
-    // Running `cargo clippy` on a clean build directory panics, because when rust-embed tries to
-    // embed a directory which does not exist it will panic.
-    let _ = std::fs::create_dir_all(sec1dir.to_str().unwrap());
-
-    #[cfg(not(clippy))]
-    build_man(&mandir);
-}
-
-#[cfg(not(clippy))]
-fn build_man(man_dir: &Path) {
-    use std::{
-        env,
-        process::{Command, Stdio},
-    };
-
-    use fish_build_helper::workspace_root;
-
-    let workspace_root = workspace_root();
-
-    let man_str = man_dir.to_str().unwrap();
-
-    let sec1_dir = man_dir.join("man1");
-    let sec1_str = sec1_dir.to_str().unwrap();
-
-    let docsrc_dir = workspace_root.join("doc_src");
-    let docsrc_str = docsrc_dir.to_str().unwrap();
-
-    let sphinx_doc_sources = [
-        workspace_root.join("CHANGELOG.rst"),
-        workspace_root.join("CONTRIBUTING.rst"),
-        docsrc_dir.clone(),
-    ];
-    fish_build_helper::rebuild_if_paths_changed(sphinx_doc_sources);
-
-    let args = &[
-        "-j", "auto", "-q", "-b", "man", "-c", docsrc_str,
-        // doctree path - put this *above* the man1 dir to exclude it.
-        // this is ~6M
-        "-d", man_str, docsrc_str, sec1_str,
-    ];
-    let _ = std::fs::create_dir_all(sec1_str);
-
-    rsconf::rebuild_if_env_changed("FISH_BUILD_DOCS");
-    if env::var("FISH_BUILD_DOCS") == Ok("0".to_string()) {
-        rsconf::warn!("Skipping man pages because $FISH_BUILD_DOCS is set to 0");
-        return;
-    }
-
-    // We run sphinx to build the man pages.
-    // Every error here is fatal so cargo doesn't cache the result
-    // - if we skipped the docs with sphinx not installed, installing it would not then build the docs.
-    // That means you need to explicitly set $FISH_BUILD_DOCS=0 (`FISH_BUILD_DOCS=0 cargo install --path .`),
-    // which is unfortunate - but the docs are pretty important because they're also used for --help.
-    let sphinx_build = match Command::new("sphinx-build")
-        .args(args)
-        .stdout(Stdio::piped())
-        .stderr(Stdio::piped())
-        .spawn()
-    {
-        Err(e) if e.kind() == std::io::ErrorKind::NotFound => {
-            if env::var("FISH_BUILD_DOCS") == Ok("1".to_string()) {
-                panic!("Could not find sphinx-build to build man pages.\nInstall sphinx or disable building the docs by setting $FISH_BUILD_DOCS=0.");
-            }
-            rsconf::warn!("Cannot find sphinx-build to build man pages.");
-            rsconf::warn!("If you install it now you need to run `cargo clean` and rebuild, or set $FISH_BUILD_DOCS=1 explicitly.");
-            return;
-        }
-        Err(e) => {
-            // Another error - permissions wrong etc
-            panic!("Error starting sphinx-build to build man pages: {:?}", e);
-        }
-        Ok(sphinx_build) => sphinx_build,
-    };
-
-    match sphinx_build.wait_with_output() {
-        Err(err) => {
-            panic!(
-                "Error waiting for sphinx-build to build man pages: {:?}",
-                err
-            );
-        }
-        Ok(out) => {
-            if !out.stderr.is_empty() {
-                rsconf::warn!("sphinx-build: {}", String::from_utf8_lossy(&out.stderr));
-            }
-            assert_eq!(&String::from_utf8_lossy(&out.stdout), "");
-            if !out.status.success() {
-                panic!("sphinx-build failed to build the man pages.");
-            }
-        }
-    }
-}

crates/build-man-pages/src/lib.rs

@@ -1 +0,0 @@
-

crates/gettext-extraction/Cargo.toml

@@ -1,16 +0,0 @@
-[package]
-name = "fish-gettext-extraction"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.0.0"
-repository.workspace = true
-description = "proc-macro for extracting strings for gettext translation"
-
-[lib]
-proc-macro = true
-
-[dependencies]
-proc-macro2.workspace = true
-
-[lints]
-workspace = true

crates/gettext-extraction/src/lib.rs

@@ -1,107 +0,0 @@
-extern crate proc_macro;
-use proc_macro::TokenStream;
-use std::{ffi::OsString, fs::OpenOptions, io::Write};
-
-fn unescape_multiline_rust_string(s: String) -> String {
-    if !s.contains('\n') {
-        return s;
-    }
-    let mut unescaped = String::new();
-    enum State {
-        Ground,
-        Escaped,
-        ContinuationLineLeadingWhitespace,
-    }
-    use State::*;
-    let mut state = Ground;
-    for c in s.chars() {
-        match state {
-            Ground => match c {
-                '\\' => state = Escaped,
-                _ => {
-                    unescaped.push(c);
-                }
-            },
-            Escaped => match c {
-                '\\' => {
-                    unescaped.push('\\');
-                    state = Ground
-                }
-                '\n' => state = ContinuationLineLeadingWhitespace,
-                _ => panic!("Unsupported escape sequence '\\{c}' in message string '{s}'"),
-            },
-            ContinuationLineLeadingWhitespace => match c {
-                ' ' | '\t' => (),
-                _ => {
-                    unescaped.push(c);
-                    state = Ground
-                }
-            },
-        }
-    }
-    unescaped
-}
-
-fn append_po_entry_to_file(message: &TokenStream, file_name: &OsString) {
-    let mut file = OpenOptions::new()
-        .create(true)
-        .append(true)
-        .open(file_name)
-        .unwrap_or_else(|e| panic!("Could not open file {file_name:?}: {e}"));
-    let message_string = unescape_multiline_rust_string(message.to_string());
-    if message_string.contains('\n') {
-        panic!("Gettext strings may not contain unescaped newlines. Unescaped newline found in '{message_string}'")
-    }
-    // Crude check for format strings. This might result in false positives.
-    let format_string_annotation = if message_string.contains('%') {
-        "#, c-format\n"
-    } else {
-        ""
-    };
-    let po_entry = format!("{format_string_annotation}msgid {message_string}\nmsgstr \"\"\n\n");
-    file.write_all(po_entry.as_bytes()).unwrap();
-}
-
-/// The `message` is passed through unmodified.
-/// If `FISH_GETTEXT_EXTRACTION_FILE` is defined in the environment,
-/// this file is used to write the message,
-/// so that it can then be used for generating gettext PO files.
-/// The `message` must be a string literal.
-///
-/// # Panics
-///
-/// This macro panics if the `FISH_GETTEXT_EXTRACTION_FILE` variable is set and `message` has an
-/// unexpected format.
-/// Note that for example `concat!(...)` cannot be passed to this macro, because expansion works
-/// outside in, meaning this macro would still see the `concat!` macro invocation, instead of a
-/// string literal.
-#[proc_macro]
-pub fn gettext_extract(message: TokenStream) -> TokenStream {
-    if let Some(file_path) = std::env::var_os("FISH_GETTEXT_EXTRACTION_FILE") {
-        let pm2_message = proc_macro2::TokenStream::from(message.clone());
-        let mut token_trees = pm2_message.into_iter();
-        let first_token = token_trees
-            .next()
-            .expect("gettext_extract got empty token stream. Expected one token.");
-        if token_trees.next().is_some() {
-            panic!("Invalid number of tokens passed to gettext_extract. Expected one token, but got more.")
-        }
-        if let proc_macro2::TokenTree::Group(group) = first_token {
-            let mut group_tokens = group.stream().into_iter();
-            let first_group_token = group_tokens
-                .next()
-                .expect("gettext_extract expected one group token but got none.");
-            if group_tokens.next().is_some() {
-                panic!("Invalid number of tokens in group passed to gettext_extract. Expected one token, but got more.")
-            }
-            if let proc_macro2::TokenTree::Literal(_) = first_group_token {
-                append_po_entry_to_file(&message, &file_path);
-            } else {
-                panic!("Expected literal in gettext_extract, but got: {first_group_token:?}");
-            }
-        } else {
-            panic!("Expected group in gettext_extract, but got: {first_token:?}");
-        }
-    }
-    message
-}

crates/gettext-maps/Cargo.toml

@@ -1,18 +0,0 @@
-[package]
-name = "fish-gettext-maps"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.0.0"
-repository.workspace = true
-
-[dependencies]
-phf.workspace = true
-
-[build-dependencies]
-fish-build-helper.workspace = true
-fish-gettext-mo-file-parser.workspace = true
-phf_codegen.workspace = true
-rsconf.workspace = true
-
-[lints]
-workspace = true

crates/gettext-maps/build.rs

@@ -1,142 +0,0 @@
-use std::{
-    env,
-    ffi::OsStr,
-    path::{Path, PathBuf},
-    process::Command,
-};
-
-fn main() {
-    let cache_dir =
-        PathBuf::from(fish_build_helper::fish_build_dir()).join("fish-localization-map-cache");
-    embed_localizations(&cache_dir);
-
-    fish_build_helper::rebuild_if_path_changed(fish_build_helper::workspace_root().join("po"));
-}
-
-fn embed_localizations(cache_dir: &Path) {
-    use fish_gettext_mo_file_parser::parse_mo_file;
-    use std::{
-        fs::File,
-        io::{BufWriter, Write},
-    };
-
-    let po_dir = fish_build_helper::workspace_root().join("po");
-
-    // Ensure that the directory is created, because clippy cannot compile the code if the
-    // directory does not exist.
-    std::fs::create_dir_all(cache_dir).unwrap();
-
-    let localization_map_path =
-        Path::new(&env::var("OUT_DIR").unwrap()).join("localization_maps.rs");
-    let mut localization_map_file = BufWriter::new(File::create(&localization_map_path).unwrap());
-
-    // This will become a map which maps from language identifiers to maps containing localizations
-    // for the respective language.
-    let mut catalogs = phf_codegen::Map::new();
-
-    match Command::new("msgfmt").arg("-h").status() {
-        Err(e) if e.kind() == std::io::ErrorKind::NotFound => {
-            rsconf::warn!(
-                "Cannot find msgfmt to build gettext message catalogs. Localization will not work."
-            );
-            rsconf::warn!(
-                "If you install it now you need to trigger a rebuild to get localization support."
-            );
-            rsconf::warn!(
-                "One way to achieve that is running `touch po` followed by the build command."
-            );
-        }
-        Err(e) => {
-            panic!("Error when trying to run `msgfmt -h`: {e:?}");
-        }
-        Ok(_) => {
-            for dir_entry_result in po_dir.read_dir().unwrap() {
-                let dir_entry = dir_entry_result.unwrap();
-                let po_file_path = dir_entry.path();
-                if po_file_path.extension() != Some(OsStr::new("po")) {
-                    continue;
-                }
-                let lang = po_file_path
-                    .file_stem()
-                    .expect("All entries in the po directory must be regular files.");
-                let language = lang.to_str().unwrap().to_owned();
-
-                // Each language gets its own static map for the mapping from message in the source code to
-                // the localized version.
-                let map_name = format!("LANG_MAP_{language}");
-
-                let cached_map_path = cache_dir.join(lang);
-
-                // Include the file containing the map for this language in the main generated file.
-                writeln!(
-                    &mut localization_map_file,
-                    "include!(\"{}\");",
-                    cached_map_path.display()
-                )
-                .unwrap();
-                // Map from the language identifier to the map containing the localizations for this
-                // language.
-                catalogs.entry(language, format!("&{map_name}"));
-
-                if let Ok(metadata) = std::fs::metadata(&cached_map_path) {
-                    // Cached map file exists, but might be outdated.
-                    let cached_map_mtime = metadata.modified().unwrap();
-                    let po_mtime = dir_entry.metadata().unwrap().modified().unwrap();
-                    if cached_map_mtime > po_mtime {
-                        // Cached map file is considered up-to-date.
-                        continue;
-                    };
-                }
-
-                // Generate the map file.
-
-                // Try to create new MO data and load it into `mo_data`.
-                let output = Command::new("msgfmt")
-                    .arg("--check-format")
-                    .arg("--output-file=-")
-                    .arg(&po_file_path)
-                    .output()
-                    .unwrap();
-                let mo_data = output.stdout;
-
-                // Extract map from MO data.
-                let language_localizations = parse_mo_file(&mo_data).unwrap();
-
-                // This file will contain the localization map for the current language.
-                let mut cached_map_file = File::create(&cached_map_path).unwrap();
-                let mut single_language_localization_map = phf_codegen::Map::new();
-
-                // The values will be written into the source code as is, meaning escape sequences and
-                // double quotes in the data will be interpreted by the Rust compiler, which is undesirable.
-                // Converting them to raw strings prevents this. (As long as no input data contains `"###`.)
-                fn to_raw_str(s: &str) -> String {
-                    assert!(!s.contains("\"###"));
-                    format!("r###\"{s}\"###")
-                }
-                for (msgid, msgstr) in language_localizations {
-                    single_language_localization_map.entry(
-                        String::from_utf8(msgid.into()).unwrap(),
-                        to_raw_str(&String::from_utf8(msgstr.into()).unwrap()),
-                    );
-                }
-                writeln!(&mut cached_map_file, "#[allow(non_upper_case_globals)]").unwrap();
-                write!(
-                    &mut cached_map_file,
-                    "static {}: phf::Map<&'static str, &'static str> = {}",
-                    &map_name,
-                    single_language_localization_map.build()
-                )
-                .unwrap();
-                writeln!(&mut cached_map_file, ";").unwrap();
-            }
-        }
-    }
-
-    write!(
-        &mut localization_map_file,
-        "pub static CATALOGS: phf::Map<&str, &phf::Map<&str, &str>> = {}",
-        catalogs.build()
-    )
-    .unwrap();
-    writeln!(&mut localization_map_file, ";").unwrap();
-}

crates/gettext-maps/src/lib.rs

@@ -1 +0,0 @@
-include!(concat!(env!("OUT_DIR"), "/localization_maps.rs"));

crates/gettext-mo-file-parser/Cargo.toml

@@ -1,9 +0,0 @@
-[package]
-name = "fish-gettext-mo-file-parser"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.0.0"
-repository.workspace = true
-
-[lints]
-workspace = true

crates/gettext-mo-file-parser/src/lib.rs

@@ -1,131 +0,0 @@
-use std::collections::HashMap;
-
-const U32_SIZE: usize = std::mem::size_of::<u32>();
-
-fn read_le_u32(bytes: &[u8]) -> u32 {
-    u32::from_le_bytes(bytes[..U32_SIZE].try_into().unwrap())
-}
-
-fn read_be_u32(bytes: &[u8]) -> u32 {
-    u32::from_be_bytes(bytes[..U32_SIZE].try_into().unwrap())
-}
-
-fn get_u32_reader_from_magic_number(magic_number: &[u8]) -> std::io::Result<fn(&[u8]) -> u32> {
-    match magic_number {
-        [0x95, 0x04, 0x12, 0xde] => Ok(read_be_u32),
-        [0xde, 0x12, 0x04, 0x95] => Ok(read_le_u32),
-        _ => Err(std::io::Error::new(
-            std::io::ErrorKind::InvalidData,
-            "First 4 bytes of MO file must correspond to magic number 0x950412de, either big or little endian.",
-        )),
-    }
-}
-
-/// Returns an error if an unknown major revision is detected.
-/// There are no relevant differences between supported revisions.
-fn check_if_revision_is_supported(revision: u32) -> std::io::Result<()> {
-    // From the reference:
-    // A program seeing an unexpected major revision number should stop reading the MO file entirely;
-    // whereas an unexpected minor revision number means that the file can be read
-    // but will not reveal its full contents,
-    // when parsed by a program that supports only smaller minor revision numbers.
-    let major_revision = revision >> 16;
-    match major_revision {
-        0 | 1 => {
-            // At time of writing, these are the only major revisions which exist.
-            // There is no documented difference and the GNU gettext code does not seem to
-            // differentiate between the two either.
-            // All features we care about are supported in minor revision 0,
-            // so we do not need to care about the minor revision.
-            Ok(())
-        }
-        _ => Err(std::io::Error::new(
-            std::io::ErrorKind::InvalidData,
-            "Major revision must be 0 or 1",
-        )),
-    }
-}
-
-fn as_usize(value: u32) -> usize {
-    use std::mem::size_of;
-    const _: () = assert!(size_of::<u32>() <= size_of::<usize>());
-    usize::try_from(value).unwrap()
-}
-
-fn parse_strings(
-    file_content: &[u8],
-    num_strings: usize,
-    table_offset: usize,
-    read_u32: fn(&[u8]) -> u32,
-) -> std::io::Result<Vec<&[u8]>> {
-    let file_too_short_error = || {
-        Err(std::io::Error::new(
-            std::io::ErrorKind::InvalidData,
-            "MO file is too short.",
-        ))
-    };
-    if table_offset + num_strings * 2 * U32_SIZE > file_content.len() {
-        return file_too_short_error();
-    }
-    let mut strings = Vec::with_capacity(num_strings);
-    let mut offset = table_offset;
-    let mut get_next_u32 = || {
-        let val = read_u32(&file_content[offset..]);
-        offset += U32_SIZE;
-        val
-    };
-    for _ in 0..num_strings {
-        // not including NUL terminator
-        let string_length = as_usize(get_next_u32());
-        let string_offset = as_usize(get_next_u32());
-        let string_end = string_offset.checked_add(string_length).unwrap();
-        if string_end > file_content.len() {
-            return file_too_short_error();
-        }
-        // Contexts are stored by storing the concatenation of the context, a EOT byte, and the original string, instead of the original string.
-        // Contexts are not supported by this implementation.
-        // The format allows plural forms to appear behind singular forms, separated by a NUL byte,
-        // where `string_length` includes the length of both.
-        // This is not supported here.
-        // Do not include the NUL terminator in the slice.
-        strings.push(&file_content[string_offset..string_end]);
-    }
-    Ok(strings)
-}
-
-/// Parse a MO file.
-/// Format reference used: <https://www.gnu.org/software/gettext/manual/html_node/MO-Files.html>
-pub fn parse_mo_file(file_content: &[u8]) -> std::io::Result<HashMap<&[u8], &[u8]>> {
-    if file_content.len() < 7 * U32_SIZE {
-        return Err(std::io::Error::new(
-            std::io::ErrorKind::InvalidData,
-            "File too short to contain header.",
-        ));
-    }
-    // The first 4 bytes are a magic number, from which the endianness can be determined.
-    let read_u32 = get_u32_reader_from_magic_number(&file_content[0..U32_SIZE])?;
-    let mut offset = U32_SIZE;
-    let mut get_next_u32 = || {
-        let val = read_u32(&file_content[offset..]);
-        offset += U32_SIZE;
-        val
-    };
-    let file_format_revision = get_next_u32();
-    check_if_revision_is_supported(file_format_revision)?;
-    let num_strings = as_usize(get_next_u32());
-    let original_strings_offset = as_usize(get_next_u32());
-    let translation_strings_offset = as_usize(get_next_u32());
-    let original_strings =
-        parse_strings(file_content, num_strings, original_strings_offset, read_u32)?;
-    let translated_strings = parse_strings(
-        file_content,
-        num_strings,
-        translation_strings_offset,
-        read_u32,
-    )?;
-    let mut translation_map = HashMap::with_capacity(num_strings);
-    for i in 0..num_strings {
-        translation_map.insert(original_strings[i], translated_strings[i]);
-    }
-    Ok(translation_map)
-}

crates/printf/Cargo.toml

@@ -1,17 +0,0 @@
-[package]
-name = "fish-printf"
-edition.workspace = true
-rust-version.workspace = true
-version = "0.2.1"
-repository.workspace = true
-description = "printf implementation, based on musl"
-license = "MIT"
-
-[dependencies]
-libc.workspace = true
-widestring = { workspace = true, optional = true }
-unicode-segmentation.workspace = true
-unicode-width.workspace = true
-
-[lints]
-workspace = true

crates/printf/clippy.toml

@@ -1 +0,0 @@
-allow-print-in-tests = true

debian/control

@@ -20,16 +20,13 @@ Vcs-Browser: https://github.com/fish-shell/fish-shell
 
 Package: fish
 Architecture: any
-# for col and lock - bsdmainutils is required in Ubuntu focal
+Depends: bsdextrautils,
 Depends: bsdextrautils | bsdmainutils,
  file,
-# for the msgfmt command
  gettext-base,
-# for man
+ groff-base,
  man-db,
-# for terminal definitions
  ncurses-base,
-# for kill
  procps,
  python3 (>=3.5),
  ${misc:Depends},

debian/copyright

@@ -5,12 +5,12 @@ Source: https://fishshell.com/
 
 Files: *
 Copyright: 2005-2009 Axel Liljencrantz <axel@liljencrantz.se>
-           2009- fish-shell contributors
+           2009-2024 fish-shell contributors
 License: GPL-2
 
 Files: doc_src/python_docs_theme/*
 Copyright: 2001-2017 Python Software Foundation
-           2020- fish-shell contributors
+           2020-2024 fish-shell contributors
 License: Python
 
 Files: share/tools/web_config/js/alpine.js

debian/rules

@@ -17,9 +17,6 @@ override_dh_auto_configure:
 	dh_auto_configure --buildsystem=cmake -- -DCMAKE_BUILD_TYPE=RelWithDebInfo
 
 override_dh_clean:
-	dh_clean --exclude=Cargo.toml.orig
+	dh_clean
 	-unlink .cargo
 	-unlink vendor
-
-override_dh_auto_test:
-	make fish_run_tests

deny.toml

@@ -13,11 +13,10 @@ allow = [
     "MPL-2.0",
     "PSF-2.0",
     "Unicode-DFS-2016",
-    "Unicode-3.0",
     "WTFPL",
     "Zlib",
 ]
 
 [sources.allow-org]
 # 1 or more github.com organizations to allow git sources for
-github = ["fish-shell"]
+github = ["fish-shell"]

doc_internal/mac-artifacts.md

@@ -23,10 +23,10 @@ Steps:
 
 ## Building locally (no code signing)
 
-To build locally without notarizing and code signing, use the `build_tools/make_macos_pkg.sh` script:
+To build locally without notarizing and code signing, use the `build_tools/make_pkg.sh` script:
 
 ```
-> ./build_tools/make_macos_pkg.sh
+> ./build_tools/make_pkg.sh
 ```
 
 Packages will be placed in `~/fish_built` by default.
@@ -45,7 +45,7 @@ You will need the following:
 An example run:
 
 ```
-> ./build_tools/make_macos_pkg.sh -s \
+> ./build_tools/make_pkg.sh -s \
     -f fish-developer-id-application.p12 \
     -i fish-developer-id-installer.p12 \
     -p "$NOTARIZE_PASSWORD"  \

doc_src/cmds/_.rst

@@ -15,15 +15,12 @@ Description
 
 ``_`` translates its arguments into the current language, if possible.
 
-This only works with messages which are translated as part of fish's own sources, so using it as part of your own fish scripts which are not upstreamed into the fish repo will not work unless the exact same message also exists upstream.
+It is equivalent to ``gettext fish STRING``, meaning it can only be used to look up fish's own translations.
 
-It requires fish to be built with gettext support. If that support is disabled or there is no translation it will echo the argument back.
+It requires fish to be built with gettext support. If that support is disabled, or there is no translation it will simply echo the argument back.
 
-The language depends on the current locale, set with :envvar:`LANG`, :envvar:`LC_MESSAGES`, :envvar:`LC_ALL`, and :envvar:`LANGUAGE`.
-These variables do not have to be exported for fish to use them, and fish's variable scopes are supported.
-If other programs launched via fish should respect these locale variables they have to be exported to make them available outside of fish.
+The language depends on the current locale, set with :envvar:`LANG` and :envvar:`LC_MESSAGES`.
 
-For :envvar:`LANGUAGE` you can use a list, or use colons to separate multiple languages.
 
 Options
 -------
@@ -33,20 +30,7 @@ Options
 Examples
 --------
 
-Use German translations::
+::
 
-    > set LANG de_DE.UTF-8
-    > _ file
+    > _ File
     Datei
-
-Specify a precedence of languages (only works with :envvar:`LANGUAGE`)::
-
-    > set LANGUAGE pt de
-    > _ file  # This message has a Portuguese translation.
-    arquivo
-    > _ "Invalid arguments"  # This message does not have a Portuguese translation, but a German one.
-    Ungültige Argumente
-    > _ untranslatable  # No translation in Portuguese, nor in German.
-    untranslatable
-
-Note that the specific examples may change if translations are added/modified.

doc_src/cmds/argparse.rst

@@ -14,21 +14,21 @@ Synopsis
 Description
 -----------
 
-This command makes it easy for fish scripts and functions to handle arguments. You pass arguments that define the known options, followed by a literal **--**, then the arguments to be parsed (which might also include a literal **--**). ``argparse`` then sets variables to indicate the passed options with their values, sets ``$argv_opts`` to the options and their values, and sets ``$argv`` to the remaining arguments. See the :ref:`usage <cmd-argparse-usage>` section below.
+This command makes it easy for fish scripts and functions to handle arguments. You pass arguments that define the known options, followed by a literal **--**, then the arguments to be parsed (which might also include a literal **--**). ``argparse`` then sets variables to indicate the passed options with their values, and sets ``$argv`` to the remaining arguments. See the :ref:`usage <cmd-argparse-usage>` section below.
 
 Each option specification (``OPTION_SPEC``) is written in the :ref:`domain specific language <cmd-argparse-option-specification>` described below. All OPTION_SPECs must appear after any argparse flags and before the ``--`` that separates them from the arguments to be parsed.
 
 Each option that is seen in the ARG list will result in variables named ``_flag_X``, where **X** is the short flag letter and the long flag name (if they are defined). For example a **--help** option could cause argparse to define one variable called ``_flag_h`` and another called ``_flag_help``.
 
-The variables will be set with local scope (i.e., as if the script had done ``set -l _flag_X``). If the flag is a boolean (that is, it is passed or not, it doesn't have a value) the values are the short and long flags seen. If the option is not a boolean the values will be zero or more values corresponding to the values collected when the ARG list is processed. If the flag was not seen the flag variable will not be set.
+The variables will be set with local scope (i.e., as if the script had done ``set -l _flag_X``). If the flag is a boolean (that is, it just is passed or not, it doesn't have a value) the values are the short and long flags seen. If the option is not a boolean the values will be zero or more values corresponding to the values collected when the ARG list is processed. If the flag was not seen the flag variable will not be set.
 
 Options
 -------
 
 The following ``argparse`` options are available. They must appear before all *OPTION_SPEC*\ s:
 
-**-n** or **--name** *NAME*
-    Use *NAME* in error messages. By default the current function name will be used, or ``argparse`` if run outside of a function.
+**-n** or **--name**
+    The command name for use in error messages. By default the current function name will be used, or ``argparse`` if run outside of a function.
 
 **-x** or **--exclusive** *OPTIONS*
     A comma separated list of options that are mutually exclusive. You can use this more than once to define multiple sets of mutually exclusive options.
@@ -40,44 +40,8 @@ The following ``argparse`` options are available. They must appear before all *O
 **-X** or **--max-args** *NUMBER*
     The maximum number of acceptable non-option arguments. The default is infinity.
 
-**-u** or **--move-unknown**
-    Allow unknown options, and move them from ``$argv`` to ``$argv_opts``. By default, Unknown options are treated as if they take optional arguments (i.e. have option spec ``=?``).
-
-    The above means that if a group of short options contains an unknown short option *followed* by a known short option, the known short option is
-    treated as an argument to the unknown one (e.g. ``--move-unknown h -- -oh`` will treat ``h`` as the argument to ``-o``, and so ``_flag_h`` will *not* be set).
-    In contrast, if the known option comes first (and does not take any arguments), the known option will be recognised (e.g. ``argparse --move-unknown h -- -ho`` *will* set ``$_flag_h`` to ``-h``)
-
 **-i** or **--ignore-unknown**
-    Deprecated. This is like **--move-unknown**, except that unknown options and their arguments are kept in ``$argv`` and not moved to ``$argv_opts``. Unlike **--move-unknown**, this option makes it impossible to distinguish between an unknown option and non-option argument that starts with a ``-`` (since any ``--`` seperator in ``$argv`` will be removed).
-
-**-S** or **--strict-longopts**
-    This makes the parsing of long options more strict. In particular, *without* this flag, if ``long`` is a known long option flag, ``--long`` and ``--long=<value>`` can be abbreviated as:
-
-    - ``-long`` and ``-long=<value>``, but *only* if there is no short flag ``l``.
-
-    - ``--lo`` and ``--lo=<value>``, but *only* if there is no other long flag that starts with ``lo``. Similarly with any other non-empty prefix of ``long``.
-
-    - ``-lo`` and ``-lo=<value>`` (i.e. combining the above two).
-
-    With the ``--strict-longopts`` flag, the above three are parse errors: one must use the syntax ``--long`` or ``--long=<value>`` to use a long option called ``long``.
-
-    This flag has no effect on the parsing of unknown options (which are parsed as if this flag is on).
-
-    This option may be on all the time in the future, so do not rely on the behaviour without it.
-
-**--unknown-arguments** *KIND*
-    This option implies **--move-unknown**, unless **--ignore-unknown** is also given.
-    This will modify the parsing behaviour of unknown options depending on the value of *KIND*:
-
-        - **optional** (the default), allows each unknown option to take an optional argument (i.e. as if it had ``=?`` or ``=*`` in its option specification). For example, ``argparse --ignore-unknown --unknown-arguments=optional ab -- -u -a -ub`` will set ``_flag_a`` but *not* ``_flag_b``, as the ``b`` is treated as an argument to the second use of ``-u``.
-
-        - **required** requires each unknown option to take an argument (i.e. as if it had ``=`` or ``=+`` in its option specification). If the above example was changed to use ``--unknown-arguments=required``, *neither* ``_flag_a`` nor ``_flag_b`` would be set: the ``-a`` will be treated as an argument to the first use of ``-u``, and the ``b`` as an argument to the second.
-
-        - **none** forbids each unknown option from taking an argument (i.e. as if it had no ``=`` in its option specification). If the above example was changed to use ``--unknown-arguments=none``, *both* ``_flag_a`` and ``_flag_b`` would be set, as neither use of ``-u`` will be passed as taking an argument.
-
-        Note that the above assumes that unknown long flags use the ``--`` "GNU-style" (e.g. if *KIND* is ``none``, and there is no ``bar`` long option, ``-bar`` is interpreted as three short flags, ``b``, ``a``, and ``r``; but if ``bar`` is known, ``-bar`` is treated the same as ``--bar``).
-
-        When using ``--unknown-arguments=required``, you will get an error if the provided arguments end in an unknown option, since it has no argument. Similarly, with ``--unknown-arguments=none``, you will get an error if you use the ``--flag=value`` syntax and ``flag`` is an unknown option.
+    Ignores unknown options, keeping them and their arguments in $argv instead.
 
 **-s** or **--stop-nonopt**
     Causes scanning the arguments to stop as soon as the first non-option argument is seen. Among other things, this is useful to implement subcommands that have their own options.
@@ -127,7 +91,7 @@ But this is not::
     set -l argv
     argparse 'h/help' 'n/name' $argv
 
-The first ``--`` seen is what allows the ``argparse`` command to reliably separate the option specifications and options to ``argparse`` itself (like ``--move-unknown``) from the command arguments, so it is required.
+The first ``--`` seen is what allows the ``argparse`` command to reliably separate the option specifications and options to ``argparse`` itself (like ``--ignore-unknown``) from the command arguments, so it is required.
 
 .. _cmd-argparse-option-specification:
 
@@ -136,13 +100,9 @@ Option Specifications
 
 Each option specification consists of:
 
-- An optional alphanumeric short flag character.
+- An optional alphanumeric short flag character, followed by a ``/`` if the short flag can be used by someone invoking your command or, for backwards compatibility, a ``-`` if it should not be exposed as a valid short flag (in which case it will also not be exposed as a flag variable).
 
-- An optional long flag name preceded by a ``/``. If neither a short flag nor long flag are present, an error is reported.
-
-    - If there is no short flag, and the long flag name is more than one character, the ``/`` can be omitted.
-
-    - For backwards compatibility, if there is a short and a long flag, a ``-`` can be used in place of the ``/``, if the short flag is not to be usable by users (in which case it will also not be exposed as a flag variable).
+- An optional long flag name, which if not present the short flag can be used, and if that is also not present, an error is reported
 
 - Nothing if the flag is a boolean that takes no argument or is an integer flag, or
 
@@ -150,15 +110,9 @@ Each option specification consists of:
 
     - **=?** if it takes an optional value and only the last instance of the flag is saved, or
 
-    - **=+** if it requires a value and each instance of the flag is saved, or
+    - **=+** if it requires a value and each instance of the flag is saved.
 
-    - **=\*** if it takes an optional value *and* each instance of the flag is saved, storing the empty string when the flag was not given a value.
-
-- Optionally a ``&``, indicating that the option and any attached values are not to be saved in ``$argv`` or ``$argv_opts``. This does not affect the the ``_flag_`` variables.
-
-- Nothing if the flag is a boolean that takes no argument, or
-
-    - ``!`` followed by fish script to validate the value. Typically this will be a function to run. If the exit status is zero the value for the flag is valid. If non-zero the value is invalid. Any error messages should be written to stdout (not stderr). See the section on :ref:`Flag Value Validation <flag-value-validation>` for more information.
+- Optionally a ``!`` followed by fish script to validate the value. Typically this will be a function to run. If the exit status is zero the value for the flag is valid. If non-zero the value is invalid. Any error messages should be written to stdout (not stderr). See the section on :ref:`Flag Value Validation <flag-value-validation>` for more information.
 
 See the :doc:`fish_opt <fish_opt>` command for a friendlier but more verbose way to create option specifications.
 
@@ -178,7 +132,7 @@ This does not read numbers given as ``+NNN``, only those that look like flags -
 Note: Optional arguments
 ------------------------
 
-An option defined with ``=?`` or ``=*`` can take optional arguments. Optional arguments have to be *directly attached* to the option they belong to.
+An option defined with ``=?`` can take optional arguments. Optional arguments have to be *directly attached* to the option they belong to.
 
 That means the argument will only be used for the option if you use it like::
 
@@ -211,7 +165,7 @@ This isn't specific to argparse but common to all things using ``getopt(3)`` (if
 Flag Value Validation
 ---------------------
 
-Sometimes you need to validate the option values. For example, that it is a valid integer within a specific range, or an ip address, or something entirely different. You can always do this after ``argparse`` returns but you can also request that ``argparse`` perform the validation by executing arbitrary fish script. To do so append an ``!`` (exclamation-mark) then the fish script to be run. When that code is executed three vars will be defined:
+Sometimes you need to validate the option values. For example, that it is a valid integer within a specific range, or an ip address, or something entirely different. You can always do this after ``argparse`` returns but you can also request that ``argparse`` perform the validation by executing arbitrary fish script. To do so simply append an ``!`` (exclamation-mark) then the fish script to be run. When that code is executed three vars will be defined:
 
 - ``_argparse_cmd`` will be set to the value of the value of the ``argparse --name`` value.
 
@@ -223,7 +177,7 @@ These variables are passed to the function as local exported variables.
 
 The script should write any error messages to stdout, not stderr. It should return a status of zero if the flag value is valid otherwise a non-zero status to indicate it is invalid.
 
-Fish ships with a ``_validate_int`` function that accepts a ``--min`` and ``--max`` flag. Let's say your command accepts a ``-m`` or ``--max`` flag and the minimum allowable value is zero and the maximum is 5. You would define the option like this: ``m/max=!_validate_int --min 0 --max 5``. The default if you call ``_validate_int`` without those flags is to check that the value is a valid integer with no limits on the min or max value allowed.
+Fish ships with a ``_validate_int`` function that accepts a ``--min`` and ``--max`` flag. Let's say your command accepts a ``-m`` or ``--max`` flag and the minimum allowable value is zero and the maximum is 5. You would define the option like this: ``m/max=!_validate_int --min 0 --max 5``. The default if you just call ``_validate_int`` without those flags is to simply check that the value is a valid integer with no limits on the min or max value allowed.
 
 Here are some examples of flag validations::
 
@@ -245,22 +199,16 @@ Some *OPTION_SPEC* examples:
 
 - ``help`` means that only ``--help`` is valid. The flag is a boolean and can be used more than once. If it is used then ``_flag_help`` will be set as above. Also ``h-help`` (with an arbitrary short letter) for backwards compatibility.
 
-- ``help&`` is similar (it will *remove* ``--help`` from ``$argv``), the difference is that ``--help``` will *not* placed in ``$argv_opts``.
-
 - ``longonly=`` is a flag ``--longonly`` that requires an option, there is no short flag or even short flag variable.
 
 - ``n/name=`` means that both ``-n`` and ``--name`` are valid. It requires a value and can be used at most once. If the flag is seen then ``_flag_n`` and ``_flag_name`` will be set with the single mandatory value associated with the flag.
 
 - ``n/name=?`` means that both ``-n`` and ``--name`` are valid. It accepts an optional value and can be used at most once. If the flag is seen then ``_flag_n`` and ``_flag_name`` will be set with the value associated with the flag if one was provided else it will be set with no values.
 
-- ``n/name=*`` is similar, but the flag can be used more than once. If the flag is seen then ``_flag_n`` and ``_flag_name`` will be set with the values associated with each occurence. Each value will be the value given to the option, or the empty string if no value was given.
-
 - ``name=+`` means that only ``--name`` is valid. It requires a value and can be used more than once. If the flag is seen then ``_flag_name`` will be set with the values associated with each occurrence.
 
 - ``x`` means that only ``-x`` is valid. It is a boolean that can be used more than once. If it is seen then ``_flag_x`` will be set as above.
 
-- ``/x`` is similar, but only ``--x`` is valid (instead of ``-x``).
-
 - ``x=``, ``x=?``, and ``x=+`` are similar to the n/name examples above but there is no long flag alternative to the short flag ``-x``.
 
 - ``#max`` (or ``#-max``) means that flags matching the regex "^--?\\d+$" are valid. When seen they are assigned to the variable ``_flag_max``. This allows any valid positive or negative integer to be specified by prefixing it with a single "-". Many commands support this idiom. For example ``head -3 /a/file`` to emit only the first three lines of /a/file.
@@ -269,7 +217,7 @@ Some *OPTION_SPEC* examples:
 
 - ``#longonly`` causes the last integer option to be stored in ``_flag_longonly``.
 
-After parsing the arguments the ``argv`` variable is set with local scope to any values not already consumed during flag processing. If there are no unbound values the variable is set but ``count $argv`` will be zero. Similarly, the ``argv_opts`` variable is set with local scope to the arguments that *were* consumed during flag processing. This allows forwarding ``$argv_opts`` to another command, together with additional arguments.
+After parsing the arguments the ``argv`` variable is set with local scope to any values not already consumed during flag processing. If there are no unbound values the variable is set but ``count $argv`` will be zero.
 
 If an error occurs during argparse processing it will exit with a non-zero status and print error messages to stderr.
 
@@ -286,7 +234,7 @@ A simple use::
         return 0
     end
 
-This supports one option - ``-h`` / ``--help``. Any other option is an error. If it is given it prints help and exits.
+This just wants one option - ``-h`` / ``--help``. Any other option is an error. If it is given it prints help and exits.
 
 How :doc:`fish_add_path` parses its args::
 
@@ -311,41 +259,17 @@ After this it figures out which variable it should operate on according to the `
     and set $var $result
 
 
-An example of using ``$argv_opts`` to forward known options to another command, whilst adding new options::
+Limitations
+-----------
 
-    function my-head
-        # The following option is the only existing one to head that takes arguments
-        # (we will forward it verbatim).
-        set -l opt_spec n/lines=
-        # --qwords is a new option, but --bytes is an existing one which we will modify below
-        set -a opt_spec "qwords=&" "c/bytes=&"
-        argparse --strict-longopts --move-unknown --unknown-arguments=none $opt_spec -- $argv || return
-        if set -q _flag_qwords
-            # --qwords allows specifying the size in multiples of 8 bytes
-            set -a argv_opts --bytes=(math -- $_flag_qwords \* 8 || return)
-        else if set -q _flag_bytes
-            # Allows using a 'q' suffix, e.g. --bytes=4q to mean 4*8 bytes.
-            if string match -qr 'q$' -- $_flag_bytes
-                set -a argv_opts --bytes=(math -- (string replace -r 'q$' '*8' -- $_flag_bytes) || return)
-            else
-                # Keep the users setting
-                set -a argv_opts --bytes=$_flag_bytes
-            end
+One limitation with **--ignore-unknown** is that, if an unknown option is given in a group with known options, the entire group will be kept in $argv. ``argparse`` will not do any permutations here.
 
-        end
+For instance::
 
-        if test (count $argv) -eq 0
-            # Default to heading /dev/kmsg (whereas head defaults to stdin)
-            set -l argv /dev/kmsg
-        end
+  argparse --ignore-unknown h -- -ho
+  echo $_flag_h # is -h, because -h was given
+  echo $argv # is still -ho
 
-        # Call the real head with our modified options and arguments.
-        head $argv_opts -- $argv
-    end
+This limitation may be lifted in future.
 
-
-The argparse call above saves all the options we do *not* want to process in ``$argv_opts``. (The ``--qwords`` and ``--bytes`` options are *not* saved there as their option spec's end in a ``~``). The code then processes the ``--qwords`` and ``--bytess`` options using the the ``$_flag_OPTION`` variables, and puts the transformed options in ``$argv_opts`` (which already contains all the original options, *other* than ``--qwords`` and ``--bytes``).
-
-Note that because the ``argparse`` call above uses ``--move-unknown`` and ``--unknown-arguments=none``, we only need to tell it the arguments to ``head`` that take a value. This allows the wrapper script to accurately work out the *non*-option arguments (i.e. ``$argv``, the filenames that ``head`` is to operate on). Using ``--unknown-arguments=optional`` and explicitly listing all the known options to ``head`` however would have the advantage that if ``head`` were to add new options, they could still be used with the wrapper script using the "stuck" form for arguments (e.g. ``-o<arg>``, or ``--opt=<arg>``).
-
-Note that the ``--strict-longopts`` is required to be able to correctly pass short options, e.g. without it ``my-head -q --bytes 10q``, will actually parse the ``-q`` as shorthand for ``--qwords``.
+Additionally, it can only parse known options up to the first unknown option in the group - the unknown option could take options, so it isn't clear what any character after an unknown option means.

doc_src/cmds/begin.rst

@@ -9,7 +9,6 @@ Synopsis
 .. synopsis::
 
     begin; [COMMANDS ...]; end
-    { [COMMANDS ...] }
 
 Description
 -----------
@@ -22,8 +21,6 @@ The block is unconditionally executed. ``begin; ...; end`` is equivalent to ``if
 
 ``begin`` does not change the current exit status itself. After the block has completed, ``$status`` will be set to the status returned by the most recent command.
 
-Some other shells only support the ``{ [COMMANDS ...] ; }`` notation.
-
 The **-h** or **--help** option displays help about using this command.
 
 Example

doc_src/cmds/bind.rst

@@ -11,7 +11,6 @@ Synopsis
     bind [(-M | --mode) MODE] [--preset] [--user] [KEYS]
     bind [-a | --all] [--preset] [--user]
     bind (-f | --function-names)
-    bind (-K | --key-names)
     bind (-L | --list-modes)
     bind (-e | --erase) [(-M | --mode) MODE] [--preset] [--user] [-a | --all] | KEYS ...
 
@@ -21,8 +20,7 @@ Description
 ``bind`` manages key bindings.
 
 If both ``KEYS`` and ``COMMAND`` are given, ``bind`` adds (or replaces) a binding in ``MODE``.
-If only ``KEYS`` is given, any existing binding for those keys in the given ``MODE`` will be printed.
-If no ``KEYS`` argument is provided, all bindings (in the given ``MODE``) are printed.
+If only ``KEYS`` is given, any existing binding in the given ``MODE`` will be printed.
 
 ``KEYS`` is a comma-separated list of key names.
 Modifier keys can be specified by prefixing a key name with a combination of ``ctrl-``, ``alt-``, ``shift-`` and ``super-`` (i.e. the "windows" or "command" key).
@@ -43,11 +41,9 @@ They are:
 - ``f1`` through ``f12``.
 - ``home``,
 - ``insert``,
-- ``menu``,
 - ``minus`` (``-``),
 - ``pageup``,
 - ``pagedown``,
-- ``printscreen``,
 - ``space`` and
 - ``tab``,
 
@@ -62,7 +58,9 @@ To find the name of a key combination you can use :doc:`fish_key_reader <fish_ke
 .. note::
     If a script changes the commandline, it should finish by calling the ``repaint`` special input function.
 
-Key bindings may use "modes", which mimics vi's modal input behavior. The default mode is "default" (in vi-mode, that's vi's "normal" mode). Every key binding applies to a single mode; you can specify which one with ``-M MODE``. If the key binding should change the mode, you can specify the new mode with ``-m NEW_MODE``. The mode can be viewed and changed via the ``$fish_bind_mode`` variable. If you want to change the mode from inside a fish function, use ``set fish_bind_mode MODE``.
+If no ``KEYS`` argument is provided, all bindings (in the given ``MODE``) are printed. If ``KEYS`` is provided but no ``COMMAND``, just the binding matching that sequence is printed.
+
+Key bindings may use "modes", which mimics vi's modal input behavior. The default mode is "default". Every key binding applies to a single mode; you can specify which one with ``-M MODE``. If the key binding should change the mode, you can specify the new mode with ``-m NEW_MODE``. The mode can be viewed and changed via the ``$fish_bind_mode`` variable. If you want to change the mode from inside a fish function, use ``set fish_bind_mode MODE``.
 
 To save custom key bindings, put the ``bind`` statements into :ref:`config.fish <configuration>`. Alternatively, fish also automatically executes a function called ``fish_user_key_bindings`` if it exists.
 
@@ -73,16 +71,11 @@ The following options are available:
 **-f** or **--function-names**
     Display a list of available input functions
 
-**-K** or **--key-names**
-    Display a list of available named keys such as ``backspace``.
-
 **-L** or **--list-modes**
     Display a list of defined bind modes
 
 **-M MODE** or **--mode** *MODE*
-    Specify a bind mode that the bind is used in. Defaults to "default".
-    If you use :ref:`vi bindings <vi-mode>`, that's the *command* mode,
-    what vi calls "normal" mode.
+    Specify a bind mode that the bind is used in. Defaults to "default"
 
 **-m NEW_MODE** or **--sets-mode** *NEW_MODE*
     Change the current mode to *NEW_MODE* after this binding is executed
@@ -106,6 +99,12 @@ The following options are available:
 **-s** or **--silent**
     Silences some of the error messages, including for unknown key names and unbound sequences.
 
+**-k KEY_NAME** or **--key KEY_NAME**
+    This looks up KEY_NAME in terminfo and binds that sequence instead of a key that fish would decode.
+    To view a list of the terminfo keys fish knows about, use ``bind --key-names`` or ``bind -K``.
+    This is deprecated and provided for compatibility with older fish versions. You should bind the keys directly.
+    Instead of ``bind -k sright`` use ``bind shift-right``, instead of ``bind -k nul`` use ``bind ctrl-space`` and so on.
+
 **-h** or **--help**
     Displays help about using this command.
 
@@ -169,7 +168,7 @@ The following special input functions are available:
     start selecting text
 
 ``cancel``
-    close the pager if it is open, or undo the most recent completion if one was just inserted
+    close the pager if it is open, or undo the most recent completion if one was just inserted, or otherwise cancel the current commandline and replace it with a new empty one
 
 ``cancel-commandline``
     cancel the current commandline and replace it with a new empty one, leaving the old one in place with a marker to show that it was cancelled
@@ -181,13 +180,7 @@ The following special input functions are available:
     empty the entire commandline
 
 ``clear-screen``
-    clears the screen and redraws the prompt.
-
-.. _special-input-functions-scrollback-push:
-
-``scrollback-push``
-    pushes earlier output to the terminal scrollback, positioning the prompt at the top.
-    This requires the terminal to implement the ECMA-48 :ref:`SCROLL UP <term-compat-indn>` command and :ref:`cursor position reporting <term-compat-cursor-position-report>`.
+    clears the screen and redraws the prompt. if the terminal doesn't support clearing the screen it is the same as ``repaint``.
 
 ``complete``
     guess the remainder of the current token
@@ -253,7 +246,7 @@ The following special input functions are available:
 ``history-pager``
     invoke the searchable pager on history (incremental search); or if the history pager is already active, search further backwards in time.
 
-``history-delete``
+``history-pager-delete``
     permanently delete the current history item, either from the history pager or from an active up-arrow history search
 
 ``history-search-backward``
@@ -274,12 +267,6 @@ The following special input functions are available:
 ``history-token-search-forward``
     search the history for the next matching argument
 
-``history-last-token-search-backward``
-    search the history for the previous matching last argument
-
-``history-last-token-search-forward``
-    search the history for the next matching last argument
-
 ``forward-jump`` and ``backward-jump``
     read another character and jump to its next occurrence after/before the cursor
 
@@ -428,24 +415,6 @@ Launch ``git diff`` and repaint the commandline afterwards when :kbd:`ctrl-g` is
 
    bind ctrl-g 'git diff' repaint
 
-Swap :kbd:`tab` and :kbd:`shift-tab`, making tab focus the search field.
-But if the search field is already active, keep the behavior (:kbd:`tab` cycles forward, :kbd:`shift-tab` backward).::
-
-   bind tab '
-       if commandline --search-field >/dev/null
-           commandline -f complete
-       else
-           commandline -f complete-and-search
-       end
-   '
-   bind shift-tab '
-       if commandline --search-field >/dev/null
-           commandline -f complete-and-search
-       else
-           commandline -f complete
-       end
-   '
-
 .. _cmd-bind-termlimits:
 
 Terminal Limitations

doc_src/cmds/break.rst

@@ -19,7 +19,7 @@ Description
 
 ``break`` halts a currently running loop (*LOOP_CONSTRUCT*), such as a :doc:`for <for>` or :doc:`while <while>` loop. It is usually added inside of a conditional block such as an :doc:`if <if>` block.
 
-The **-h** or **--help** option displays help about using this command.
+There are no parameters for ``break``.
 
 Example
 -------

doc_src/cmds/commandline.rst

@@ -45,9 +45,8 @@ The following options change the way ``commandline`` updates the command line bu
 **-a** or **--append**
     Do not remove the current commandline, append the specified string at the end of it.
 
-**-i**, **--insert** or **--insert-smart**
-    Do not remove the current commandline, insert the specified string at the current cursor position.
-    The **--insert-smart** option turns on a Do-What-I-Mean (DWIM) mode: it strips any **$** prefix from the first command on each line.
+**-i** or **--insert**
+    Do not remove the current commandline, insert the specified string at the current cursor position
 
 **-r** or **--replace**
     Remove the current commandline and replace it with the specified string (default)
@@ -74,9 +73,6 @@ The following options change what part of the commandline is printed or updated:
 **--search-field**
     Use the pager search field instead of the command line. Returns false if the search field is not shown.
 
-**--input=INPUT**
-    Operate on this string instead of the commandline. Useful for using options like **--tokens-expanded**.
-
 The following options change the way ``commandline`` prints the current commandline buffer:
 
 **-c** or **--cut-at-cursor**
@@ -90,7 +86,10 @@ The following options change the way ``commandline`` prints the current commandl
     Perform argument expansion on the selection and print one argument per line.
     Command substitutions are not expanded but forwarded as-is.
 
-**-o**, **tokenize**, **--tokens-raw**
+**--tokens-raw**
+    Print arguments in the selection as they appear on the command line, one per line.
+
+**-o** or **tokenize**
     Deprecated; do not use.
 
 If ``commandline`` is called during a call to complete a given string using ``complete -C STRING``, ``commandline`` will consider the specified string to be the current contents of the command line.

doc_src/cmds/complete.rst

@@ -63,9 +63,7 @@ The following options are available:
     Add a description for this completion, to be shown in the completion pager.
 
 **-w** or **--wraps** *WRAPPED_COMMAND*
-    Causes the specified command to inherit completions from *WRAPPED_COMMAND*.
-    This is used for "this command completes like that other command" kinds of relationships.
-    See below for details.
+    Causes the specified command to inherit completions from *WRAPPED_COMMAND* (see below for details).
 
 **-n** or **--condition** *CONDITION*
     This completion should only be used if the *CONDITION* (a shell command) returns 0. This makes it possible to specify completions that should only be used in some cases. If multiple conditions are specified, fish will try them in the order they are specified until one fails or all succeeded.

doc_src/cmds/continue.rst

@@ -15,8 +15,6 @@ Description
 
 ``continue`` skips the remainder of the current iteration of the current inner loop, such as a :doc:`for <for>` loop or a :doc:`while <while>` loop. It is usually added inside of a conditional block such as an :doc:`if <if>` statement or a :doc:`switch <switch>` statement.
 
-The **-h** or **--help** option displays help about using this command.
-
 Example
 -------
 

doc_src/cmds/fish.rst

@@ -24,8 +24,7 @@ The :ref:`tutorial <tutorial>` is available as HTML via ``help tutorial`` or in
 The following options are available:
 
 **-c** or **--command=COMMAND**
-    Evaluate the specified commands instead of reading from the commandline.
-    Any additional positional arguments are used as ``$argv``.
+    Evaluate the specified commands instead of reading from the commandline, passing additional positional arguments through ``$argv``.
 
 **-C** or **--init-command=COMMANDS**
     Evaluate specified commands after reading the configuration but before executing command specified by **-c** or reading interactive input.
@@ -41,6 +40,12 @@ The following options are available:
 **-i** or **--interactive**
     The shell is interactive.
 
+**--install[=PATH]**
+    When built as self-installable (via cargo), this will unpack fish's data files and place them in ``~/.local/share/fish/install/``.
+    fish will also ask to do this automatically when run interactively.
+    If PATH is given, fish will install itself into a relocatable directory tree rooted at that path.
+    That means it will install the data files to PATH/share/fish and copy itself to PATH/bin/fish.
+
 **-l** or **--login**
     Act as if invoked as a login shell.
 
@@ -101,33 +106,3 @@ These options can also be changed via the :envvar:`FISH_DEBUG` and :envvar:`FISH
 The categories enabled via **--debug** are *added* to the ones enabled by $FISH_DEBUG, so they can be disabled by prefixing them with **-** (**reader-*,-ast*** enables reader debugging and disables ast debugging).
 
 The file given in **--debug-output** takes precedence over the file in :envvar:`FISH_DEBUG_OUTPUT`.
-
-Examples
---------
-
-To just start fish::
-
-  fish
-
-To run a file with fish::
-
-  fish /path/to/script.fish
-
-To run some commands with fish::
-
-  fish -c 'echo Hi there!'
-
-You can also pass arguments to those commands::
-
-  > fish -c 'printf %s\n $argv' "first line" "second line"
-  first line
-  second line
-
-To run a script, except read this other file first::
-
-  fish --init-cmd "source otherfile" script.fish
-
-To :ref:`profile <profiling>` fish's startup and find what takes the most time in your configuration::
-
-  fish --profile-startup /tmp/start.prof -ic exit
-  sort -nk2 /tmp/start.prof

doc_src/cmds/fish_clipboard_copy.rst

@@ -29,7 +29,6 @@ Currently supported are:
 - ``wl-copy`` using wayland
 - ``xsel`` and ``xclip`` for X11
 - ``clip.exe`` on Windows.
-- The :ref:`OSC 52 clipboard sequence <term-compat-osc-52>`, which your terminal might support
 
 See also
 --------

doc_src/cmds/fish_git_prompt.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. synopsis::
 
-    fish_git_prompt [FORMAT]
+    fish_git_prompt
 
 ::
 
@@ -24,8 +24,6 @@ The ``fish_git_prompt`` function displays information about the current git repo
 
 `Git <https://git-scm.com>`_ must be installed.
 
-It is possible to modify the output format by passing an argument. The default value is ``" (%s)"``.
-
 There are numerous customization options, which can be controlled with git options or fish variables. git options, where available, take precedence over the fish variable with the same function. git options can be set on a per-repository or global basis. git options can be set with the ``git config`` command, while fish variables can be set as usual with the :doc:`set <set>` command.
 
 Boolean options (those which enable or disable something) understand "1", "yes" or "true" to mean true and every other value to mean false.
@@ -110,7 +108,7 @@ Variables used with ``showupstream`` (also implied by informative status):
 
 - ``$__fish_git_prompt_char_upstream_ahead`` (>, ↑) - the character for the commits this repository is ahead of upstream
 - ``$__fish_git_prompt_char_upstream_behind`` (<, ↓) - the character for the commits this repository is behind upstream
-- ``$__fish_git_prompt_char_upstream_diverged`` (<>, ↓↑) - the symbol if this repository is both ahead and behind upstream
+- ``$__fish_git_prompt_char_upstream_diverged`` (<>) - the symbol if this repository is both ahead and behind upstream
 - ``$__fish_git_prompt_char_upstream_equal`` (=) - the symbol if this repo is equal to upstream
 - ``$__fish_git_prompt_char_upstream_prefix`` ('')
 - ``$__fish_git_prompt_color_upstream``

doc_src/cmds/fish_indent.rst

@@ -38,11 +38,17 @@ The following options are available:
     Displays the current :program:`fish` version and then exits.
 
 **--ansi**
-    Colorizes the output using ANSI escape sequences using the colors defined in the environment (such as :envvar:`fish_color_command`).
+    Colorizes the output using ANSI escape sequences, appropriate for the current :envvar:`TERM`, using the colors defined in the environment (such as :envvar:`fish_color_command`).
 
 **--html**
     Outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as ``fish_color_command``.
 
+**-d** or **--debug=DEBUG_CATEGORIES**
+    Enable debug output and specify a pattern for matching debug categories. See :ref:`Debugging <debugging-fish>` in :doc:`fish <fish>` (1) for details.
+
+**-o** or **--debug-output=DEBUG_FILE**
+    Specify a file path to receive the debug output, including categories and ``fish_trace``. The default is standard error.
+
 **--dump-parse-tree**
     Dumps information about the parsed statements to standard error. This is likely to be of interest only to people working on the fish source code.
 

doc_src/cmds/fish_mode_prompt.rst

@@ -22,7 +22,7 @@ Description
 
 The ``fish_mode_prompt`` function outputs the mode indicator for use in vi mode.
 
-The default ``fish_mode_prompt`` function will output indicators about the current vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. The ``$fish_bind_mode variable`` can be used to determine the current mode. It will be one of ``default``, ``insert``, ``replace_one``, ``replace``, or ``visual``.
+The default ``fish_mode_prompt`` function will output indicators about the current vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. The ``$fish_bind_mode variable`` can be used to determine the current mode. It will be one of ``default``, ``insert``, ``replace_one``, or ``visual``.
 
 You can also define an empty ``fish_mode_prompt`` function to remove the vi mode indicators::
 
@@ -31,8 +31,6 @@ You can also define an empty ``fish_mode_prompt`` function to remove the vi mode
 
 ``fish_mode_prompt`` will be executed when the vi mode changes. If it produces any output, it is displayed and used. If it does not, the other prompt functions (:doc:`fish_prompt <fish_prompt>` and :doc:`fish_right_prompt <fish_right_prompt>`) will be executed as well in case they contain a mode display.
 
-If :envvar:`fish_transient_prompt` is set to 1, ``fish_mode_prompt --final-rendering`` is run before executing the commandline.
-
 Example
 -------
 
@@ -51,9 +49,6 @@ Example
         case replace_one
           set_color --bold green
           echo 'R'
-        case replace
-          set_color --bold bryellow
-          echo 'R'
         case visual
           set_color --bold brmagenta
           echo 'V'

doc_src/cmds/fish_opt.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. synopsis::
 
-    fish_opt [-s ALPHANUM] [-l LONG-NAME] [-ormd] [--long-only] [-v COMMAND OPTIONS ... ]
+    fish_opt [(-slor | --multiple-vals=) OPTNAME]
     fish_opt --help
 
 Description
@@ -18,14 +18,14 @@ This command provides a way to produce option specifications suitable for use wi
 
 The following ``argparse`` options are available:
 
-**-s** or **--short** *ALPHANUM*
-    Takes a single letter or number that is used as the short flag in the option being defined. Either this option or the **--long** option must be provided.
+**-s** or **--short**
+    Takes a single letter that is used as the short flag in the option being defined. This option is mandatory.
 
-**-l** or **--long** *LONG-NAME*
+**-l** or **--long**
     Takes a string that is used as the long flag in the option being defined. This option is optional and has no default. If no long flag is defined then only the short flag will be allowed when parsing arguments using the option specification.
 
 **--long-only**
-    Deprecated. The option being defined will only allow the long flag name to be used, even if the short flag is defined (i.e., **--short** is specified).
+    The option being defined will only allow the long flag name to be used. The short flag name must still be defined (i.e., **--short** must be specified) but it cannot be used when parsing arguments using this option specification.
 
 **-o** or **--optional-val**
     The option being defined can take a value, but it is optional rather than required. If the option is seen more than once when parsing arguments, only the last value seen is saved. This means the resulting flag variable created by ``argparse`` will zero elements if no value was given with the option else it will have exactly one element.
@@ -33,15 +33,8 @@ The following ``argparse`` options are available:
 **-r** or **--required-val**
     The option being defined requires a value. If the option is seen more than once when parsing arguments, only the last value seen is saved. This means the resulting flag variable created by ``argparse`` will have exactly one element.
 
-**-m** or **--multiple-vals**
-    The value of each instance of the option is accumulated. If **--optional-val** is provided, the value is optional, and an empty string is stored if no value is provided. Otherwise, the **--requiured-val** option is implied and each instance of the option requires a value. This means the resulting flag variable created by ``argparse`` will have one element for each instance of this option in the arguments, even for instances that did not provide a value.
-
-**-d** or **--delete**
-    The option and any values will be deleted from the ``$argv_opts`` variables set by ``argparse``
-    (as with other options, it will also be deleted from ``$argv``).
-
-**-v** or **--validate** *COMMAND* *OPTION...*
-    This option must be the last one, and requires one of ``-o``, ``-r``, or ``-m``. All the remaining arguments are interpreted a fish script to run to validate the value of the argument, see ``argparse`` documentation for more details. Note that the interpretation of *COMMAND* *OPTION...* is similar to ``eval``, so you may need to quote or escape special characters *twice* if you want them to be interpreted literally when the validate script is run.
+**--multiple-vals**
+    The option being defined requires a value each time it is seen. Each instance is stored. This means the resulting flag variable created by ``argparse`` will have one element for each instance of this option in the arguments.
 
 **-h** or **--help**
     Displays help about using this command.
@@ -66,25 +59,18 @@ Same as above but with a second flag that requires a value:
 ::
 
     set -l options (fish_opt -s h -l help)
-    set options $options (fish_opt -s m -l max -r)
+    set options $options (fish_opt -s m -l max --required-val)
     argparse $options -- $argv
 
-Same as above but the value of the second flag cannot be the empty string:
 
-::
-
-    set -l options (fish_opt -s h -l help)
-    set options $options (fish_opt -s m -l max -rv test \$_flag_valu != "''")
-    argparse $options -- $argv
-
-Same as above but with a third flag that can be given multiple times saving the value of each instance seen and only a long flag name (``--token``) is defined:
+Same as above but with a third flag that can be given multiple times saving the value of each instance seen and only the long flag name (``--token``) can be used:
 
 
 
 ::
 
     set -l options (fish_opt --short=h --long=help)
-    set options $options (fish_opt --short=m --long=max --required-val --validate test \$_flag_valu != "''")
-    set options $options (fish_opt --long=token --multiple-vals)
+    set options $options (fish_opt --short=m --long=max --required-val)
+    set options $options (fish_opt --short=t --long=token --multiple-vals --long-only)
     argparse $options -- $argv
 

doc_src/cmds/fish_prompt.rst

@@ -24,8 +24,6 @@ The ``fish_prompt`` function is executed when the prompt is to be shown, and the
 
 The exit status of commands within ``fish_prompt`` will not modify the value of :ref:`$status <variables-status>` outside of the ``fish_prompt`` function.
 
-If :envvar:`fish_transient_prompt` is set to 1, ``fish_prompt --final-rendering`` is run before executing the commandline.
-
 ``fish`` ships with a number of example prompts that can be chosen with the ``fish_config`` command.
 
 

doc_src/cmds/fish_right_prompt.rst

@@ -20,8 +20,6 @@ Description
 
 Multiple lines are not supported in ``fish_right_prompt``.
 
-If :envvar:`fish_transient_prompt` is set to 1, ``fish_right_prompt --final-rendering`` is run before executing the commandline.
-
 
 Example
 -------

doc_src/cmds/function.rst

@@ -27,11 +27,7 @@ The following options are available:
     A description of what the function does, suitable as a completion description.
 
 **-w** *WRAPPED_COMMAND* or **--wraps** *WRAPPED_COMMAND*
-    Inherit completions from the given *WRAPPED_COMMAND*.
-    This is used to say that this function completes like that command,
-    for example if you're creating an alias.
-    See the documentation for :doc:`complete <complete>` for more information.
-    If the wrapped command is the same as the function name, this will be ignored.
+    Inherit completions from the given *WRAPPED_COMMAND*. See the documentation for :doc:`complete <complete>` for more information.
 
 **-e** *EVENT_NAME* or **--on-event** *EVENT_NAME*
     Run this function when the specified named event is emitted. Fish internally generates named events, for example, when showing the prompt. Custom events can be emitted using the :doc:`emit <emit>` command.

doc_src/cmds/history.rst

@@ -27,10 +27,10 @@ Description
 The following operations (sub-commands) are available:
 
 **search**
-    Returns history items matching the search string. If no search string is provided it returns all history items. This is the default operation if no other operation is specified. You only have to explicitly say ``history search`` if you wish to search for one of the subcommands. The ``--contains`` search option will be used if you don't specify a different search option. Entries are ordered newest to oldest unless you use the ``--reverse`` flag. If stdout is attached to a tty the output will be piped through your pager by the history function. The history builtin writes the results to stdout.
+    Returns history items matching the search string. If no search string is provided it returns all history items. This is the default operation if no other operation is specified. You only have to explicitly say ``history search`` if you wish to search for one of the subcommands. The ``--contains`` search option will be used if you don't specify a different search option. Entries are ordered newest to oldest unless you use the ``--reverse`` flag. If stdout is attached to a tty the output will be piped through your pager by the history function. The history builtin simply writes the results to stdout.
 
 **delete**
-    Deletes history items. The ``--contains`` search option will be used if you don't specify a different search option. If you don't specify ``--exact`` a prompt will be displayed before any items are deleted asking you which entries are to be deleted. You can enter the word "all" to delete all matching entries. You can enter a single ID (the number in square brackets) to delete just that single entry. You can enter more than one ID, or an ID range separated by a space to delete multiple entries. Press [enter] to not delete anything. Note that the interactive delete behavior is a feature of the history function. The history builtin only supports ``--exact --case-sensitive`` deletion.
+    Deletes history items. The ``--contains`` search option will be used if you don't specify a different search option. If you don't specify ``--exact`` a prompt will be displayed before any items are deleted asking you which entries are to be deleted. You can enter the word "all" to delete all matching entries. You can enter a single ID (the number in square brackets) to delete just that single entry. You can enter more than one ID, or an ID range separated by a space to delete multiple entries. Just press [enter] to not delete anything. Note that the interactive delete behavior is a feature of the history function. The history builtin only supports ``--exact --case-sensitive`` deletion.
 
 **merge**
     Immediately incorporates history changes from other sessions. Ordinarily ``fish`` ignores history changes from sessions started after the current one. This command applies those changes immediately.
@@ -52,7 +52,7 @@ The following options are available:
 These flags can appear before or immediately after one of the sub-commands listed above.
 
 **-C** or **--case-sensitive**
-    Does a case-sensitive search. The default is case-insensitive.
+    Does a case-sensitive search. The default is case-insensitive. Note that prior to fish 2.4.0 the default was case-sensitive.
 
 **-c** or **--contains**
     Searches items in the history that contain the specified text string. This is the default for the **--search** flag. This is not currently supported by the **delete** subcommand.

doc_src/cmds/path.rst

@@ -13,7 +13,7 @@ Synopsis
     path extension GENERAL_OPTIONS [PATH ...]
     path filter GENERAL_OPTIONS [-v | --invert]
         [-d] [-f] [-l] [-r] [-w] [-x]
-        [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [--all] [PATH ...]
+        [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH ...]
     path is GENERAL_OPTIONS [(-v | --invert)] [(-t | --type) TYPE]
         [-d] [-f] [-l] [-r] [-w] [-x]
         [(-p | --perm) PERMISSION] [PATH ...]
@@ -22,7 +22,7 @@ Synopsis
     path resolve GENERAL_OPTIONS [PATH ...]
     path change-extension GENERAL_OPTIONS EXTENSION [PATH ...]
     path sort GENERAL_OPTIONS [-r | --reverse]
-        [-u | --unique] [--key=(basename | dirname | path)] [PATH ...]
+        [-u | --unique] [--key=basename|dirname|path] [PATH ...]
 
     GENERAL_OPTIONS
         [-z | --null-in] [-Z | --null-out] [-q | --quiet]
@@ -148,7 +148,7 @@ Examples
    > echo $path$extension
    # reconstructs the original path again.
    ./foo.mp4
-
+   
 .. _cmd-path-filter:
 
 "filter" subcommand
@@ -158,7 +158,7 @@ Examples
 
     path filter [-z | --null-in] [-Z | --null-out] [-q | --quiet] \
         [-d] [-f] [-l] [-r] [-w] [-x] \
-        [-v | --invert] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [--all] [PATH ...]
+        [-v | --invert] [(-t | --type) TYPE] [(-p | --perm) PERMISSION] [PATH ...]
 
 ``path filter`` returns all of the given paths that match the given checks. In all cases, the paths need to exist, nonexistent paths are always filtered.
 
@@ -180,10 +180,6 @@ When a path starts with ``-``, ``path filter`` will prepend ``./`` to avoid it b
 
 It returns 0 if at least one path passed the filter.
 
-With ``--all``, return status 0 (true) if all paths pass the filter, and status 1 (false) if any path fails. This is equivalent to ``not path filter -v``. It produces no output, only a status.
-
-When ``--all`` combined with ``--invert``, it returns status 0 (true) if all paths fail the filter and status 1 (false) if any path passes.
-
 ``path is`` is shorthand for ``path filter -q``, i.e. just checking without producing output, see :ref:`The is subcommand <cmd-path-is>`.
 
 Examples
@@ -215,9 +211,6 @@ Examples
    >_ path filter -fx $PATH/*
    # Prints all possible commands - the first entry of each name is what fish would execute!
 
-   >_ path filter --all /usr/bin /usr/argagagji
-   # This returns 1 (false) because not all paths pass the filter.
-
 .. _cmd-path-is:
 
 "is" subcommand
@@ -353,7 +346,7 @@ Examples
     path change-extension [-z | --null-in] [-Z | --null-out] \
         [-q | --quiet] EXTENSION [PATH ...]
 
-``path change-extension`` returns the given paths, with their extension changed to the given new extension. The extension is the part after (and including) the last ".", unless that "." followed a "/" or the basename is "." or "..", in which case there is no previous extension and the new one is added.
+``path change-extension`` returns the given paths, with their extension changed to the given new extension. The extension is the part after (and including) the last ".", unless that "." followed a "/" or the basename is "." or "..", in which case there is no previous extension and the new one is simply added.
 
 If the extension is empty, any previous extension is stripped, along with the ".". This is, of course, the inverse of ``path extension``.
 

doc_src/cmds/prompt_pwd.rst

@@ -55,9 +55,3 @@ Examples
 
     >_ prompt_pwd --full-length-dirs=2 --dir-length=1
     /t/b/s/with/mustard
-
-    >_ echo (prompt_pwd | string split /)[-1]
-    mustard
-
-    >_ echo (string join / (prompt_pwd | string split /)[-3..-1])
-    s/with/mustard

doc_src/cmds/read.rst

@@ -83,12 +83,8 @@ The following options control how much is read and how it is stored:
 **-n** or **--nchars** *NCHARS*
     Makes ``read`` return after reading *NCHARS* characters or the end of the line, whichever comes first.
 
-**-t**, **--tokenize** or **--tokenize-raw**
-    Causes read to split the input into variables by the shell's tokenization rules.
-    This means it will honor quotes and escaping.
-    This option is of course incompatible with other options to control splitting like **--delimiter** and does not honor :envvar:`IFS` (like fish's tokenizer).
-    The **-t** -or **--tokenize** variants perform quote removal, so e.g. ``a\ b`` is stored as ``a b``.
-    However variables and command substitutions are not expanded.
+**-t** -or **--tokenize**
+    Causes read to split the input into variables by the shell's tokenization rules. This means it will honor quotes and escaping. This option is of course incompatible with other options to control splitting like **--delimiter** and does not honor :envvar:`IFS` (like fish's tokenizer). It saves the tokens in the manner they'd be passed to commands on the commandline, so e.g. ``a\ b`` is stored as ``a b``. Note that currently it leaves command substitutions intact along with the parentheses.
 
 **-a** or **--list**
     Stores the result as a list in a single variable. This option is also available as **--array** for backwards compatibility.
@@ -105,7 +101,7 @@ If no option to determine how to split like ``--delimiter``, ``--line`` or ``--t
 
 With the ``--line`` option, ``read`` reads a line of input from standard input into each provided variable, stopping when each variable has been filled. The line is not tokenized.
 
-If no variable names are provided, ``read`` enters a special case that provides redirection from standard input to standard output, useful for command substitution. For instance, the fish shell command below can be used to read a password from the console instead of hardcoding it in the command itself, which prevents it from showing up in fish's history::
+If no variable names are provided, ``read`` enters a special case that simply provides redirection from standard input to standard output, useful for command substitution. For instance, the fish shell command below can be used to read a password from the console instead of hardcoding it in the command itself, which prevents it from showing up in fish's history::
 
     mysql -uuser -p(read)
 

doc_src/cmds/set_color.rst

@@ -22,25 +22,15 @@ Valid colors include:
 
 The *br*- (as in 'bright') forms are full-brightness variants of the 8 standard-brightness colors on many terminals. **brblack** has higher brightness than **black** - towards gray.
 
-An RGB value with three or six hex digits, such as A0FF33 or f2f can be used.
-A three digit value is equivalent to specifying each digit twice; e.g., ``set_color 2BC`` is the same as ``set_color 22BBCC``.
-Hexadecimal RGB values can be in lower or uppercase.
+An RGB value with three or six hex digits, such as A0FF33 or f2f can be used. Fish will choose the closest supported color. A three digit value is equivalent to specifying each digit twice; e.g., ``set_color 2BC`` is the same as ``set_color 22BBCC``. Hexadecimal RGB values can be in lower or uppercase. Depending on the capabilities of your terminal (and the level of support ``set_color`` has for it) the actual color may be approximated by a nearby matching reserved color name or ``set_color`` may not have an effect on color.
 
-If :envvar:`fish_term24bit` is set to 0, fish will translate RGB values to the nearest color on the 256-color palette.
-If :envvar:`fish_term256` is also set to 0, fish will translate them to the 16-color palette instead.
-Fish launched as ``fish -d term_support`` will include diagnostic messages that indicate the color support mode in use.
-
-If multiple colors are specified, fish prefers the first RGB one.
-However if :envvar:`fish_term256` is set to 0, fish prefers the first named color specified.
+A second color may be given as a desired fallback color. e.g. ``set_color 124212 brblue`` will instruct set_color to use *brblue* if a terminal is not capable of the exact shade of grey desired. This is very useful when an 8 or 16 color terminal might otherwise not use a color.
 
 The following options are available:
 
 **-b** or **--background** *COLOR*
     Sets the background color.
 
-**--underline-color** *COLOR*
-    Set the underline color.
-
 **-c** or **--print-colors**
     Prints the given colors or a colored list of the 16 named colors.
 
@@ -56,16 +46,18 @@ The following options are available:
 **-r** or **--reverse**
     Sets reverse mode.
 
-**-u** or **--underline**, or **-uSTYLE** or **--underline=STYLE**
-    Set the underline mode; supported styles are **single** (default), **double**, **curly**, **dotted** and **dashed**.
+**-u** or **--underline**
+    Sets underlined mode.
 
 **-h** or **--help**
     Displays help about using this command.
 
+Using the **normal** keyword will reset foreground, background, and all formatting back to default.
+
 Notes
 -----
 
-1. Using **set_color normal** will reset all colors and modes to the terminal's default.
+1. Using the **normal** keyword will reset both background and foreground colors to whatever is the default for the terminal.
 2. Setting the background color only affects subsequently written characters. Fish provides no way to set the background color for the entire terminal window. Configuring the window background color (and other attributes such as its opacity) has to be done using whatever mechanisms the terminal provides. Look for a config option.
 3. Some terminals use the ``--bold`` escape sequence to switch to a brighter color set rather than increasing the weight of text.
 4. ``set_color`` works by printing sequences of characters to standard output. If used in command substitution or a pipe, these characters will also be captured. This may or may not be desirable. Checking the exit status of ``isatty stdout`` before using ``set_color`` can be useful to decide not to colorize output in a script.
@@ -80,3 +72,24 @@ Examples
     set_color blue; echo "Violets are blue"
     set_color 62A; echo "Eggplants are dark purple"
     set_color normal; echo "Normal is nice" # Resets the background too
+
+
+Terminal Capability Detection
+-----------------------------
+
+Fish uses some heuristics to determine what colors a terminal supports to avoid sending sequences that it won't understand.
+
+In particular it will:
+
+- Enable 256 colors if :envvar:`TERM` contains "xterm", except for known exceptions (like MacOS 10.6 Terminal.app)
+- Enable 24-bit ("true-color") even if the $TERM entry only reports 256 colors. This includes modern xterm, VTE-based terminals like Gnome Terminal, Konsole and iTerm2.
+- Detect support for italics, dim, reverse and other modes.
+
+If terminfo reports 256 color support for a terminal, 256 color support will always be enabled.
+
+To force true-color support on or off, set :envvar:`fish_term24bit` to "1" for on and 0 for off - ``set -g fish_term24bit 1``.
+
+To debug color palette problems, ``tput colors`` may be useful to see the number of colors in terminfo for a terminal. Fish launched as ``fish -d term_support`` will include diagnostic messages that indicate the color support mode in use.
+
+The ``set_color`` command uses the terminfo database to look up how to change terminal colors on whatever terminal is in use. Some systems have old and incomplete terminfo databases, and lack color information for terminals that support it. Fish assumes that all terminals can use the `ANSI X3.64 <https://en.wikipedia.org/wiki/ANSI_escape_code>`_ escape sequences if the terminfo definition indicates a color below 16 is not supported.
+

doc_src/cmds/source.rst

@@ -41,3 +41,8 @@ Example
     source ~/.config/fish/config.fish
     # Causes fish to re-read its initialization file.
 
+
+Caveats
+-------
+
+In fish versions prior to 2.3.0, the :envvar:`argv` variable would have a single element (the name of the sourced file) if no arguments are present. Otherwise, it would contain arguments without the name of the sourced file. That behavior was very confusing and unlike other shells such as bash and zsh.

doc_src/cmds/status.rst

@@ -30,11 +30,7 @@ Synopsis
     status job-control CONTROL_TYPE
     status features
     status test-feature FEATURE
-    status build-info
-    status get-file FILE
-    status list-files [PATH]
-    status terminal
-    status test-terminal-feature FEATURE
+    status buildinfo
 
 Description
 -----------
@@ -101,49 +97,18 @@ The following operations (subcommands) are available:
     Sets the job control type to *CONTROL_TYPE*, which can be **none**, **full**, or **interactive**.
 
 **features**
-    Lists all available :ref:`feature flags <featureflags>`.
+    Lists all available feature flags.
 
 **test-feature** *FEATURE*
     Returns 0 when FEATURE is enabled, 1 if it is disabled, and 2 if it is not recognized.
 
-**build-info**
+**buildinfo**
     This prints information on how fish was build - which architecture, which build system or profile was used, etc.
     This is mainly useful for debugging.
 
-.. _status-get-file:
-
-**get-file** *FILE*
-    NOTE: this subcommand is mainly intended for fish's internal use; let us know if you want to use it elsewhere.
-
-    This prints a file embedded in the fish binary at compile time. This includes the default set of functions and completions,
-    as well as the man pages and themes. Which files are included depends on build settings.
-    Returns 0 if the file was included, 1 otherwise.
-
-**list-files** *FILE*
-    NOTE: this subcommand is mainly intended for fish's internal use; let us know if you want to use it elsewhere.
-
-    This lists the files embedded in the fish binary at compile time. Only files where the path starts with the optional *FILE* argument are shown.
-    Returns 0 if something was printed, 1 otherwise.
-
-.. _status-terminal:
-
-**terminal**
-    Prints the name and version of the terminal fish is running inside (for example as reported via :ref:`XTVERSION <term-compat-xtversion>`).
-    This is not available during early startup but only starting from when the first interactive prompt is shown, possibly via builtin :doc:`read <read>`,
-    so before the first ``fish_prompt`` or ``fish_read`` :ref:`event <event>`.
-
-.. _status-test-terminal-features:
-
-**test-terminal-feature** *FEATURE*
-    Returns 0 when the terminal was :ref:`detected <term-compat-xtgettcap>` to support the given feature.
-    Like :ref:`status terminal <status-terminal>`, this only works once the first interactive prompt is shown.
-
-    Currently the only available *FEATURE* is :ref:`scroll-content-up <term-compat-indn>`.
-    An error will be printed when passed an unrecognized feature.
-
 Notes
 -----
 
-For backwards compatibility most subcommands can also be specified as a long or short option. For example, rather than ``status is-login`` you can type ``status --is-login``. The flag forms are deprecated and may be removed in a future release.
+For backwards compatibility most subcommands can also be specified as a long or short option. For example, rather than ``status is-login`` you can type ``status --is-login``. The flag forms are deprecated and may be removed in a future release (but not before fish 4.0).
 
 You can only specify one subcommand per invocation even if you use the flag form of the subcommand.

doc_src/cmds/string-join.rst

@@ -8,8 +8,8 @@ Synopsis
 
 .. synopsis::
 
-    string join [-q | --quiet] [-n | --no-empty] [--] SEP [STRING ...]
-    string join0 [-q | --quiet] [-n | --no-empty] [--] [STRING ...]
+    string join [-q | --quiet] SEP [STRING ...]
+    string join0 [-q | --quiet] [STRING ...]
 
 .. END SYNOPSIS
 
@@ -18,28 +18,11 @@ Description
 
 .. BEGIN DESCRIPTION
 
-Joins its *STRING* arguments into a single string separated by *SEP* (for ``string join``) or by the
-zero byte (NUL) (for ``string join0``).
-Exit status: 0 if at least one join was performed, or 1 otherwise.
+``string join`` joins its *STRING* arguments into a single string separated by *SEP*, which can be an empty string. Exit status: 0 if at least one join was performed, or 1 otherwise. If ``-n`` or ``--no-empty`` is specified, empty strings are excluded from consideration (e.g. ``string join -n + a b "" c`` would expand to ``a+b+c`` not ``a+b++c``).
 
-**-n**, **--no-empty**
-    Exclude empty strings from consideration (e.g. ``string join -n + a b "" c`` would expand to ``a+b+c`` not ``a+b++c``).
+``string join0`` joins its *STRING* arguments into a single string separated by the zero byte (NUL), and adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``. Exit status: 0 if at least one join was performed, or 1 otherwise.
 
-**-q**, **--quiet**
-    Do not print the strings, only set the exit status as described above.
-
-**WARNING**:
-Insert a  ``--`` before positional arguments to prevent them from being interpreted as flags.
-Otherwise, any strings starting with ``-`` will be treated as flag arguments, meaning they will most likely result in the command failing.
-This is also true if you specify a variable which expands to such a string instead of a literal string.
-If you don't need to append flag arguments at the end of the command,
-just always use ``--`` to avoid unwelcome surprises.
-
-``string join0`` adds a trailing NUL. This is most useful in conjunction with tools that accept NUL-delimited input, such as ``sort -z``.
-
-Because Unix uses NUL as the string terminator, passing the output of ``string join0`` as an *argument* to a command (via a :ref:`command substitution <expand-command-substitution>`) won't actually work.
-Fish will pass the correct bytes along, but the command won't be able to tell where the argument ends.
-This is a limitation of Unix' argument passing.
+Because Unix uses NUL as the string terminator, passing the output of ``string join0`` as an *argument* to a command (via a :ref:`command substitution <expand-command-substitution>`) won't actually work. Fish will pass the correct bytes along, but the command won't be able to tell where the argument ends. This is a limitation of Unix' argument passing.
 
 .. END DESCRIPTION
 
@@ -60,14 +43,4 @@ Examples
     >_ string join '' a b c
     abc
 
-    >_ set -l markdown_list '- first' '- second' '- third'
-    # Strings with leading hyphens (also in variable expansions) are interpreted as flag arguments by default.
-    >_ string join \n $markdown_list
-    string join: - first: unknown option
-    # Use '--' to prevent this.
-    >_ string join -- \n $markdown_list
-    - first
-    - second
-    - third
-
 .. END EXAMPLES

doc_src/cmds/string-match.rst

@@ -22,11 +22,11 @@ Description
 
 ``string match`` tests each *STRING* against *PATTERN* and prints matching substrings. Only the first match for each *STRING* is reported unless **-a** or **--all** is given, in which case all matches are reported.
 
-If you specify the **-e** or **--entire** then each matching string is printed including any prefix or suffix not matched by the pattern (equivalent to ``grep`` without the **-o** flag). You can, obviously, achieve the same result by prepending and appending **\*** or **.*** depending on whether or not you have specified the **--regex** flag. The **--entire** flag is a way to avoid having to complicate the pattern in that fashion and make the intent of the ``string match`` clearer. Without **--entire** and **--regex**, a *PATTERN* will need to match the entire *STRING* before it will be reported.
+If you specify the **-e** or **--entire** then each matching string is printed including any prefix or suffix not matched by the pattern (equivalent to ``grep`` without the **-o** flag). You can, obviously, achieve the same result by prepending and appending **\*** or **.*** depending on whether or not you have specified the **--regex** flag. The **--entire** flag is simply a way to avoid having to complicate the pattern in that fashion and make the intent of the ``string match`` clearer. Without **--entire** and **--regex**, a *PATTERN* will need to match the entire *STRING* before it will be reported.
 
 Matching can be made case-insensitive with **--ignore-case** or **-i**.
 
-If **--groups-only** or **-g** is given, only the capturing groups will be reported - meaning the full match will be skipped. This is incompatible with **--entire** and **--invert**, and requires **--regex**. It is useful as a simple cutting tool instead of ``string replace``, so you can choose "this part" of a string.
+If **--groups-only** or **-g** is given, only the capturing groups will be reported - meaning the full match will be skipped. This is incompatible with **--entire** and **--invert**, and requires **--regex**. It is useful as a simple cutting tool instead of ``string replace``, so you can simply choose "this part" of a string.
 
 If **--index** or **-n** is given, each match is reported as a 1-based start position and a length. By default, PATTERN is interpreted as a glob pattern matched against each entire *STRING* argument. A glob pattern is only considered a valid match if it matches the entire *STRING*.
 

doc_src/cmds/string-pad.rst

@@ -8,7 +8,7 @@ Synopsis
 
 .. synopsis::
 
-    string pad [-r | --right] [-C | --center] [(-c | --char) CHAR] [(-w | --width) INTEGER]
+    string pad [-r | --right] [(-c | --char) CHAR] [(-w | --width) INTEGER]
                [STRING ...]
 
 .. END SYNOPSIS
@@ -22,8 +22,6 @@ Description
 
 The escape sequences reflect what fish knows about, and how it computes its output. Your terminal might support more escapes, or not support escape sequences that fish knows about.
 
-If **-C** or **--center** is given, add the padding to before and after the string. If it is impossible to perfectly center the result (because the required amount of padding is an odd number), extra padding will be added to the left, unless **--right** is also given.
-
 If **-r** or **--right** is given, add the padding after a string.
 
 If **-c** or **--char** is given, pad with *CHAR* instead of whitespace.

doc_src/cmds/string-split.rst

@@ -8,9 +8,9 @@ Synopsis
 
 .. synopsis::
 
-    string split [(-f | --fields) FIELDS [-a | --allow-empty]] [(-m | --max) MAX] [-n | --no-empty]
+    string split [(-f | --fields) FIELDS] [(-m | --max) MAX] [-n | --no-empty] 
                  [-q | --quiet] [-r | --right] SEP [STRING ...]
-    string split0 [(-f | --fields) FIELDS [-a | --allow-empty]] [(-m | --max) MAX] [-n | --no-empty]
+    string split0 [(-f | --fields) FIELDS] [(-m | --max) MAX] [-n | --no-empty]
                   [-q | --quiet] [-r | --right] [STRING ...]
 
 .. END SYNOPSIS
@@ -20,7 +20,7 @@ Description
 
 .. BEGIN DESCRIPTION
 
-``string split`` splits each *STRING* on the separator *SEP*, which can be an empty string. If **-m** or **--max** is specified, at most MAX splits are done on each *STRING*. If **-r** or **--right** is given, splitting is performed right-to-left. This is only useful in combination with **-m** or **--max**. With **-n** or **--no-empty**, empty results are excluded from consideration (e.g. ``hello\n\nworld`` would expand to two strings and not three). Exit status: 0 if at least one split was performed, or 1 otherwise.
+``string split`` splits each *STRING* on the separator *SEP*, which can be an empty string. If **-m** or **--max** is specified, at most MAX splits are done on each *STRING*. If **-r** or **--right** is given, splitting is performed right-to-left. This is useful in combination with **-m** or **--max**. With **-n** or **--no-empty**, empty results are excluded from consideration (e.g. ``hello\n\nworld`` would expand to two strings and not three). Exit status: 0 if at least one split was performed, or 1 otherwise.
 
 Use **-f** or **--fields** to print out specific fields. FIELDS is a comma-separated string of field numbers and/or spans. Each field is one-indexed, and will be printed on separate lines. If a given field does not exist, then the command exits with status 1 and does not print anything, unless **--allow-empty** is used.
 
@@ -30,7 +30,6 @@ See also the **--delimiter** option of the :doc:`read <read>` command.
 
 ``split0`` has the important property that its output is not further split when used in a command substitution, allowing for the command substitution to produce elements containing newlines. This is most useful when used with Unix tools that produce zero bytes, such as ``find -print0`` or ``sort -z``. See split0 examples below.
 
-Be aware that commandline arguments cannot include NULs, so you likely want to pass to ``string split0`` via a pipe, not a command substitution.
 
 .. END DESCRIPTION
 
@@ -66,7 +65,6 @@ NUL Delimited Examples
 ::
 
     >_ # Count files in a directory, without being confused by newlines.
-    >_ # Note: Don't use `string split0 (find . -print0)`, because arguments cannot include NUL.
     >_ count (find . -print0 | string split0)
     42