From 6ed3aaf3b6530c26aa48ee621443f4991fa01cdb Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 25 May 2016 16:44:58 +0200 Subject: [PATCH] deprecate '-h' shorthand and remove '-help' This deprecates the shorthand '-h', because we don't mention it as an option, and it conflicts with the 'docker create -h/--hostname' option, so cannot be used for all commands consistently. This also removes the (single-dash) '-help' option. The single-dash variant was marked "deprecated" in version 1.5.0 (basically, since it was added in a2b529ead21e6ab9eafcb1b1d2437c725c43a06a), but still kept around to prevent '-help' being treated as '-h -e -l -p', causing confusing warnings. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 6add695084151a54a503c6e2597e05c17aa3d37f) --- docs/deprecated.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/deprecated.md b/docs/deprecated.md index 79e10c0bbc..6941408f58 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -21,6 +21,17 @@ The following list of features are deprecated in Engine. The `docker import` command format 'file|URL|- [REPOSITORY [TAG]]' is deprecated since November 2013. It's no more supported. +### `-h` shorthand for `--help` + +**Deprecated In Release: [v1.12.0](https://github.com/docker/docker/releases/tag/v1.12.0)** + +**Target For Removal In Release: [v1.14.0](https://github.com/docker/docker/releases/tag/v1.12.0)** + +The shorthand (`-h`) is less common than `--help` on Linux and cannot be used +on all subcommands (due to it conflicting with, e.g. `-h` / `--hostname` on +`docker create`). For this reason, the `-h` shorthand was not printed in the +"usage" output of subcommands, nor docummented, and is now marked "deprecated". + ### `-e` and `--email` flags on `docker login` **Deprecated In Release: [v1.11.0](https://github.com/docker/docker/releases/tag/v1.11.0)** @@ -149,6 +160,16 @@ The following double-dash options are deprecated and have no replacement: docker ps --before-id docker search --trusted +**Deprecated In Release: [v1.5.0](https://github.com/docker/docker/releases/tag/v1.5.0)** + +**Removed In Release: [v1.12.0](https://github.com/docker/docker/releases/tag/v1.12.0)** + +The single-dash (`-help`) was removed, in favor of the double-dash `--help` + + docker -help + docker [COMMAND] -help + + ### Interacting with V1 registries Version 1.9 adds a flag (`--disable-legacy-registry=false`) which prevents the docker daemon from `pull`, `push`, and `login` operations against v1 registries. Though disabled by default, this signals the intent to deprecate the v1 protocol.