platforms: update format for platform specifier

Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
Stephen J Day 2017-09-13 11:41:45 -07:00
parent 94f6be5f10
commit 775f7cea47
No known key found for this signature in database
GPG Key ID: 67B3DED84EDC823F

View File

@ -49,8 +49,9 @@
// While the OCI platform specifications provide a tool for components to // While the OCI platform specifications provide a tool for components to
// specify structured information, user input typically doesn't need the full // specify structured information, user input typically doesn't need the full
// context and much can be inferred. To solve this problem, we introduced // context and much can be inferred. To solve this problem, we introduced
// "specifiers". A specifier has the format `<os|arch>[/<arch>[/<variant>]]`. // "specifiers". A specifier has the format
// The user can provide either the operating system or the architecture or both. // `<os>|<arch>|<os>/<arch>[/<variant>]`. The user can provide either the
// operating system or the architecture or both.
// //
// An example of a common specifier is `linux/amd64`. If the host has a default // An example of a common specifier is `linux/amd64`. If the host has a default
// of runtime that matches this, the user can simply provide the component that // of runtime that matches this, the user can simply provide the component that
@ -130,10 +131,10 @@ func (m *matcher) String() string {
// Parse parses the platform specifier syntax into a platform declaration. // Parse parses the platform specifier syntax into a platform declaration.
// //
// Platform specifiers are in the format <os|arch>[/<arch>[/<variant>]]. The // Platform specifiers are in the format `<os>|<arch>|<os>/<arch>[/<variant>]`.
// minimum required information for a platform specifier is the operating system // The minimum required information for a platform specifier is the operating
// or architecture. If there is only a single string (no slashes), the value // system or architecture. If there is only a single string (no slashes), the
// will be matched against the known set of operating systems, then fall // value will be matched against the known set of operating systems, then fall
// back to the known set of architectures. The missing component will be // back to the known set of architectures. The missing component will be
// inferred based on the local environment. // inferred based on the local environment.
// //