helper/list.h: add mention to the example in contrib
authorAntonio Borneo <borneo.antonio@gmail.com>
Thu, 27 May 2021 12:21:13 +0000 (14:21 +0200)
committerAntonio Borneo <borneo.antonio@gmail.com>
Fri, 4 Jun 2021 16:41:57 +0000 (17:41 +0100)
Without such reference, it could be difficult to find the example.

Change-Id: Ia9ffb06bc1a45446c2c7b53197ab3400e1d8a9e9
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/6281
Tested-by: jenkins
Reviewed-by: Tim Newsome <tim@sifive.com>
src/helper/list.h

index 0949636b918372734f11222bcb0d991532ed19d9..a7cd4ad37f2f4a03747471987d4ffad619da7c9a 100644 (file)
@@ -10,6 +10,8 @@
  *   list_prepare_entry;
  * - expand READ_ONCE, WRITE_ONCE, smp_load_acquire, smp_store_release;
  * - make comments compatible with doxygen.
+ *
+ * There is an example of using this file in contrib/list_example.c.
  */
 
 #ifndef OPENOCD_HELPER_LIST_H