Changeset 4efeab5 in mainline for kernel/generic/src/lib/str.c

Timestamp:

2012-07-29T20:32:05Z (12 years ago)

Author:

Martin Sucha <sucha14@…>

Branches:

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

Children:

99047a72

Parents:

13d5639

Message:

Update documentation for str_cmp and str_lcmp

File:

• kernel/generic/src/lib/str.c (modified) (2 diffs)

kernel/generic/src/lib/str.c

@@ -456 +456 @@
  *
  * Do a char-by-char comparison of two NULL-terminated strings.
- * The strings are considered equal iff they consist of the same
- * characters on the minimum of their lengths.
+ * The strings are considered equal iff their length is equal
+ * 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.
  *
  * @param s1 First string to compare.
@@ -494 +498 @@
  *
  * Do a char-by-char comparison of two NULL-terminated strings.
- * The strings are considered equal iff they consist of the same
- * characters on the minimum of their lengths and the length limit.
+ * The strings are considered equal iff
+ * min(str_length(s1), max_len) == min(str_length(s2), max_len)
+ * and both strings consist of the same sequence of characters,
+ * 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.
  *
  * @param s1      First string to compare.