From da8ef7585d2f2c6ad48602b2514783a117a2a483 Mon Sep 17 00:00:00 2001 From: xiekeyang Date: Sat, 19 Sep 2015 17:44:23 +0800 Subject: [PATCH] add description to manifest spec This PR add some description to manifest spec. It clarifies the relationship between `fsLayers` and `history` fields. Signed-off-by: xiekeyang --- docs/spec/manifest-v2-1.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/spec/manifest-v2-1.md b/docs/spec/manifest-v2-1.md index 259e3cf65..bf6a301a8 100644 --- a/docs/spec/manifest-v2-1.md +++ b/docs/spec/manifest-v2-1.md @@ -55,18 +55,22 @@ Manifest provides the base accessible fields for working with V2 image format - **`history`** *array* - history is a list of unstructured historical data for v1 compatibility. + history is a list of unstructured historical data for v1 compatibility. It + contains ID of the image layer and ID of the layer's parent layers. history is a struct consisting of the following fields - **`v1Compatibility`** string - V1Compatibility is the raw V1 compatibility information. This will + V1Compatibility is the raw V1 compatibility information. This will contain the JSON object describing the V1 of this image. - **`schemaVersion`** *int* SchemaVersion is the image manifest schema that this image follows. +>**Note**:the length of `history` must be equal to the length of `fsLayers` and +>entries in each are correlated by index. + ## Signed Manifests Signed manifests provides an envelope for a signed image manifest. A signed