Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Sawthis committed Dec 5, 2024
1 parent e0ad104 commit b1a3991
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion cmd/image-syncer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion cmd/image-syncer/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit b1a3991

Please sign in to comment.