Subversion Repositories w11

.\"  -*- nroff -*-
.\"  $Id: isemsg_filter.1 550 2014-02-03 08:16:57Z mueller $
.\"
.\" Copyright 2014- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" 
.\" ------------------------------------------------------------------
.TH ISEMSG_FILTER 1 2014-01-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
isemsg_filter \- message filter for Xilinx ISE tool chain log files
.\" ------------------------------------------------------------------
.SH SYNOPSIS
.
.SY isemsg_filter
.OP \-\-pack
.I TYPE
.I MFSET
.I LOGFILE
.
.SY isemsg_filter
.B \-\-help
.YS
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
.\" ----------------------------------------------
Scans the log file \fILOGFILE\fP generated by Xilinx ISE tool specified 
by \fITYPE\fP for informational, warning and error messages and compares 
these messages against a set of message filter rules defined in the
\fIMFSET\fP file.
isemsg_filter will print all no-matching messages.
All filter rules which do not match a message are also listed, these
messages are considered missing.
Matched messages are considered accepted. 
In normal operation they will not create output.
isemsg_filter is useful for example in \fBmake\fP(1) based flows to 
create a short summary from the log files.

The accepted values for \fITYPE\fP are:

.RS 3
.PD 0
.IP \fBxst\fP 6
ISE xst
.IP \fBtra\fP
ISE ngdbuild (translate)
.IP \fBmap\fP
ISE map
.IP \fBpar\fP
ISE par
.IP \fBtwr\fP
ISE trce
.IP \fBbgn\fP
ISE bitgen
.PD
.RE
.
.\" ------------------------------------------------------------------
.SH OPTIONS
.\" ----------------------------------------------
.IP \fB\-\-pacc\fP
Print a summary of all accepted messages. The match count for each rule is 
listed.
.
.\" ----------------------------------------------
.IP \fB\-\-help\fP
print full help.
.
.\" ------------------------------------------------------------------
.SH MESSAGE FILTER FILE FORMAT
.\" ----------------------------------------------
Simply a list of regular expression patters structured by section headers 
of the form "[TYPE]". 
Blank lines and lines starting with '#' will be ignored.
isemsg_filter will extract the patters of the section matching the
\fITYPE\fP argument.
.SS Example message filter file
.EX
  # ---------
  [xst]
  INFO:.*The FF/Latch <.*> is equivalent to .* will be removed
  Node <HIO/IOB_BTN/R_DI_[1-4]> of sequential type is unconnected
  # ---------
  [map]
  INFO:.*The FF/Latch <.*>.*is equivalent to the following FF/Latch
.EE
.\" ------------------------------------------------------------------
.SH EXIT STATUS
If \fITYPE\fP is invalid or the \fIMFSET\fP or \fILOGFILE\fP files
can't be opend an exit status 1 is returned.

.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBisemsg_filter xst proj.mfset proj_xst.log\fR" 4
Generate a short summary of a ISE xst log file.
.
.\" ------------------------------------------------------------------
.SH "BUGS"
The \fIMFSET\fP file is flat, no structuring possible, e.g. with includes.
It be great to have for example default rules for each target device.
Since ISE is 'end-of-life' no further work on isemsg_filter will be done.
.
.\" ------------------------------------------------------------------
.SH "SEE ALSO"
.
.\" ------------------------------------------------------------------
.SH AUTHOR
Walter F.J. Mueller <W.F.J.Mueller@gsi.de>