From e23325d9dd710f96950808ae996b4512cdbbe521 Mon Sep 17 00:00:00 2001 From: Brendan Le Foll Date: Tue, 20 Jan 2015 23:25:31 +0000 Subject: [PATCH] docs: add debugging doc Signed-off-by: Brendan Le Foll --- README.md | 8 ++++++++ docs/debugging.md | 30 ++++++++++++++++++++++++++++++ docs/index.md | 13 +++++-------- 3 files changed, 43 insertions(+), 8 deletions(-) create mode 100644 docs/debugging.md diff --git a/README.md b/README.md index 69e18e2..2f30d69 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,14 @@ Examples See the [examples](../../tree/master/examples) available for various languages +Debugging +========= + +Sometimes it just doesn't want to work, let us try and help you, you can file +issues in github or join us in #mraa on freenode IRC, hang around for a little +while because we're not necessarily on 24/7, but we'll get back to you! Have a +glance at our [debugging](../master/docs/debugging.md) page too. + C/C++ API Documentation =========== diff --git a/docs/debugging.md b/docs/debugging.md new file mode 100644 index 0000000..d05d78f --- /dev/null +++ b/docs/debugging.md @@ -0,0 +1,30 @@ +Debugging libmraa {#debugging} +================= + +This page contains a few debugging tip, when filing an issue please go through +this list as if you don't it's the first thing we'll have to ask you to do. + +### Version + +Getting the exact version of libmraa you're running is really important to us. +The best way to get this is to call mraa_get_version() or mraa.getVersion(). If +mraa returns x.x.x-dirty then your version was not built from a git tree or you +built out of tree (see our building doc) - or you don't have git installed. + +### Syslog + +mraa logs pretty much everything that goes wrong to syslog, these days it'll go +to the systemd journal usually so check with `sudo journalctl -f` whilst +running your app or check all libmraa messages with `journalctl -t libmraa`. +Grab all the messages from the initialisation message right up to your last +one, using a pastebin is always a good idea, I like dpaste.com. If your system +does not have systemd likely your log is in /var/log/messages or similar. + +### Common Errors + +* Not running as root +* Incorrect IO numbers, mraa uses physical connector pin numbering see your + platform doc for details +* Unsuported platform +* Using the wrong pin, check pin capabilities + diff --git a/docs/index.md b/docs/index.md index 6deda79..fe14dfe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -44,15 +44,12 @@ Specific platform information for supported platforms is documented here: - @ref minnowmax - @ref rasppib -### ENV RECOMENDATIONS +## DEBUGGING -All of these are 'optional', however they are recommended. Only a C compiler, -cmake, libm and pthreads are technically required to compile. - -- Swig 3.0.1+ built with node.js (0.10.x) & python support -- doxygen -- sphinx (requires doxygen) -- pygments +Sometimes it just doesn't want to work, let us try and help you, you can file +issues in github or join us in #mraa on freenode IRC, hang around for a little +while because we're not necessarily on 24/7, but we'll get back to you! Have a +glance at our @debugging page too ## COMPILING -- 2.7.4