bat/doc
Martin Nordholts 4e34b362f8 Require changes to `-h` and `--help` to be blessed
From now on, any changes to the help texts will be visible in PR diffs,
which will make it very easy to review, and very hard to accidentally
miss changes to help texts.

If a contributor makes a change to help texts, the `cargo test` failure
text they will see contains instructions on how to update the blessed
help texts:

    error: expect test failed
       --> ../doc/long-help.txt

    You can update all `expect!` tests by running:

        env UPDATE_EXPECT=1 cargo test

In short, to update blessed help texts, one simply does

    env UPDATE_EXPECT=1 cargo test

Do not run the tests if the `git` feature is missing, since then
`--diff` will be missing from `--help`. And do not run the tests on
Windows, because then the help text will contain the term `.exe`.

Move man page step to after cargo doc step so that the man page exists
when we look for it.
2022-12-30 09:59:52 +01:00
..
sponsors Add WorkOS sponsor to readme 2022-02-09 21:54:32 +01:00
README-ja.md ja: Update description about Debian/Ubuntu packages 2022-10-03 21:41:36 +02:00
README-ko.md Bump MSRV to 1.60 2022-09-04 06:04:35 +02:00
README-ru.md Bump MSRV to 1.60 2022-09-04 06:04:35 +02:00
README-zh.md Bump MSRV to 1.58 2022-08-14 16:21:45 +02:00
alternatives.md update alternatives.md 2022-09-04 14:28:06 +02:00
assets.md Merge branch 'master' into feat/env-extension 2022-10-30 20:45:39 +01:00
logo-header.svg Make logo compatible with light and dark themes 2020-10-14 08:15:08 +02:00
long-help.txt Require changes to `-h` and `--help` to be blessed 2022-12-30 09:59:52 +01:00
release-checklist.md Require changes to `-h` and `--help` to be blessed 2022-12-30 09:59:52 +01:00
short-help.txt Require changes to `-h` and `--help` to be blessed 2022-12-30 09:59:52 +01:00
sponsors.md Add additional note to sponsors.md 2022-02-09 21:57:52 +01:00