diff options
Diffstat (limited to 'docs/Contact.md')
| -rw-r--r-- | docs/Contact.md | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/docs/Contact.md b/docs/Contact.md index 5dfd4fa8..9d289f52 100644 --- a/docs/Contact.md +++ b/docs/Contact.md @@ -4,26 +4,32 @@ developers. Issue reporting =============== -In order to report a problem or request a change in behavior, it is -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. +It is very important to attach the Klipper log file to all +reports. The log file has been engineered to answer common questions +the Klipper developers have about the software and its environment +(software version, hardware type, configuration, event timing, and +hundreds of other questions). **The developers need the Klipper log +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 -produced the error.** An "scp" and/or "sftp" utility is needed to -acquire this log file. The "scp" utility comes standard with Linux and -MacOS desktops. There are freely available scp utilities for other -desktops (eg, WinSCP). +produced the event being reported.** An "scp" and/or "sftp" utility is +needed to acquire this log file. The "scp" utility comes standard with +Linux and MacOS desktops. There are freely available scp utilities for +other desktops (eg, WinSCP). -Use the scp utility to copy the `/tmp/klippy.log` file from the host -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 -of the problem, and **attach the `klippy.log` file to the issue**: - +Use the scp utility to copy the `/tmp/klippy.log` file from the +Raspberry Pi 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 of the problem, and **attach the `klippy.log` file to the +issue**:  Mailing list ============ |