From: Daniel Stenberg <daniel@haxx.se>
Date: Thu, 8 Feb 2024 22:41:50 +0000 (+0100)
Subject: write-out.md: clarify error handling details
X-Git-Tag: curl-8_7_0~195
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c54d0ff6b3b1d2ff64af48e8955ce63efd4d162f;p=thirdparty%2Fcurl.git

write-out.md: clarify error handling details

- it gets used even if the transfer fails

- it does not cause error to be returned even if it fails

Closes #12909
---

diff --git a/docs/cmdline-opts/write-out.md b/docs/cmdline-opts/write-out.md
index 5af8ebbaba..ac4b7d03ff 100644
--- a/docs/cmdline-opts/write-out.md
+++ b/docs/cmdline-opts/write-out.md
@@ -18,10 +18,10 @@ Example:
 # `--write-out`
 
 Make curl display information on stdout after a completed transfer. The format
-is a string that may contain plain text mixed with any number of
-variables. The format can be specified as a literal "string", or you can have
-curl read the format from a file with "@filename" and to tell curl to read the
-format from stdin you write "@-".
+is a string that may contain plain text mixed with any number of variables.
+The format can be specified as a literal "string", or you can have curl read
+the format from a file with "@filename" and to tell curl to read the format
+from stdin you write "@-".
 
 The variables present in the output format are substituted by the value or
 text that curl thinks fit, as described below. All variables are specified as
@@ -45,11 +45,17 @@ the file name cannot be created, curl leaves the output destination to the one
 used prior to the *%output{}* instruction. Use *%output{\>\>name}* to append
 data to an existing file.
 
-**NOTE:**
-In Windows the %-symbol is a special symbol used to expand environment
-variables. In batch files all occurrences of % must be doubled when using this
-option to properly escape. If this option is used at the command prompt then
-the % cannot be escaped and unintended expansion is possible.
+This output is done independently of if the file transfer was successful or
+not.
+
+If the specified action or output specified with this option fails in any way,
+it will not make curl return a (different) error.
+
+**NOTE:** On Windows, the %-symbol is a special symbol used to expand
+environment variables. In batch files, all occurrences of % must be doubled
+when using this option to properly escape. If this option is used at the
+command prompt then the % cannot be escaped and unintended expansion is
+possible.
 
 The variables available are: