1
0
mirror of https://github.com/wfjm/w11.git synced 2026-01-12 00:43:01 +00:00

GitHub actions: disable-at-0 fix; man page cosmetics

- the CI/CD workflow did not defined the TBW_GHDL_OPTS environment variable,
  as consequence VHDL IEEE package warnings at t=0ms were not suppressed and
  polluted the log files
- that problem was already in .travis.yml and was carried over to ci.yml
- now fixed, and log files are not cluttered anymore with essentially
  unavoidable but harmless warnings at t=0ms.
This commit is contained in:
wfjm 2022-05-07 08:36:23 +02:00
parent d1d95504df
commit 66f3f5d085
28 changed files with 81 additions and 63 deletions

View File

@ -1,4 +1,4 @@
# $Id: ci.yml 1231 2022-04-28 08:40:50Z mueller $
# $Id: ci.yml 1234 2022-05-03 18:28:48Z mueller $
# SPDX-License-Identifier: GPL-3.0-or-later
# Copyright 2022- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
@ -59,6 +59,7 @@ jobs:
export RETROBASE=$PWD
export PATH=$PATH:$RETROBASE/tools/bin:.
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$RETROBASE/tools/lib
export TBW_GHDL_OPTS="--unbuffered --ieee-asserts=disable-at-0"
tbrun -j 2 -nomake \
-tag memlib \
-tag genlib \

View File

@ -30,6 +30,7 @@ The full set of tests is only run for tagged releases.
### New features
### Changes
- tools changes
- ci.yml: define TBW_GHDL_OPTS and suppress IEEE package warnings at t=0ms
- **/tbrun.yml: since nexys4 not longer available switch to nexys4d
### Bug Fixes

View File

@ -236,11 +236,13 @@ the FPGA. For detailed documentation see the respective man pages.
### <a id="artix">Note on Artix-7 based designs</a>
The development for Nexys4 started in 2013 with ISE but moved to Vivado when
it matured in 2015. The make files for the ISE build flows have been kept for
comparison are have the name `Makefile.ise`. So for some Nexys4 designs one can
still start with a
it matured 2014. The make files for the ISE build flows have been kept for
comparison are have the name `Makefile.ise`. So for some Nexys4 designs one
can still start with a
make -f Makefile.ise <target>
make -f Makefile.ise <target>
or
makeise <target>
an ISE based build. To be used for tool comparisons, the ISE generated bit
files were never tested in an FPGA.

View File

@ -274,7 +274,7 @@ only one board must connected.
### <a id="ise">Note on ISE</a>
The development for Nexys4 started in 2013 with ISE but moved to Vivado when
it matured in 2015. The make files for the ISE build flows have been kept for
it matured in 2014. The make files for the ISE build flows have been kept for
comparison are have the name `Makefile.ise`. So for some Nexys4 designs one
can still start with a

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: asm-11_expect.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: asm-11_expect.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: config_wrapper.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: config_wrapper.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -95,8 +95,8 @@ Configure an FPGA with \fBjtag\fP(1). The input \fIFILE\fP must be in
Cypress FX2 USB controller, like the Digilent Nexys2, Nexys3 or Atlys,
and an FX2 firmware that emulates an Altera USB-Blaster programming cable.
The USB device path is defined by the environment variables RETRO_FX2_VID
and RETRO_FX2_PID, or defaults to vid=16c0 and pid=03ef.
The USB device path is defined by the environment variables \fBRETRO_FX2_VID\fP
and \fBRETRO_FX2_PID\fP, or defaults to vid=16c0 and pid=03ef.
Use the \fBfx2load_wrapper\fP(1) command to ensure that the proper firmware
is loaded in the Cypress FX2 USB controller.

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: console_starter.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: console_starter.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2014 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: create_disk.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: create_disk.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: dmscntconv.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: dmscntconv.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: file2tap.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: file2tap.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,7 +1,7 @@
.\" -*- nroff -*-
.\" $Id: fx2load_wrapper.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: fx2load_wrapper.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2013-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
@ -30,10 +30,11 @@ Checks firmware state of a Cypress FX2 USB controller and re-loads the
firmware in case of a mismatch of currently active and desired firmware.
The command locates a USB device with a USB path defined by the environment
variables RETRO_FX2_VID and RETRO_FX2_PID, or default vid=16c0 and pid=03ef.
variables \fBRETRO_FX2_VID\fP and \fBRETRO_FX2_PID\fP, or default vid=16c0 and
pid=03ef.
It inquires with \fBlsusb\fP(1) the 'iProduct' attribute of the currently
active USB descriptor. If this attribute is defined and equals the basename
of the firmware image given with \fB-\-file\fP it is assumed the proper
of the firmware image given with \fB-\-file\fP it is assumed the proper
firmware is already active. Otherwise the firmware image is loaded with
either \fBfxload\fP(1) or \fBcycfx2prog\fP.

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: github_md2html.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: github_md2html.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2017-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: njobihtm.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: njobihtm.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: ostest.1 1196 2019-07-20 18:18:16Z mueller $
.\" $Id: ostest.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2019- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -24,7 +24,7 @@ ostest \- oskit test driver
.SH DESCRIPTION
\fBostest\fP organizes the automatized testing of operating systems.
It will
.
.RS 2
.PD 0
.IP "-" 2
@ -91,8 +91,8 @@ Implementation for mode \fImode\fP.
Setup file for system \fIsys\fP.
.IP "\fI$RETROBASE/tools/oskit/test/kit/<kit>_setup.tcl\fP"
Setup file for oskit \fIkit\fP.
.IP "\fI$RETROBASE/tools/oskit/test/os/<os>/\fP"
Path for ostest environment for os \fIos\fP.
.IP "\fI$RETROBASE/tools/oskit/test/os\fP"
Path for ostest environment for os class of oskit \fIkit\fP.
.IP "\fI$RETROBASE/tools/oskit/<kit>/\fP"
Path for execution environment for oskit \fIkit\fP.

