From 014285aa3248050f0b0653bc6029531aa4cdbf6b Mon Sep 17 00:00:00 2001 From: Norman Fomferra Date: Thu, 7 Mar 2024 14:44:00 +0100 Subject: [PATCH] Updates --- CHANGES.md | 4 +++- docs/cli.md | 2 +- docs/config.md | 2 +- zappend/cli.py | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 04c6f01..79dbb5c 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,8 @@ ## Version 0.5.2 (in development) - +* Added configuration setting `force_new`, which forces creation of a new + target dataset. An existing target dataset (and its lock) will be + permanently deleted before appending of slice datasets begins. [#72] ## Version 0.5.1 (2024-02-23) diff --git a/docs/cli.md b/docs/cli.md index 7d1a9f0..243bc5b 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -20,7 +20,7 @@ Options: the previous ones. -t, --target TARGET Target Zarr dataset path or URI. Overrides the 'target_dir' configuration field. - --force-new Force creation of a new target dataset. An existing + --force-new Force creation of a new target dataset. An existing target dataset (and its lock) will be permanently deleted before appending of slice datasets begins. WARNING: the deletion cannot be rolled back. diff --git a/docs/config.md b/docs/config.md index 90fa9ed..dfc269d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -243,7 +243,7 @@ Options for the filesystem given by the protocol of `temp_dir`. ## `force_new` Type _boolean_. -Force creation of a new target dataset. An existing target dataset (and its lock) will be permanently deleted before appending of slice datasets begins. WARNING: the deletion cannot be rolled back. +Force creation of a new target dataset. An existing target dataset (and its lock) will be permanently deleted before appending of slice datasets begins. WARNING: the deletion cannot be rolled back. Defaults to `false`. ## `disable_rollback` diff --git a/zappend/cli.py b/zappend/cli.py index 1456975..8b8f4e0 100644 --- a/zappend/cli.py +++ b/zappend/cli.py @@ -32,7 +32,7 @@ "--force-new", is_flag=True, help=( - "Force creation of a new target dataset. " + "Force creation of a new target dataset." " An existing target dataset (and its lock) will be" " permanently deleted before appending of slice datasets" " begins. WARNING: the deletion cannot be rolled back."