Changes between Version 13 and Version 37 of Help/Action/ShowStatusReport

Timestamp:

(multiple changes)

Author:

(multiple changes)

Comment:

(multiple changes)

Help/Action/ShowStatusReport

@@ -2 +2 @@
 = Help > Show Status Report =
 
-[[Image(source:trunk/images/clock.png)]]
+[[JOSMImage(clock,link=,48)]]
 
-Displays the status report with useful information mainly for developers.
+Displays the status report with useful information for troubleshooting and development.
 
-The first parts have to be included in a bug report. Please, use the button [[Image(source:trunk/images/bug.png,middle)]] '''Report bug''' at the bottom to create a [/newticket new ticket] with pre filled information.
+Tip: starting with JOSM r17637, a status report can also be obtained from the [wikitr:/Help/CommandLineOptions command line] using `--status-report`
 
-**Note**: The status report includes private user information.
+**To report an error in JOSM or to request a new feature please use ''always'' the [wikitr:/Help/Action/ReportBug Report bug] form.** \\
+It can be invoked in the Help menu or with the [[JOSMImage(bug)]] button in this dialog. This includes all needed technical information in the ticket. Bug reports and feature request are called ''tickets'' in JOSM.
 
-The first two blocks and the block "Plugins:" and the block "Last errors/warnings:" contain safe information, which are of interest in bug reports. The last block contains your private settings. When you use the [[Image(source:trunk/images/bug.png,middle)]] '''Report bug''' button it automatically removes the last block for the bug report ticket.
+The status report consists of the following sections:
+[[Image(StatusReport.png​,45%,right,margin-left=10,margin-top=20)]]
+
+||= Section =||= Description =||= Status Report \\ Presence =||= Bug Report \\ Presence =||= **Required in a \\ bug report** =||
+|| [#a1Release 1 Release] || JOSM version details ||  Always  ||  Always  ||  Yes  ||
+|| [#a2System 2 System] || Operating system, Java, memory usage, screen size and [wikitr:/Help/CommandLineOptions command line options] ||  Always  ||  Always  ||  Yes  ||
+|| [#a3DatasetCons 3 Dataset consistency] || Consistency of the [wikitr:/Help/Menu/OSMLayer current data layer] ||  If available  ||  If available  ||  Yes, if available  ||
+|| 4 Plugins || Installed [wikitr:/Plugins Plugins] ||  If available  ||  If available  ||  Yes, if available  ||
+|| 5 Tagging presets || Installed [wikitr:/Presets Presets] ||  If available  ||  If available  ||  Yes, if available  ||
+|| 6 Map paint styles || Installed [wikitr:/Styles Styles] ||  If available  ||  If available  ||  Yes, if available  ||
+|| 7 Validator Rules || Installed [wikitr:/Rules Rules] ||  If available  ||  If available  ||  Yes, if available  ||
+|| [#a8LastErrorsWarnings 8 Last errors/warnings] || Overview of last shown or hidden code errors/warnings of JOSM ||  If available  ||  If available  ||  Yes, if available  ||
+|| [#a9CrashStack 9 Crash & Stack] || Detailed info about the last JOSM code error ||  No  ||  If available  ||  Yes, if available  ||
+|| [#a10Threads 10 Threads] || All stack traces ||  No  ||  Optional  ||  Optional  ||
+|| [#a11Preferences 11 Preferences] || Current settings ||  Always  ||  No  ||  **No**  ||
+
+**Note**:
+* The sections are not numbered in the report. 
+* Some may be empty.
+* Section 4–8 each add a title to their paragraph and each line of the paragraph starts with plus `+` or minus `-`.
+* Section 9–10 add a title to their paragraphs
+
+== 1 Release == #a1Release
+
+**Example**:
+{{{
+Relative:URL: ^/trunk
+Repository:UUID: 0c6e7542-c601-0410-84e7-c038aed88b3b
+Last:Changed Date: 2020-07-30 12:44:04 +0200 (Thu, 30 Jul 2020)
+Revision:16812
+Build-Date:2020-07-31 01:30:49
+URL:https://josm.openstreetmap.de/svn/trunk
+}}}
+
+== 2 System == #a2System
+ Memory Usage:: The first value is the size of the total memory currently used by the Java Virtual Machine (JVM) including  JOSM and garbage. The second value is the max. memory the JVM will try to use, a limit can be the -Xmx option. At last, the third value is the free memory in the JVM.
+
+**Example**:
+{{{
+Identification: JOSM/1.5 (16812 en) Linux Arch Linux
+Memory Usage: 387 MB / 3844 MB (191 MB allocated, but free)
+Java version: 11.0.8+10, N/A, OpenJDK 64-Bit Server VM
+Look and Feel: javax.swing.plaf.metal.MetalLookAndFeel
+Screen: :0.0 3840x2160 (scaling 1.0x1.0)
+Maximum Screen Size: 3840x2160
+Best cursor sizes: 16x16 -> 16x16, 32x32 -> 32x32
+VM arguments: [-Djosm.home=<josm.pref>]
+}}}
+
+== 3 Dataset consistency == #a3DatasetCons
+Only one line without separation to the System paragraph.
+
+**Example**:
+{{{
+Dataset consistency test: No problems found
+}}}
+
+== 8 Last errors/warnings  == #a8LastErrorsWarnings
+
+**Example**:
+{{{
+Last errors/warnings:
+- E: java.nio.file.NoSuchFileException: ${HOME}/b.osm
+- E: Error - <html>Could not read file 'b.osm'.<br>Error is:<br>${HOME}/b.osm</html>
+}}}
+
+== 9 Crash & Stack == #a9CrashStack
+Only present after an error in the Report Bug dialog.
+
+== 10 Threads == #a10Threads
+Full stack traces of all running threads. Optionally available through check box in Report Bug dialog.
+
+== 11 Preferences == #a11Preferences
+**Not needed in tickets**
+
+To protect sensitive data this keys are stripped: `username`, `password`, `access-token`, `file-open.history`, `download.overpass.query` and `download.overpass.queries`.
 
 ----
-Back to [wiki:Menu/Help Menu Help][[Br]]
-Back to [wiki:/Help Main Help]
+Back to [wikitr:/Help/Menu/Help Help menu] \\
+Back to [wikitr:/Help/Menu Main menu] \\
+Back to [wikitr:/Help Main Help]