From 8747edd671507203dd69598aa3e7cd688aa517b8 Mon Sep 17 00:00:00 2001
From: Johannes Nussbaum <39048939+jnussbaum@users.noreply.github.com>
Date: Mon, 11 Mar 2024 14:00:57 +0100
Subject: [PATCH] docs: add guarantee note for resume-xmlupload (#868)

---
 docs/cli-commands.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/cli-commands.md b/docs/cli-commands.md
index cbadb9ad6..2570ec164 100644
--- a/docs/cli-commands.md
+++ b/docs/cli-commands.md
@@ -177,6 +177,10 @@ this file must remain in place.
 
 ## `resume-xmlupload`
 
+| <center>Warning</center>                                                    |
+|--------------------------------------------------------------------------|
+| We do not guarantee that the state of an xmlupload is cleanly saved after `Ctrl + C`. We only guarantee this for `dsp-tools xmlupload --interrupt-after`. |
+
 This command resumes a previously interrupted XML upload.
 
 ```bash
@@ -194,6 +198,7 @@ the pickle file `~/.dsp-tools/xmluploads/[server]/resumable/latest.pkl` must exi
 Currently, only one interrupted upload can be resumed at a time per server.
 
 
+
 ## `excel2json`
 
 This command creates a JSON project definition file from a nested folder structure with Excel files.