Mention that shell completion support is dependant on the shell version

dalibo · Nov 16, 2023 · ffc330f · ffc330f
1 parent 8d6b850
commit ffc330f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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"