[incubator-nuttx] branch master updated: Documentation: Add FAQ entry

[pr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

protobits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git


The following commit(s) were added to refs/heads/master by this push:
     new 9d5ed6e  Documentation: Add FAQ entry
9d5ed6e is described below

commit 9d5ed6e594f1cc09cfcb4b221dd9285529a79bb3
Author: Alan C. Assis <ac...@gmail.com>
AuthorDate: Wed Apr 14 13:46:51 2021 -0300

    Documentation: Add FAQ entry
---
 Documentation/faq/index.rst | 40 ++++++++++++++++++++++++++++++++++++++++
 Documentation/index.rst     |  1 +
 2 files changed, 41 insertions(+)

diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst
new file mode 100644
index 0000000..1d8302c
--- /dev/null
+++ b/Documentation/faq/index.rst
@@ -0,0 +1,40 @@
+.. todo::
+  Create new subsections as needed.
+
+===
+FAQ
+===
+
+NSH Tricks
+==========
+
+How to interrupt an NSH Application using Ctrl^C ?
+--------------------------------------------------
+
+You need to enable these options in the menuconfig:
+
+    RTOS Features --->
+        Signal Configuration --->
+            [*] Default signal actions --->
+                [*] SIGINT and SIGKILL
+    Device Drivers --->
+        Serial Driver Support --->
+            [*] Serial TERMIOS support
+            [*]   Support SIGINT
+            (0x03)  Serial parse SIGINT characters
+
+Network
+=======
+
+How to detect Ethernet cable connection/disconnection?
+------------------------------------------------------
+
+NuttX supports Ethernet connection/disconnection events from Ethernet PHY
+using signals (see ``nuttx/drivers/net/phy_notify.c``).
+The network monitor thread at apps/netutils/netinit (see
+``CONFIG_NETINIT_MONITOR``) will handle taking the network down if the cable
+is unplugged and bringing it back up when the cable is restored.
+It is important to note that your Ethernet controller driver of your
+MCU needs to support CONFIG_ARCH_PHY_INTERRUPT (and implement
+``arch_phy_irq()``).
+
diff --git a/Documentation/index.rst b/Documentation/index.rst
index e6240b3..59b88be 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -27,6 +27,7 @@ Last Updated: |today|
    components/index.rst
    applications/index.rst
    reference/index.rst
+   faq/index.rst
    guides/index.rst
    contributing/index.rst
    glossary.rst