Merge branch '9-release_v1.1.0' into 'master'

Resolve "Make 1.1.0 release"

Closes #9

See merge request be-cem-edl/chronos/wrtd!6

.gitlab-ci.yml

+# SPDX-License-Identifier: LGPL-2.1-or-later
+#
+# SPDX-FileCopyrightText: 2023 CERN
+
+variables:
+  GIT_SUBMODULE_STRATEGY: normal
+  EDL_CI_DOC_SRC_PATH: 'doc'
+  EDL_CI_DOC_DST_PATH: '$EDL_CI_EOS_OUTPUT_DIR'
+
+include:
+  - project: 'be-cem-edl/evergreen/gitlab-ci'
+    ref: master
+    file:
+      - 'edl-gitlab-ci.yml'
+
+build-centos-7:
+  interruptible: true
+  stage: build
+  image:
+    name: gitlab-registry.cern.ch/be-cem-edl/evergreen/gitlab-ci/build-fec-sw:latest
+  script:
+    - make -C software
+  artifacts:
+    paths:
+      - include/
+      - software/lib/

CHANGELOG.md

@@ -10,13 +10,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.1.0] - 2023-01-16
 ### Added
-- udev rules for proper node initialisation
+- sw: wrtd_tool.py: add a cli command
+### Removed
+- sw: hdl_gen_tool removed, was never finished/ready for use
 ### Changed
-- Better python packaging, including wrtd-tool
+- All reference designs have been moved to a separate repository, this project now
+  only contains the WRTD core
+- Updated MockTurtle to v4.1.0
+- sw: Better python packaging, including wrtd-tool
+- sw: Implemented reset argument in wrtd_init()
 ### Fixed
-- Building of drivers in newer (post 4.19) Linux kernels
+- fw: rule stats are kept when a rule is moved
+- sw: bug for channels with more than one digit (e.g. LC-I11)
+- sw: auto-wrap ns timestamp at 1e9
+- sw: provide WRTD_ERR_MSG_BUF_SIZE to avoid hard-coding max err message buffer size
+- sw: bug in remove_all_rules causing crashes
+- sw: rules can no longer be enabled if source/destination id is invalid
 
 ## [1.0.1] - 2021-02-10
 ### Fixed
@@ -25,6 +36,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0] - 2019-10-01
 ### Added
 - First release of WRTD.
-
-[Unreleased]: https://www.ohwr.org/project/wrtd/compare/v1.0.0...proposed_master
-[1.0.0]: https://www.ohwr.org/project/wrtd/tags/v1.0.0

README.md

@@ -17,6 +17,8 @@ For more information, please refer to:
 
 ## Licensing
 
-As defined in https://be-cem-edl.web.cern.ch/procedures
+* HDL simulations released under `CERN-OHL-W-2.0`
+* All software released under `LGPL-2.1-or-later`
+* Documentation released under `CC-BY-SA-4.0+`
 
 Plain text copies of these licenses are available under the 'LICENSES' folder.

mock-turtle @ 1f399c96

-Subproject commit b2260e1d00566b02c7355ea6b373de3770dc47d7
+Subproject commit 1f399c96dafafbe124540266b4b155d051c42dec

doc/basic_concepts.rst

@@ -309,9 +309,7 @@ triggered, following the process depicted in :numref:`fig-wrtd-alarm`.
 Application
 ===========
 
-A :ref:`node` may be running one or more Applications (firmware). As an example, the
-:ref:`spec150t_ref_adc` runs a single Application (to communicate with the ADC), while the
-:ref:`svec_ref_tdc_fd` runs two Applications (one for the TDC and one for the Fine Delay generator).
+A :ref:`node` may be running one or more Applications (firmware).
 
 As such, an Application is also a :ref:`rep_cap` instance inside a :ref:`node`.
 

doc/conf.py

@@ -69,10 +69,11 @@ author = u'Dimitris Lampridis <dimitris.lampridis@cern.ch>'
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = u'1.0'
-# The full version, including alpha/beta/rc tags.
-release = u'1.0'
+import os
+import re
+
+release = os.popen('git describe --tags').read().strip()
+version = re.sub('^v', '', release.split('-')[0])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/ref_nodes.rst

@@ -7,4 +7,4 @@
 Reference Nodes
 ---------------
 
-See repository https://gitlab.cern.ch/be-cem-edl/fec/hardware-modules/wrtd-reference-designs for some reference designs.
+See repository https://ohwr.org/project/wrtd-ref-designs/ for some reference designs.

doc/requirements.txt

@@ -2,9 +2,7 @@
 #
 # SPDX-License-Identifier: CC-BY-SA-4.0+
 
-docutils==0.17.1
-Sphinx==5.1.1
-sphinx_rtd_theme==1.0.0
-breathe==4.34.0
-recommonmark==0.7.1
-decorator==5.1.1
+sphinx
+sphinx_rtd_theme
+breathe
+decorator