]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
curl_str[n]equal.md: tidy up text to make them stand-alone
authorDaniel Stenberg <daniel@haxx.se>
Mon, 1 Jul 2024 07:05:19 +0000 (09:05 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 1 Jul 2024 07:38:52 +0000 (09:38 +0200)
Previously this was one single manpage for two functions but as they are
two separate ones since a while back, they should each clearly document
their single specific functions.

Follow-up to eefcc1bda4bc

Closes #14068

docs/libcurl/curl_strequal.md
docs/libcurl/curl_strnequal.md

index 70de794aa5a8c1e034f0fcc38af691547600e662..1584676d4facc8fd861a2eb742d262cb75a08172 100644 (file)
@@ -5,6 +5,7 @@ Title: curl_strequal
 Section: 3
 Source: libcurl
 See-also:
+  - curl_strnequal (3)
   - strcasecmp (3)
   - strcmp (3)
 Protocol:
@@ -13,7 +14,7 @@ Protocol:
 
 # NAME
 
-curl_strequal, curl_strnequal - case insensitive string comparisons
+curl_strequal - compare two strings ignoring case
 
 # SYNOPSIS
 
@@ -21,21 +22,21 @@ curl_strequal, curl_strnequal - case insensitive string comparisons
 #include <curl/curl.h>
 
 int curl_strequal(const char *str1, const char *str2);
-int curl_strnequal(const char *str1, const char *str2, size_t length);
 ~~~
 
 # DESCRIPTION
 
-The curl_strequal(3) function compares the two strings *str1* and
-*str2*, ignoring the case of the characters. It returns a non-zero (TRUE)
-integer if the strings are identical.
+The curl_strequal(3) function compares the two strings *str1* and *str2*,
+ignoring the case of the characters. It returns a non-zero (TRUE) integer if
+the strings are identical.
 
-The **curl_strnequal()** function is similar, except it only compares the
-first *length* characters of *str1*.
+This function uses plain ASCII based comparisons completely disregarding the
+locale - contrary to how **strcasecmp** and other system case insensitive
+string comparisons usually work.
 
-These functions are provided by libcurl to enable applications to compare
-strings in a truly portable manner. There are no standard portable case
-insensitive string comparison functions. These two work on all platforms.
+This function is provided by libcurl to enable applications to compare strings
+in a truly portable manner. There are no standard portable case insensitive
+string comparison functions. This function works on all platforms.
 
 # EXAMPLE
 
@@ -45,8 +46,6 @@ int main(int argc, char **argv)
   const char *name = "compare";
   if(curl_strequal(name, argv[1]))
     printf("Name and input matches\n");
-  if(curl_strnequal(name, argv[1], 5))
-    printf("Name and input matches in the 5 first bytes\n");
 }
 ~~~
 
index 70de794aa5a8c1e034f0fcc38af691547600e662..a949240c76b62aac92a36d402089caf4ffc51100 100644 (file)
@@ -5,6 +5,7 @@ Title: curl_strequal
 Section: 3
 Source: libcurl
 See-also:
+  - curl_strequal (3)
   - strcasecmp (3)
   - strcmp (3)
 Protocol:
@@ -13,29 +14,32 @@ Protocol:
 
 # NAME
 
-curl_strequal, curl_strnequal - case insensitive string comparisons
+curl_strnequal - compare two strings ignoring case
 
 # SYNOPSIS
 
 ~~~c
 #include <curl/curl.h>
 
-int curl_strequal(const char *str1, const char *str2);
 int curl_strnequal(const char *str1, const char *str2, size_t length);
 ~~~
 
 # DESCRIPTION
 
-The curl_strequal(3) function compares the two strings *str1* and
-*str2*, ignoring the case of the characters. It returns a non-zero (TRUE)
-integer if the strings are identical.
+The curl_strnequal(3) function compares the two strings *str1* and *str2*,
+ignoring the case of the characters. It returns a non-zero (TRUE) integer if
+the strings are identical.
 
-The **curl_strnequal()** function is similar, except it only compares the
-first *length* characters of *str1*.
+This function compares no more than the first *length* bytes of *str1* and
+*str2*.
 
-These functions are provided by libcurl to enable applications to compare
-strings in a truly portable manner. There are no standard portable case
-insensitive string comparison functions. These two work on all platforms.
+This function uses plain ASCII based comparisons completely disregarding the
+locale - contrary to how **strcasecmp** and other system case insensitive
+string comparisons usually work.
+
+This function is provided by libcurl to enable applications to compare strings
+in a truly portable manner. There are no standard portable case insensitive
+string comparison functions. This function works on all platforms.
 
 # EXAMPLE
 
@@ -43,8 +47,6 @@ insensitive string comparison functions. These two work on all platforms.
 int main(int argc, char **argv)
 {
   const char *name = "compare";
-  if(curl_strequal(name, argv[1]))
-    printf("Name and input matches\n");
   if(curl_strnequal(name, argv[1], 5))
     printf("Name and input matches in the 5 first bytes\n");
 }