From b1a3991beaabab048532ad76a302ba983871bbb8 Mon Sep 17 00:00:00 2001 From: Wojciech Soltys Date: Thu, 5 Dec 2024 09:46:23 +0100 Subject: [PATCH] Update documentation --- cmd/image-syncer/README.md | 2 +- cmd/image-syncer/main.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/image-syncer/README.md b/cmd/image-syncer/README.md index d1f55c5f13c0..98a4822392fb 100644 --- a/cmd/image-syncer/README.md +++ b/cmd/image-syncer/README.md @@ -16,7 +16,7 @@ Contents: ## Overview -Image-syncer is used to copy container images between two registries. +Image-syncer is used to copy container images between two registries. Sync the whole index if possible, otherwise sync singular image. It copies images **only when they are not present** in the target repository. The tool guarantees that **tags are immutable** in the target repository. That means that if the image tag is already present in the target registry, it is not overwritten by the new image. diff --git a/cmd/image-syncer/main.go b/cmd/image-syncer/main.go index 56553aaf6281..7b3793011dc2 100644 --- a/cmd/image-syncer/main.go +++ b/cmd/image-syncer/main.go @@ -192,7 +192,7 @@ func SyncImages(ctx context.Context, cfg *Config, images *imagesync.SyncDef, aut return err } log.WithField("image", img.Source).Info("Start sync") - // sync whole index if possible, otherwise sync singular image + // Sync the whole index if possible, otherwise sync singular image. var isIndex bool isIndex, err = isImageIndex(ctx, img.Source) if err != nil {