next up previous contents index
Next: Log Files Up: Xic Configuration and Startup Previous: Initial Operations   Contents   Index

Log Files and Error Reporting

There are several methods by which error and warning messages are presented to the user. In many commands, particularly those that use input from the prompt line, the prompt line is used to print messages informing the user of incorrect input, and general command status. These messages are intended to direct the user toward correct usage of the command.

More serious errors are reported in a pop-up window. There are two types of messages: those that are logged, and those that aren't. If a message is logged, it is assigned a unique sequence number, and is saved in the xic_error.log file discussed below.

The same pop-up window is generally used for both types of message. Most error and warning messages are logged. A few messages are unlogged, these generally report an immediate command failure due to some condition such as lack of a current cell, or something such as a help keyword not found message which is probably not worth logging.

The text window presenting an unlogged message will contain only that message. One of the disadvantages of unlogged messages is if several are emitted, only the most recent is shown in the window, the others are lost. This is unlikely to happen in current Xic releases.

The text window will display the sequence number and text of an emitted logged message, and some number (currently hard-coded as 20) of the previously emitted messages. One can scroll through the list to find previously emitted messages, which unlike in the unlogged case still exist.

The error message window contains two buttons in addition to the Dismiss button.

Save Text
This allows the user to save the text shown in the pop-up to a file. This may be useful for documenting errors seen for bug reporting, and for other purposes.

Show Error Log
This button will bring up a file browser window loaded with the xic_error.log file. This allows the user to browse all errors, in sequence. This can be used to revisit old errors that have scrolled off the end of the list in the pop-up error window.



Subsections
next up previous contents index
Next: Log Files Up: Xic Configuration and Startup Previous: Initial Operations   Contents   Index
Stephen R. Whiteley 2017-10-02