| 1 |
22 |
wfjm |
.\" -*- nroff -*-
|
| 2 |
|
|
.\" $Id: isemsg_filter.1 550 2014-02-03 08:16:57Z mueller $
|
| 3 |
|
|
.\"
|
| 4 |
|
|
.\" Copyright 2014- by Walter F.J. Mueller
|
| 5 |
|
|
.\"
|
| 6 |
|
|
.\" ------------------------------------------------------------------
|
| 7 |
|
|
.TH ISEMSG_FILTER 1 2014-01-02 "Retro Project" "Retro Project Manual"
|
| 8 |
|
|
.\" ------------------------------------------------------------------
|
| 9 |
|
|
.SH NAME
|
| 10 |
|
|
isemsg_filter \- message filter for Xilinx ISE tool chain log files
|
| 11 |
|
|
.\" ------------------------------------------------------------------
|
| 12 |
|
|
.SH SYNOPSIS
|
| 13 |
|
|
.
|
| 14 |
|
|
.SY isemsg_filter
|
| 15 |
|
|
.OP \-\-pack
|
| 16 |
|
|
.I TYPE
|
| 17 |
|
|
.I MFSET
|
| 18 |
|
|
.I LOGFILE
|
| 19 |
|
|
.
|
| 20 |
|
|
.SY isemsg_filter
|
| 21 |
|
|
.B \-\-help
|
| 22 |
|
|
.YS
|
| 23 |
|
|
.
|
| 24 |
|
|
.\" ------------------------------------------------------------------
|
| 25 |
|
|
.SH DESCRIPTION
|
| 26 |
|
|
.\" ----------------------------------------------
|
| 27 |
|
|
Scans the log file \fILOGFILE\fP generated by Xilinx ISE tool specified
|
| 28 |
|
|
by \fITYPE\fP for informational, warning and error messages and compares
|
| 29 |
|
|
these messages against a set of message filter rules defined in the
|
| 30 |
|
|
\fIMFSET\fP file.
|
| 31 |
|
|
isemsg_filter will print all no-matching messages.
|
| 32 |
|
|
All filter rules which do not match a message are also listed, these
|
| 33 |
|
|
messages are considered missing.
|
| 34 |
|
|
Matched messages are considered accepted.
|
| 35 |
|
|
In normal operation they will not create output.
|
| 36 |
|
|
isemsg_filter is useful for example in \fBmake\fP(1) based flows to
|
| 37 |
|
|
create a short summary from the log files.
|
| 38 |
|
|
|
| 39 |
|
|
The accepted values for \fITYPE\fP are:
|
| 40 |
|
|
|
| 41 |
|
|
.RS 3
|
| 42 |
|
|
.PD 0
|
| 43 |
|
|
.IP \fBxst\fP 6
|
| 44 |
|
|
ISE xst
|
| 45 |
|
|
.IP \fBtra\fP
|
| 46 |
|
|
ISE ngdbuild (translate)
|
| 47 |
|
|
.IP \fBmap\fP
|
| 48 |
|
|
ISE map
|
| 49 |
|
|
.IP \fBpar\fP
|
| 50 |
|
|
ISE par
|
| 51 |
|
|
.IP \fBtwr\fP
|
| 52 |
|
|
ISE trce
|
| 53 |
|
|
.IP \fBbgn\fP
|
| 54 |
|
|
ISE bitgen
|
| 55 |
|
|
.PD
|
| 56 |
|
|
.RE
|
| 57 |
|
|
.
|
| 58 |
|
|
.\" ------------------------------------------------------------------
|
| 59 |
|
|
.SH OPTIONS
|
| 60 |
|
|
.\" ----------------------------------------------
|
| 61 |
|
|
.IP \fB\-\-pacc\fP
|
| 62 |
|
|
Print a summary of all accepted messages. The match count for each rule is
|
| 63 |
|
|
listed.
|
| 64 |
|
|
.
|
| 65 |
|
|
.\" ----------------------------------------------
|
| 66 |
|
|
.IP \fB\-\-help\fP
|
| 67 |
|
|
print full help.
|
| 68 |
|
|
.
|
| 69 |
|
|
.\" ------------------------------------------------------------------
|
| 70 |
|
|
.SH MESSAGE FILTER FILE FORMAT
|
| 71 |
|
|
.\" ----------------------------------------------
|
| 72 |
|
|
Simply a list of regular expression patters structured by section headers
|
| 73 |
|
|
of the form "[TYPE]".
|
| 74 |
|
|
Blank lines and lines starting with '#' will be ignored.
|
| 75 |
|
|
isemsg_filter will extract the patters of the section matching the
|
| 76 |
|
|
\fITYPE\fP argument.
|
| 77 |
|
|
.SS Example message filter file
|
| 78 |
|
|
.EX
|
| 79 |
|
|
# ---------
|
| 80 |
|
|
[xst]
|
| 81 |
|
|
INFO:.*The FF/Latch <.*> is equivalent to .* will be removed
|
| 82 |
|
|
Node of sequential type is unconnected
|
| 83 |
|
|
# ---------
|
| 84 |
|
|
[map]
|
| 85 |
|
|
INFO:.*The FF/Latch <.*>.*is equivalent to the following FF/Latch
|
| 86 |
|
|
.EE
|
| 87 |
|
|
.\" ------------------------------------------------------------------
|
| 88 |
|
|
.SH EXIT STATUS
|
| 89 |
|
|
If \fITYPE\fP is invalid or the \fIMFSET\fP or \fILOGFILE\fP files
|
| 90 |
|
|
can't be opend an exit status 1 is returned.
|
| 91 |
|
|
|
| 92 |
|
|
.\" ------------------------------------------------------------------
|
| 93 |
|
|
.SH EXAMPLES
|
| 94 |
|
|
.IP "\fBisemsg_filter xst proj.mfset proj_xst.log\fR" 4
|
| 95 |
|
|
Generate a short summary of a ISE xst log file.
|
| 96 |
|
|
.
|
| 97 |
|
|
.\" ------------------------------------------------------------------
|
| 98 |
|
|
.SH "BUGS"
|
| 99 |
|
|
The \fIMFSET\fP file is flat, no structuring possible, e.g. with includes.
|
| 100 |
|
|
It be great to have for example default rules for each target device.
|
| 101 |
|
|
Since ISE is 'end-of-life' no further work on isemsg_filter will be done.
|
| 102 |
|
|
.
|
| 103 |
|
|
.\" ------------------------------------------------------------------
|
| 104 |
|
|
.SH "SEE ALSO"
|
| 105 |
|
|
.
|
| 106 |
|
|
.\" ------------------------------------------------------------------
|
| 107 |
|
|
.SH AUTHOR
|
| 108 |
|
|
Walter F.J. Mueller
|
