repo: rename RELEASENOTES to CHANGELOG

RELEASENOTES.md → CHANGELOG.md

@@ -1,4 +1,10 @@
-This the fourth major release of the GreatFET software and firmware stacks. As usual, this release contains firmware images in `firmware-bin`, host software in `host-packages`, and a copy of all sources necessary to build the entire codebase.
+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.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--
+## [Unreleased]
+-->
 
 ## Upgrading to this release
 
@@ -13,21 +19,33 @@ After upgrading the host tools, update your GreatFET firmware to the latest rele
 Happy hacking!
 
 
-# Changelog
+## v2024.0.2
+### Fixed
+* The GreatFET shell was unable to access globals inside user defined functions.
+* Import errors on some Python distributions.
+### Changed
+* Updated pyfwup dependency to `0.5.2`
+* Updated libgreat dependency to [`v2024.0.2`](https://github.com/greatscottgadgets/libgreat/compare/v2024.0.1...v2024.0.2)
+### Added
+* Windows support for Cynthion.
 
 
-## v2024.0.0
+## v2024.0.1
+### Added
+* Add IPython to the GreatFET installation by default.
+### Changed
+* Updated udev rules to use uaccess tag rather than the plugdev group.
+* Updated the rad1o board file (tx @dos1!)
 
-### GreatFET
 
+## v2024.0.0
+### GreatFET
 * [gpio: add support for configuring all gpio pin modes](https://github.com/greatscottgadgets/greatfet/pull/418)
 * [uart: fix python KeyError when parity argument not specified](https://github.com/greatscottgadgets/greatfet/pull/375)
 * [shell: support versions of IPython >= 3.11](https://github.com/greatscottgadgets/greatfet/pull/414)
 * [facedancer: fix usb mass storage example](https://github.com/greatscottgadgets/greatfet/pull/425)
 * [shell: fix runtime errors when using uart functionality](https://github.com/greatscottgadgets/greatfet/pull/426)
-
 ### libgreat
-
 * [Added TX & RX pin definitions for UART1, USART2&3](https://github.com/greatscottgadgets/libgreat/pull/25)
 * [Implement NXP's recommended PLL setup sequence](https://github.com/greatscottgadgets/libgreat/pull/30)
 * [Add support for configuring all gpio pin modes](https://github.com/greatscottgadgets/libgreat/pull/35)
@@ -53,3 +71,10 @@ NOTE: We no longer support Python 2. This release targets Python 3.6+.
 ### Major bugfixes:
 
  - #344: Facedancer with bMaxPacketSize0 < 32 does not work.
+
+
+[Unreleased]: https://github.com/greatscottgadgets/libgreat/compare/v2024.0.2...HEAD
+[v2024.0.2]: https://github.com/greatscottgadgets/libgreat/compare/v2024.0.1...v2024.0.2
+[v2024.0.1]: https://github.com/greatscottgadgets/libgreat/compare/v2024.0.0...v2024.0.1
+[v2024.0.0]: https://github.com/greatscottgadgets/libgreat/compare/v2021.2.1...v2024.0.0
+[v2021.2.1]: https://github.com/greatscottgadgets/libgreat/releases/tag/v2021.2.1

Makefile

@@ -7,7 +7,7 @@
 SHELL := /bin/bash
 
 # By default, use the system's "python" binary.
-PYTHON ?= python
+PYTHON ?= python
 PYTHON2 ?= python2
 PYTHON3 ?= python3
 
@@ -18,12 +18,12 @@ CMAKE ?= cmake
 BUILD_NUMBER ?= $(TRAVIS_BUILD_NUMBER)
 
 # Used only for deploying nightlies -- only DEPLOY_COMMAND is used in the text below.
-DEPLOY_USER  ?= deploy
-DEPLOY_PATH  ?= ~/nightlies/greatfet
+DEPLOY_USER  ?= deploy
+DEPLOY_PATH  ?= ~/nightlies/greatfet
 DEPLOY_COMMAND ?= scp -q -r * $(DEPLOY_USER)@$(DEPLOY_SERVER):$(DEPLOY_PATH)
 
 # By default, if RELEASE_VERSION is set, use it as our version.
-VERSION  ?= $(RELEASE_VERSION)
+VERSION  ?= $(RELEASE_VERSION)
 
 # Allow for easy specification of a version suffix, if desired.
 ifdef VERSION_SUFFIX
@@ -48,7 +48,7 @@ ARCHIVE_FLAGS = \
 # If we have a release version, also include the version file.
 #
 ifdef RELEASE_VERSION
-ARCHIVE_FLAGS += --extra=VERSION 
+ARCHIVE_FLAGS += --extra=VERSION
 endif
 
 
@@ -62,8 +62,8 @@ endif
 ifdef RELEASE_VERSION
  @# Tag a version before we complete this build, if requested.
  @echo Tagging release $(VERSION).
- @git tag -a v$(VERSION) -m "release $(VERSION)" $(TAG_OPTIONS)
- @git -C libgreat tag -a v$(VERSION) -m "release $(VERSION)" $(TAG_OPTIONS)
+ @git tag -a v$(VERSION) -m "release $(VERSION)" -s $(TAG_OPTIONS)
+ @git -C libgreat tag -a v$(VERSION) -m "release $(VERSION)" -s $(TAG_OPTIONS)
  @echo "$(VERSION)" > VERSION
  @echo "$(VERSION)" > libgreat/VERSION
 endif
@@ -124,7 +124,7 @@ libgreat/README.md:
 
 
 #
-# Prepares a GreatFET release based on the VERSION arguments and based on a RELEASENOTES.md file.
+# Prepares a GreatFET release based on the VERSION arguments and based on a CHANGELOG.md file.
 #
 prepare_release_files: firmware
  @mkdir -p release-files/
@@ -140,7 +140,7 @@ endif
  @mkdir -p host-packages
  @mkdir -p build
 
- @#Create our python pacakges. 
+ @#Create our python pacakges.
  @pushd libgreat/host; $(PYTHON3) setup.py bdist_wheel -d $(CURDIR)/host-packages; popd
  @pushd host; $(PYTHON3) setup.py bdist_wheel -d $(CURDIR)/host-packages; popd
 
@@ -179,7 +179,7 @@ prepare_release_archives: prepare_release_files
 #
 # prepare_release generates the actual release, and then prints instructions.
 #
-prepare_release: RELEASENOTES.md prepare_release_archives
+prepare_release: CHANGELOG.md prepare_release_archives
 
  @# If no tag was supplied, warn the user.
 ifndef RELEASE_VERSION
@@ -189,11 +189,11 @@ endif
  @echo
  @echo Archives seem to be ready in ./release-files.
  @echo If everything seems okay, you probably should push the relevant tag:
- @echo "  git push origin v$(VERSION)"
- @echo "  git -C libgreat push origin v$(VERSION)"
+ @echo "  git push origin v$(VERSION)"
+ @echo "  git -C libgreat push origin v$(VERSION)"
  @echo
  @echo And push the relevant packages to Pypi:
- @echo "  python3 -m twine upload host-packages/*"
+ @echo "  python3 -m twine upload host-packages/*"
 
 
 #