Mirror
/
klipper-dgus
mirror of https://github.com/Desuuuu/klipper.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Expand on why it is important to provide the log in Contact.md 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2018-07-08 20:11:05 -04:00
parent fa9b321991
commit 4125e176b7
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/Contact.md
View File

@ -4,26 +4,32 @@ developers.
Issue reporting Issue reporting
=============== ===============
In order to report a problem or request a change in behavior, it is It is very important to attach the Klipper log file to all
necessary to collect the Klipper log file. The first step is to reports. The log file has been engineered to answer common questions
**issue an M112 command** in the OctoPrint terminal window immediately the Klipper developers have about the software and its environment
after the undesirable event occurs. This causes Klipper to go into a (software version, hardware type, configuration, event timing, and
"shutdown state" and it will cause additional debugging information to hundreds of other questions). **The developers need the Klipper log
be written to the log file. file to provide any meaningful assistance**; only this log file
provides the necessary information.
Issue requests are submitted through Github. **All issues must On a problem report 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 Github issues must
include the full /tmp/klippy.log log file from the session that 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 event being reported.** An "scp" and/or "sftp" utility is
acquire this log file. The "scp" utility comes standard with Linux and needed to acquire this log file. The "scp" utility comes standard with
MacOS desktops. There are freely available scp utilities for other Linux and MacOS desktops. There are freely available scp utilities for
desktops (eg, WinSCP). other 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
machine to your desktop. It is a good idea to compress the klippy.log Raspberry Pi to your desktop. It is a good idea to compress the
file before posting it (eg, using zip or gzip). Open a new issue at klippy.log file before posting it (eg, using zip or gzip). Open a new
https://github.com/KevinOConnor/klipper/issues , provide a description issue at https://github.com/KevinOConnor/klipper/issues , provide a
of the problem, and **attach the `klippy.log` file to the issue**: description of the problem, and **attach the `klippy.log` file to the
![attach-issue](img/attach-issue.png) issue**: ![attach-issue](img/attach-issue.png)
Mailing list Mailing list
============ ============