From b71b4e1fb9aac5215aff7ce87e1bbb4010054ecd Mon Sep 17 00:00:00 2001 From: Timothy Hobbs Date: Mon, 2 Jan 2017 22:06:46 +0100 Subject: [PATCH] Docs: Be more clear when specifying valid formats for strings - Use the word letter rather than character to refer to letters ;) when trying to specify that only letters and numbers can be used, and not ANY character... - Small corrections Fixes #29821 Signed-off-by: Timothy Hobbs --- docs/reference/commandline/tag.md | 8 ++++---- image/spec/v1.md | 4 ++-- man/src/image/tag.md | 9 +++++---- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index 983bfe27b2..ebb4c23c10 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -29,13 +29,13 @@ by a registry hostname. The hostname must comply with standard DNS rules, but may not contain underscores. If a hostname is present, it may optionally be followed by a port number in the format `:8080`. If not present, the command uses Docker's public registry located at `registry-1.docker.io` by default. Name -components may contain lowercase characters, digits and separators. A separator +components may contain lowercase letters, digits and separators. A separator is defined as a period, one or two underscores, or one or more dashes. A name component may not start or end with a separator. -A tag name may contain lowercase and uppercase characters, digits, underscores, -periods and dashes. A tag name may not start with a period or a dash and may -contain a maximum of 128 characters. +A tag name must be valid ASCII and may contain lowercase and uppercase letters, +digits, underscores, periods and dashes. A tag name may not start with a +period or a dash and may contain a maximum of 128 characters. You can group your images together using names and tags, and then upload them to [*Share Images via Repositories*](https://docs.docker.com/engine/tutorials/dockerrepos/#/contributing-to-docker-hub). diff --git a/image/spec/v1.md b/image/spec/v1.md index 57a599b8ff..69115549cb 100644 --- a/image/spec/v1.md +++ b/image/spec/v1.md @@ -92,7 +92,7 @@ This specification uses the following terms: often referred to as a tag as well, though it strictly refers to the full name of an image. Acceptable values for a tag suffix are implementation specific, but they SHOULD be limited to the set of - alphanumeric characters [a-zA-z0-9], punctuation + alphanumeric characters [a-zA-Z0-9], punctuation characters [._-], and MUST NOT contain a : character. @@ -105,7 +105,7 @@ This specification uses the following terms: my-app:3.1.4, my-app is the Repository component of the name. Acceptable values for repository name are implementation specific, but they SHOULD be limited to the set of - alphanumeric characters [a-zA-z0-9], and punctuation + alphanumeric characters [a-zA-Z0-9], and punctuation characters [._-], however it MAY contain additional / and : characters for organizational purposes, with the last : character being interpreted diff --git a/man/src/image/tag.md b/man/src/image/tag.md index 25c1f785d4..16abd75290 100644 --- a/man/src/image/tag.md +++ b/man/src/image/tag.md @@ -9,15 +9,16 @@ entire image name including the optional `TAG` after the ':'. present, it may optionally be followed by a port number in the format `:8080`. If not present, the command uses Docker's public registry located at `registry-1.docker.io` by default. Name components may contain lowercase - characters, digits and separators. A separator is defined as a period, one or + letters, digits and separators. A separator is defined as a period, one or two underscores, or one or more dashes. A name component may not start or end with a separator. **TAG** The tag assigned to the image to version and distinguish images with the same - name. The tag name may contain lowercase and uppercase characters, digits, - underscores, periods and dashes. A tag name may not start with a period or a - dash and may contain a maximum of 128 characters. + name. The tag name must be valid ASCII and may contain lowercase and + uppercase letters, digits, underscores, periods and hyphens. A tag name + may not start with a period or a hyphen and may contain a maximum of 128 + characters. # EXAMPLES