aboutsummaryrefslogtreecommitdiff
path: root/docs/examples
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2018-09-10 17:42:39 +0200
committerDaniel Stenberg <daniel@haxx.se>2018-09-10 17:42:39 +0200
commit00c3254595e0b21f1121ef0eb9b4d70c4bc8f6f6 (patch)
tree313f4f4a6181d62f4754af37afaf6efea5dc811a /docs/examples
parent9ba22ce6b52751ed1e2abdd177b0a1d241819b4e (diff)
example/asiohiper: insert warning comment about its status
This example is simply not working correctly but there's nobody around with the skills and energy to fix it. Closes #2407
Diffstat (limited to 'docs/examples')
-rw-r--r--docs/examples/asiohiper.cpp12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/examples/asiohiper.cpp b/docs/examples/asiohiper.cpp
index 9e0554f59..de1480507 100644
--- a/docs/examples/asiohiper.cpp
+++ b/docs/examples/asiohiper.cpp
@@ -5,7 +5,7 @@
* | (__| |_| | _ <| |___
* \___|\___/|_| \_\_____|
*
- * Copyright (C) 2012 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
+ * Copyright (C) 2012 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
*
* This software is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
@@ -42,6 +42,16 @@
*
* This is purely a demo app, all retrieved data is simply discarded by the
* write callback.
+ *
+ * ===========================================================================
+ * WARNING: This example program is known to have flaws:
+ * https://github.com/curl/curl/issues/2407
+ *
+ * It still kept in the example repository with the hope that it might be
+ * useful, and maybe some day someone who knows enough about boost::asio will
+ * read this text, accept the challenge and make the example code work
+ * correctly. Until then: expect this example program to fail occasionally.
+ * ===========================================================================
*/