Changeset 523 for trunk/boot/tsar_mips32/boot_utils.h

Timestamp:

Aug 30, 2018, 6:45:18 PM (6 years ago)

Author:

viala@…

Message:

[boot] Remove testing if a pointer is null.

It's a bad practice in a lib to hide undesired null pointers.
Using an assert is better.

File:

• trunk/boot/tsar_mips32/boot_utils.h (modified) (3 diffs)

trunk/boot/tsar_mips32/boot_utils.h

@@ -145 +145 @@
 
 /****************************************************************************
- * This function copies the string pointed to by 'src' (the terminating 
- * null byte '\0' NOT included) to the buffer pointed to by 'dest'. 
- * @ src    : pointer to the string to be copied.  
- * @ dest   : pointer to the destination string. 
+ * This function copies the string pointed to by 'src' (the terminating
+ * null byte '\0' NOT included) to the buffer pointed to by 'dest'.
+ * @ src    : pointer to the string to be copied, should be not NULL.
+ * @ dest   : pointer to the destination string, should be not NULL.
  ****************************************************************************/
 void boot_strcpy( char* dest, const char * src );
@@ -154 +154 @@
 /****************************************************************************
  * This function calculates the length of the string pointed to by 's',
- * excluding the terminating null byte '\0'.  
- * @ s  : pointer to the string whose length is to be computed. 
- * @ returns the number of bytes in the string. 
+ * excluding the terminating null byte '\0'.
+ * @ s  : pointer to the string whose length is to be computed,
+ *        this pointer should be not NULL.
+ * @ returns the number of bytes in the string.
  ****************************************************************************/
 uint32_t boot_strlen( const char * s );
@@ -162 +163 @@
 /****************************************************************************
  * This function compares the 2 strings pointed to by 's1' and 's2'.
- * @ s1 : pointer to the first string to be compared.
- * @ s2 : pointer to the second string to be compared.
- * @ returns 0 if these 2 strings match, 1 otherwise. 
+ * If pointers point to the same adress assumed to be equals.
+ * @ s1 : pointer to the first string to be compared, should be not NULL.
+ * @ s2 : pointer to the second string to be compared, should be not NULL.
+ * @ returns 0 if these 2 strings match, 1 otherwise.
  ****************************************************************************/
 int boot_strcmp( const char * s1, const char * s2 );