From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 9 Mar 2018 21:44:47 +0000 (+0100)
Subject: copy: add brief comment to copy_bytes() explaining its return values
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=aed713497cfa93e0ab3397a82af013381b4a370b;p=elogind.git

copy: add brief comment to copy_bytes() explaining its return values
---

diff --git a/src/basic/copy.c b/src/basic/copy.c
index ff53f8394..673272d65 100644
--- a/src/basic/copy.c
+++ b/src/basic/copy.c
@@ -65,6 +65,10 @@ int copy_bytes(int fdf, int fdt, uint64_t max_bytes, CopyFlags copy_flags) {
         assert(fdf >= 0);
         assert(fdt >= 0);
 
+        /* Tries to copy bytes from the file descriptor 'fdf' to 'fdt' in the smartest possible way. Copies a maximum
+         * of 'max_bytes', which may be specified as UINT64_MAX, in which no maximum is applied. Returns negative on
+         * error, zero if EOF is hit before the bytes limit is hit and positive otherwise. */
+
 #if 0 /// UNNEEDED by elogind
         /* Try btrfs reflinks first. */
         if ((copy_flags & COPY_REFLINK) &&