strcase.h: add comment about the return code

Tool often we run into expecting this to work like strcmp, but it
returns 1 instead of 0 for match.

Closes #8658

diff --git a/.mailmap b/.mailmap
index a127ad238cdd3882a934049fc4e6353511d70fd1..79c8ff369bacd885cf48cfbab43e47f4f29822f8 100644 (file)
--- a/.mailmap
+++ b/.mailmap
@@ -88,3 +88,4 @@ pheiduck on github <47042125+pheiduck@users.noreply.github.com>
 neutric on github <5984479+neutric@users.noreply.github.com>
 Jan-Piet Mens <jp@mens.de>
 Henrik Holst <henrik.holst@millistream.com>
+Christian Schmitz <support@monkeybreadsoftware.de>

diff --git a/lib/strcase.h b/lib/strcase.h
index b628656b977ec1c533d0b9a8428fa05a8520e5ce..b234d3815220a3c0fb08f11fcdfa71081df6491d 100644 (file)
--- a/lib/strcase.h
+++ b/lib/strcase.h
@@ -29,6 +29,8 @@
  * and only compare strings we know are safe for this.
  *
  * The function is capable of comparing a-z case insensitively.
+ *
+ * Result is 1 if text matches and 0 if not.
  */
 
 #define strcasecompare(a,b) Curl_strcasecompare(a,b)