From ffc330f96ee682e8eff0dbb9a289e257033540a1 Mon Sep 17 00:00:00 2001 From: benoit Date: Thu, 16 Nov 2023 13:42:42 +0100 Subject: [PATCH] Mention that shell completion support is dependant on the shell version --- CHANGELOG.md | 1 + README.md | 5 ++++- docs/make_readme.sh | 5 ++++- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index def5df9..c6428e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ ### Added * Add the timeline in the `cluster_has_replica` perfstats. (#50) +* Add a mention about shell completion support and shell versions in the doc. (#53) ### Fixed diff --git a/README.md b/README.md index 5fab46e..20268e9 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,10 @@ a file spécific to your shell of choice. eval "$(_CHECK_PATRONI_COMPLETE=fish_source check_patroni)" ``` -[click]: https://click.palletsprojects.com/en/8.0.x/shell-completion/?highlight=completion +Please note that shell completion is not supported far all shell versions, for +example only Bash versions older than 4.4 are supported. + +[click]: https://click.palletsprojects.com/en/8.1.x/shell-completion/ ## Cluster services diff --git a/docs/make_readme.sh b/docs/make_readme.sh index 824ac4b..2c8f6d4 100755 --- a/docs/make_readme.sh +++ b/docs/make_readme.sh @@ -117,7 +117,10 @@ a file spécific to your shell of choice. eval "$(_CHECK_PATRONI_COMPLETE=fish_source check_patroni)" ``` -[click]: https://click.palletsprojects.com/en/8.0.x/shell-completion/?highlight=completion +Please note that shell completion is not supported far all shell versions, for +example only Bash versions older than 4.4 are supported. + +[click]: https://click.palletsprojects.com/en/8.1.x/shell-completion/ _EOF_ readme readme "## Cluster services"