Changeset 1772e6d in mainline

Timestamp:

2012-07-30T21:34:04Z (12 years ago)

Author:

Martin Sucha <sucha14@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

f80fd8c

Parents:

597b12e

Message:

Update documentation for str_cmp and str_lcmp.

This is a modified version of formulation suggested by Jiri Zarevucky.

Files:

• boot/generic/src/str.c (modified) (1 diff)
• kernel/generic/src/lib/str.c (modified) (3 diffs)
• uspace/lib/c/generic/str.c (modified) (3 diffs)

boot/generic/src/str.c

@@ -357 +357 @@
  * and both strings consist of the same sequence of characters.
  *
- * A string is smaller than another string iff it is shorter or
- * has a character with lower value at the first position where
- * the strings differ.
+ * A string S1 is less than another string S2 if it has a character with
+ * lower value at the first character position where the strings differ.
+ * If the strings differ in length, the shorter one is treated as if
+ * padded by characters with a value of zero.
  *
  * @param s1 First string to compare.
  * @param s2 Second string to compare.
  *
- * @return 0 if the strings are equal, -1 if first is smaller,
- *         1 if second smaller.
+ * @return 0 if the strings are equal, -1 if the first is less than the second,
+ *         1 if the second is less than the first.
  *
  */

kernel/generic/src/lib/str.c

@@ -459 +459 @@
  * and both strings consist of the same sequence of characters.
  *
- * A string is smaller than another string iff it is shorter or
- * has a character with lower value at the first position where
- * the strings differ.
+ * A string S1 is less than another string S2 if it has a character with
+ * lower value at the first character position where the strings differ.
+ * If the strings differ in length, the shorter one is treated as if
+ * padded by characters with a value of zero.
  *
  * @param s1 First string to compare.
  * @param s2 Second string to compare.
  *
- * @return 0 if the strings are equal, -1 if first is smaller,
- *         1 if second smaller.
+ * @return 0 if the strings are equal, -1 if the first is less than the second,
+ *         1 if the second is less than the first.
  *
  */
@@ -503 +504 @@
  * up to max_len characters.
  *
- * A string is smaller than another string iff it is shorter or
- * has a character with lower value at the first position where
- * the strings differ, considering only first max_len characters.
+ * A string S1 is less than another string S2 if it has a character with
+ * lower value at the first character position where the strings differ.
+ * If the strings differ in length, the shorter one is treated as if
+ * padded by characters with a value of zero. Only the first max_len
+ * characters are considered.
  *
  * @param s1      First string to compare.
@@ -511 +514 @@
  * @param max_len Maximum number of characters to consider.
  *
- * @return 0 if the strings are equal, -1 if first is smaller,
- *         1 if second smaller.
+ * @return 0 if the strings are equal, -1 if the first is less than the second,
+ *         1 if the second is less than the first.
  *
  */

uspace/lib/c/generic/str.c

@@ -431 +431 @@
  * and both strings consist of the same sequence of characters.
  *
- * A string is smaller than another string iff it is shorter or
- * has a character with lower value at the first position where
- * the strings differ.
+ * A string S1 is less than another string S2 if it has a character with
+ * lower value at the first character position where the strings differ.
+ * If the strings differ in length, the shorter one is treated as if
+ * padded by characters with a value of zero.
  *
  * @param s1 First string to compare.
  * @param s2 Second string to compare.
  *
- * @return 0 if the strings are equal, -1 if first is smaller,
- *         1 if second smaller.
+ * @return 0 if the strings are equal, -1 if the first is less than the second,
+ *         1 if the second is less than the first.
  *
  */
@@ -475 +476 @@
  * up to max_len characters.
  *
- * A string is smaller than another string iff it is shorter or
- * has a character with lower value at the first position where
- * the strings differ, considering only first max_len characters.
+ * A string S1 is less than another string S2 if it has a character with
+ * lower value at the first character position where the strings differ.
+ * If the strings differ in length, the shorter one is treated as if
+ * padded by characters with a value of zero. Only the first max_len
+ * characters are considered.
  *
  * @param s1      First string to compare.
@@ -483 +486 @@
  * @param max_len Maximum number of characters to consider.
  *
- * @return 0 if the strings are equal, -1 if first is smaller,
- *         1 if second smaller.
+ * @return 0 if the strings are equal, -1 if the first is less than the second,
+ *         1 if the second is less than the first.
  *
  */