From e288040b7bf91cff262df0bb45e74150b2d62809 Mon Sep 17 00:00:00 2001
From: Flavio Santes <flavio.santes@intel.com>
Date: Wed, 24 Aug 2016 16:14:46 -0500
Subject: [PATCH] samples/net: Add KNOWN_ISSUES file for NATS and DNS sample
 apps

The KNOWN_ISSUES file describes issues and workarounds for the NATS
and DNS sample applications.

Change-Id: I9a33a82073707dbdd4109e0740108b99c42ad772
Signed-off-by: Flavio Santes <flavio.santes@intel.com>
---
 samples/net/dns_client/KNOWN_ISSUES   | 17 ++++++++++++++
 samples/net/nats_clients/KNOWN_ISSUES | 34 +++++++++++++++++++++++++++
 2 files changed, 51 insertions(+)
 create mode 100644 samples/net/dns_client/KNOWN_ISSUES
 create mode 100644 samples/net/nats_clients/KNOWN_ISSUES

diff --git a/samples/net/dns_client/KNOWN_ISSUES b/samples/net/dns_client/KNOWN_ISSUES
new file mode 100644
index 00000000000..0ae18865ff6
--- /dev/null
+++ b/samples/net/dns_client/KNOWN_ISSUES
@@ -0,0 +1,17 @@
+Issues
+------
+
+- RX or TX error:
+	Caused by:
+		net_send error, see:
+		https://jira.zephyrproject.org/browse/ZEP-428
+		https://jira.zephyrproject.org/browse/ZEP-676
+
+	Workaround:
+		Wait until the IP stack is "activated"
+		or reset the board.
+
+Limitations
+-----------
+
+See the ./README_API file.
diff --git a/samples/net/nats_clients/KNOWN_ISSUES b/samples/net/nats_clients/KNOWN_ISSUES
new file mode 100644
index 00000000000..bd9984ffd96
--- /dev/null
+++ b/samples/net/nats_clients/KNOWN_ISSUES
@@ -0,0 +1,34 @@
+Issues
+------
+
+- Unable to connect
+	Caused by:
+		Incorrect TCP flags handling from the Zephyr IP Stack.
+	Workaround:
+		Reset the board.
+
+- Publisher or Subscriber error
+	Caused by:
+		The NATS server will send the PING message at configurable
+		intervals. If the PING message is not handled by the
+		client, the server will close the connection.
+
+		The NATS applications are synchronous, so if the PING
+		message arrives when the application is processing
+		another message (i.e. verbose = 1), the PING message
+		will be ignored and the server will close the connection.
+	Workaround:
+		Codify a routine similar to handle_msg (see main.c) to
+		handle all the incoming messages.
+
+- RX or TX error
+	Caused by:
+		Perhaps the rx/tx timeouts are too short for the LAN.
+        Workaround:
+		Increase the rx or tx timeout.
+		See: publisher/src/netz.c, struct netz_ctx_t.
+
+Limitations
+-----------
+
+See the ./README file.