View File

@ -1,11 +1,11 @@
.\" -*- nroff -*-
.\" $Id: tbfilt.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: tbfilt.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2016-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
.TH TBFILT 1 2018-11-03 "Retro Project" "Retro Project Manual"
.TH TBFILT 1 2022-05-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
tbfilt \- filter for and analysis of test bench log files
@ -53,7 +53,7 @@ specified explicitly as arguments or determined via the \fB\-\-find\fP or
If the \fB\-\-summary\fP option is specified a one-line summary for each
test log file is displayed. The format of this summary is configurable via
the \fB\-\-format\fP, \fB\-\-wide\fP, and \fB\-\-compact\fP options and via
the \fB\TBFILT_FORMAT\fP environment variable.
the \fBTBFILT_FORMAT\fP environment variable.
The exit status of tbfilt is 1 in case any of the tests is considered as
\fBFAIL\fPed.
.
@ -77,15 +77,17 @@ indication of a \fBFAIL\fPed test:
As an exception to the general rules above the following assertion messages
are accepted:
Assertion warnings from IEEE libraries at startup (t=0) are ignored. They are
Assertion warnings from IEEE libraries at startup (t=0ns) are ignored. They are
hard to avoid in complex models and generally don't indicate a real issue.
.RS 2
.PD 0
.IP "-" 2
assertion warnings from IEEE libraries at startup (t=0). They are hard to
assertion warnings from IEEE libraries at startup (t=0ns). They are hard to
avoid in complex models and in general don't indicate a real issue. The best
is to suppress them in \fBghdl\fP(1) with the
option '--ieee-asserts=disable-at-0'.
That's usually done via the \fBTBW_GHDL_OPTS\fP environment variable used
by \fBtbw\fP(1).
.IP "-" 2
assertion failure with the text 'Simulation Finished'. It is used to end
simulations in \fBghdl\fP(1) in some test benches.
@ -277,6 +279,10 @@ at least one test FAILed, test bench has FAILed
.IP "\fBTBFILT_FORMAT\fR" 4
Defines the default summary format and overwrites the build-in default of
"%ec %pf %nf".
.IP "\fBTBW_GHDL_OPTS\fR"
Used by \fBtbw\fP(1) to define additional options for GHDL based simulations.
Usually set to "--unbuffered --ieee-asserts=disable-at-0", see \fBtbw\fP(1)
documentation.
.
.\" ------------------------------------------------------------------
.SH EXAMPLES

View File

@ -1,11 +1,11 @@
.\" -*- nroff -*-
.\" $Id: tbrun.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: tbrun.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2016-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
.TH TBRUN 1 2019-01-03 "Retro Project" "Retro Project Manual"
.TH TBRUN 1 2022-05-02 "Retro Project" "Retro Project Manual"
.\" ------------------------------------------------------------------
.SH NAME
tbrun \- test bench driver
@ -242,6 +242,13 @@ at least one test FAILed, test bench has FAILed
.RE
.
.\" ------------------------------------------------------------------
.SH ENVIRONMENT
.IP "\fBTBW_GHDL_OPTS\fR" 4
Used by \fBtbw\fP(1) to define additional options for GHDL based simulations.
Usually set to "--unbuffered --ieee-asserts=disable-at-0", see \fBtbw\fP(1)
documentation.
.
.\" ------------------------------------------------------------------
.SH EXAMPLES
.IP "\fBtbrun" 4
The simplest default case, will use the \fItbrun.yml\fP file in the current

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: tbw.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: tbw.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
@ -125,7 +125,7 @@ suppresses assertion warnings from the ieee libraries at startup time (t=0ns).
sets output at all files (stdout, stderr, and files opened for write) to
unbuffered mode. This is very helpful to keep output from the GHDL
simulation and other programs in a co-simulation environment in synch.
Note: only available for GHDL 0.34dev after merge of Jonsba/master #100 on
Note: only available for GHDL 0.34dev after merge of Jonsba/master #100 on
2016-06-26.
.RE
.

