Skip to content

Reporting an error with Machinekit

Michael Haberler edited this page Jun 23, 2014 · 18 revisions

Logging has changed a bit since the unified build code was introduced; the good news: it is much more detailed. The bad news is: some of the methods used so far wont help much anymore. For instance, the output of 'dmesg' only helps when you run on RTAI, and the files linuxcnc_debug.txt and linuxcnc_print.txt have no information value.

To make an effective error report for machinekit, please follow these steps:

  1. Make sure you have followed all the steps outlined here.

  2. If you got an error during running ./configure, please post the content of config.log .

  3. If you just built from git, make sure you do the 'sudo make setuid' step.

  4. Make sure you resolved any warnings you get during 'sudo make setuid'. Follow the instructions here and here to do so.

  5. cause the error to happen if its not startup-related.

  6. Try to narrow down the error to a minimal example.

  7. post as a gist to https://gist.github.com (a gist may contain several files):

    1. your configuration, in particular the .hal and the ini file(s)

    2. describe the platform: paste the output of 'uname -a'

    3. please describe the kernel running (homebrew? from which source/package?)

    4. the linuxcnc output from the terminal window

    5. the log file /var/log/linuxcnc.log (you might want to edit it to contain only the log of the last run, which always starts with a line like '…​ msgd:0: startup instance=inst0 …​.'

    6. the output of 'dmesg'

    7. if the error is visible in a screenshot or photo only, use http://imagebin.org/ to share it.

    8. any other files pertaining to the problem, for instance NGC input files.

  8. post links to all of the above to the mailing list.

If this is verified to be a bug, and you want it fixed, we require you to file an issue on the github issue tracker, labeled as 'bug' (red label).

The reason why gists are a better idea than pastebin and friends: pastebin etc usually expire uploads, meaning after a while the paste is deleted - this is bad if you attach the links to an issue, which should refer to this information permanently (bugs dont go away by expiration ;-) they need work eventually).

Note you can attach images to an issue in the github tracker directly (you can’t add an image to a gist AFAICT).