Uwe Hermann tightned up comments, etc. to follow OpenOCD policy

[fw/openocd] / src / helper / replacements.h

diff --git a/src/helper/replacements.h b/src/helper/replacements.h
index 7d48e3c64bbc65ba4eb5b3dc96b27f832aebea00..fcfa8bc86a5d8cd22b47a2ae6767ac2f65515b0f 100644 (file)
--- a/src/helper/replacements.h
+++ b/src/helper/replacements.h
@@ -67,39 +67,40 @@ struct timezone {
 };
 
 extern int gettimeofday(struct timeval *tv, struct timezone *tz);
-#endif\r
-\r
+#endif
+
 /**** clear_malloc & fill_malloc ****/
 void *clear_malloc(size_t size);
 void *fill_malloc(size_t size);
-\r
-/*\r
- * Now you have 3 ways for the malloc function:\r
- *\r
- * 1. Do not change anything, use the original malloc\r
- *\r
- * 2. Use the clear_malloc function instead of the original malloc.\r
- *    In this case you must use the following define:\r
- *    #define malloc((_a)) clear_malloc((_a))\r
- *\r
- * 3. Use the fill_malloc function instead of the original malloc.\r
- *    In this case you must use the following define:\r
- *    #define malloc((_a)) fill_malloc((_a))\r
- *\r
- * We have figured out that there could exist some malloc problems\r
- * where variables are using without to be initialise. To find this\r
- * places, use the fill_malloc function. With this function we want \r
- * to initialize memory to some known bad state. This is quite easily \r
- * spotted in the debugger and will trap to an invalid address. \r
- *\r
- * clear_malloc can be used if you want to set not initialise \r
- * variable to 0.\r
- *\r
- * If you do not want to change the malloc function, to not use one of\r
- * the following macros. Which is the default way.\r
- */\r
-//#define malloc((_a)) clear_malloc((_a))
-//#define malloc((_a)) fill_malloc((_a))
+
+/*
+ * Now you have 3 ways for the malloc function:
+ *
+ * 1. Do not change anything, use the original malloc
+ *
+ * 2. Use the clear_malloc function instead of the original malloc.
+ *    In this case you must use the following define:
+ *    #define malloc((_a)) clear_malloc((_a))
+ *
+ * 3. Use the fill_malloc function instead of the original malloc.
+ *    In this case you must use the following define:
+ *    #define malloc((_a)) fill_malloc((_a))
+ *
+ * We have figured out that there could exist some malloc problems
+ * where variables are using without to be initialise. To find this
+ * places, use the fill_malloc function. With this function we want 
+ * to initialize memory to some known bad state. This is quite easily 
+ * spotted in the debugger and will trap to an invalid address. 
+ *
+ * clear_malloc can be used if you want to set not initialise 
+ * variable to 0.
+ *
+ * If you do not want to change the malloc function, to not use one of
+ * the following macros. Which is the default way.
+ */
+ 
+/* #define malloc(_a) clear_malloc(_a) */
+/* #define malloc(_a) fill_malloc(_a) */
 
 /* GNU extensions to the C library that may be missing on some systems */
 #ifndef HAVE_STRNDUP