3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Try to make the klippy.log bug reporting more clear 

Emphasize that the log file needs to be attached to the issue.
Encourage M112 to be issued on every bug report.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2018-01-21 12:49:52 -05:00
parent 84c623e705
commit 08444a8b89
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/Contact.md
View File

@ -1,29 +1,29 @@
This page provides information on how to contact the Klipper This page provides information on how to contact the Klipper
developers. developers.
Bug reporting Issue reporting
============= ===============
Bug reports are submitted through github issues. **All bug reports In order to report a problem or request a change in behavior, it is
must include the full /tmp/klippy.log log file from the session that necessary to collect the Klipper log file. The first step is to
**issue an M112 command** in the OctoPrint terminal window immediately
after the undesirable event occurs. This causes Klipper to go into a
"shutdown state" and it will cause additional debugging information to
be written to the log file.
Issue requests are submitted through Github. **All issues must
include the full /tmp/klippy.log log file from the session that
produced the error.** An "scp" and/or "sftp" utility is needed to produced the error.** An "scp" and/or "sftp" utility is needed to
acquire this log file. The "scp" utility comes standard with Linux and acquire this log file. The "scp" utility comes standard with Linux and
MacOS desktops. There are freely available scp utilities for other MacOS desktops. There are freely available scp utilities for other
desktops (eg, WinSCP). desktops (eg, WinSCP).
Use the scp utility to copy the `/tmp/klippy.log` file from the host Use the scp utility to copy the `/tmp/klippy.log` file from the host
machine to your desktop. Open a new issue at machine to your desktop. It is a good idea to compress the klippy.log
file before posting it (eg, using zip or gzip). Open a new issue at
https://github.com/KevinOConnor/klipper/issues , provide a description https://github.com/KevinOConnor/klipper/issues , provide a description
of the problem, and attach the `klippy.log` file to the issue (use the of the problem, and **attach the `klippy.log` file to the issue**:
blue "selecting them" link beneath the problem description on the ![attach-issue](img/attach-issue.png)
github issue page to attach files). It is a good idea to compress the
klippy.log file before posting it (eg, using zip or gzip).
If the Klipper software does something unexpected but does not produce
an error, then immediately issue an M112 command in the Octoprint
terminal window and then gather the log as described above. The M112
command instructs Klipper to enter a "shutdown" state and it will
cause additional debugging information to be added to the log.
Mailing list Mailing list
============ ============

BIN
docs/img/attach-issue.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB