cppcheck/tools/triage/readme.txt

triage tool
This tool lets you comfortably look at Cppcheck analysis results for daca packages. It automatically
downloads the package, extracts it and jumps to the corresponding source code for a Cppcheck
message.

triage uses "wget" and "tar"
On Linux the tool can be directly run since the programs should be installed.
On Windows something like Cygwin is necessary and the directory containing the executables must be
in the PATH environment variable (for example "C:\cygwin\bin").

Usage:
After triage has been started you have to load a daca results file via the "Load" button.
The file must contain the package URL line beginning with "ftp://" and the Cppcheck messages.
When the results file has been parsed successfully you can see a list of Cppcheck messages directly
beneath the "Load" button. Double-click any entry to let the tool show the source code and jump to
and mark the corresponding line. If the package is not found it is downloaded and extracted
automatically. So after the first double-click it is normal that it takes some time until the
source code is shown.
triage: Fix warnings and Windows issues; some enhancements (#1591) Changes: - Fixed compiler warnings - Add "." to file open menu so files without suffix can be opened - Make it work under Windows - Make wget() and unpackArchive() methods so they can access the UI - wget() and unpackArchive() use the new method runProcess() now that also does some error handling - Errors are shown in the status bar for easier debugging / usage - Add readme.txt - Let travis build the triage tool 2019-01-12 09:16:43 +01:00			`triage tool`
			`This tool lets you comfortably look at Cppcheck analysis results for daca packages. It automatically`
			`downloads the package, extracts it and jumps to the corresponding source code for a Cppcheck`
			`message.`

			`triage uses "wget" and "tar"`
			`On Linux the tool can be directly run since the programs should be installed.`
			`On Windows something like Cygwin is necessary and the directory containing the executables must be`
			`in the PATH environment variable (for example "C:\cygwin\bin").`

			`Usage:`
			`After triage has been started you have to load a daca results file via the "Load" button.`
			`The file must contain the package URL line beginning with "ftp://" and the Cppcheck messages.`
			`When the results file has been parsed successfully you can see a list of Cppcheck messages directly`
			`beneath the "Load" button. Double-click any entry to let the tool show the source code and jump to`
			`and mark the corresponding line. If the package is not found it is downloaded and extracted`
			`automatically. So after the first double-click it is normal that it takes some time until the`
			`source code is shown.`