View File

@ -1,7 +1,7 @@
.\" -*- nroff -*-
.\" $Id: ti_rri.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: ti_rri.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2013-2017 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2013-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
@ -142,8 +142,8 @@ defer link initialization (debug or test benches)
open a USB via Cypress FX2 type \fBrlink\fP port. Optional arguments are
.RS
.IP \fBname\fP
USB path, default derived from environment variables RETRO_FX2_VID and
RETRO_FX2_PID.
USB path, default derived from environment variables \fBRETRO_FX2_VID\fP and
\fBRETRO_FX2_PID\fP.
.IP \fBopts\fP
comma-separated list of further cuff port options:
.RS

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: vbomconv.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: vbomconv.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_simprim.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xise_ghdl_simprim.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_ghdl_unisim.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xise_ghdl_unisim.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xise_msg_filter.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xise_msg_filter.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,7 +1,7 @@
.\" -*- nroff -*-
.\" $Id: xtwi.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xtwi.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2014-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
@ -18,21 +18,21 @@ xtwi \- Xilinx Tool Wrapper script for ISE
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
The Xilinx ISE setup script redefines PATH and LD_LIBRARY_PATH. The ISE
tools run fine in this environment, but other installed programs on the
system can (and actually do) fail. \fBxtwi\fP helps to keep the ISE
The Xilinx ISE setup script redefines \fBPATH\fP and \fBLD_LIBRARY_PATH\fP.
The ISE tools run fine in this environment, but other installed programs on
the system can (and actually do) fail. \fBxtwi\fP helps to keep the ISE
environment separate from the normal working environment.
The environment variable XTWI_PATH must be set up to the install path
The environment variable \fBXTWI_PATH\fP must be set up to the install path
of the ISE version to be used. Without the /ISE_DS/ which is added
by the ISE installation procedure.
\fBxtwi\fP uses XTWI_PATH to locate the ISE setup script, sources it,
\fBxtwi\fP uses \fBXTWI_PATH\fP to locate the ISE setup script, sources it,
and execs the \fICOMMAND\fP. This way \fICOMMAND\fP is executed in the
ISE environment, while the login shell stays clean.
\fBxtwi\fP can also set up a clean environment when BARE_PATH and
BARE_LD_LIBRARY_PATH are defined.
\fBxtwi\fP can also set up a clean environment when \fBBARE_PATH\fP and
\fBBARE_LD_LIBRARY_PATH\fP are defined.
.
.\" ------------------------------------------------------------------

View File

@ -1,7 +1,7 @@
.\" -*- nroff -*-
.\" $Id: xtwv.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xtwv.1 1234 2022-05-03 18:28:48Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2014-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\" Copyright 2014-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"
.\" ------------------------------------------------------------------
.
@ -18,20 +18,20 @@ xtwv \- Xilinx Tool Wrapper script for Vivado
.
.\" ------------------------------------------------------------------
.SH DESCRIPTION
The Xilinx Vivado setup script redefines PATH and LD_LIBRARY_PATH.
The Xilinx Vivado setup script redefines \fBPATH\fP and \fBLD_LIBRARY_PATH\fP.
The Vivado tools run fine in this environment, but other installed programs
on the system might fail. \fBxtwv\fP helps to keep the Vivado environment
separate from the normal working environment.
The environment variable XTWV_PATH must be set up to the install path
The environment variable \fBXTWV_PATH\fP must be set up to the install path
of the Vivado version to be used.
\fBxtwv\fP uses XTWV_PATH to locate the Vivado setup script, sources it,
\fBxtwv\fP uses \fBXTWV_PATH\fP to locate the Vivado setup script, sources it,
and execs the \fICOMMAND\fP. This way \fICOMMAND\fP is executed in the
Vivado environment, while the login shell stays clean.
\fBxtwi\fP can also set up a clean environment when BARE_PATH and
BARE_LD_LIBRARY_PATH are defined.
\fBxtwi\fP can also set up a clean environment when \fBBARE_PATH\fP and
\fBBARE_LD_LIBRARY_PATH\fP are defined.
.
.\" ------------------------------------------------------------------

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_ghdl_unisim.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xviv_ghdl_unisim.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2015-2016 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_msg_filter.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xviv_msg_filter.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: xviv_sim_vhdl_cleanup.1 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: xviv_sim_vhdl_cleanup.1 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2016- by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"

View File

@ -1,5 +1,5 @@
.\" -*- nroff -*-
.\" $Id: vbom.5 1231 2022-04-28 08:40:50Z mueller $
.\" $Id: vbom.5 1233 2022-04-30 07:01:23Z mueller $
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\" Copyright 2010-2018 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
.\"