From 297df1090fa632b60b6d3afdd1ae2f10e5c262b7 Mon Sep 17 00:00:00 2001
From: Bengt Martensson <barf@bengt-martensson.de>
Date: Fri, 27 Dec 2024 20:26:44 +0100
Subject: [PATCH] Doc update, in preparation for release 1.2.14.

---
 README.md                                       | 13 +++++++++----
 src/main/doc/Checklist.txt                      |  2 ++
 src/main/doc/IrpTransmogrifier.releasenotes.txt | 15 +++++++++++++++
 3 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 174944f2..e022a902 100644
--- a/README.md
+++ b/README.md
@@ -85,10 +85,11 @@ target-specific parameters to the code generators using the `--parameter` (`-p`)
 
 Targets:
 * [Lircd.conf](http://lirc.org/html/lircd.conf.html) generation from IrScrutinizer. This is based on an XSLT-transformation (`lirc.xsd`) and generates
- [an XSLT (version 1) file that can work with IrScrutinizer](https://github.com/bengtmartensson/harctoolboxbundle/blob/master/IrScrutinizer/src/main/config/exportformats.d/lirc.xml).
+ [an XSLT (version 1) file that can work with IrScrutinizer](https://github.com/bengtmartensson/IrScrutinizer/blob/master/src/main/config/exportformats.d/lirc.xml).
 Handling of definitions as well as expressions as bitfields not implemented, as well as a few other things (search for "omitted" in the above file),
 otherwise works. "90% complete", see [this issue](https://github.com/bengtmartensson/IrpTransmogrifier/issues/6).
-To create: see (or execute) the shell script `tools/generate-lirc.sh`. In short, this generates the xml export, and then invokes
+To create: see the project [IrProtocolGeneration](https://github.com/bengtmartensson/IrProtocolCodeGeneration).
+In short, this generates the xml export, and then invokes
 xslt transformations on that xml file.
 * Java. Essentially for testing. This is essentially working both for rendering and decoding, including a generated test rig
 (see the [test project](https://github.com/bengtmartensson/JavaIrpProtocolTest)). Targets: `java-decoder java-decoder-test java-renderer java-renderer-test`.
@@ -517,7 +518,9 @@ Usage: IrpTransmogrifier [options] [command] [command options]
             Default: false
           -f, --frequency
             Set modulation frequency.
-          -g, --girr
+          -G, --girrinput
+            Read raw input in Girr format.
+          -g, --girroutput
             Generate output in Girr format (only)
             Default: false
           -h, -?, --help
@@ -603,7 +606,9 @@ Usage: IrpTransmogrifier [options] [command] [command options]
             Default: false
           -f, --frequency
             Modulation frequency of raw signal.
-          -g, --girr
+          -G, --girrinput
+            Read raw input in Girr format.
+          -g, --girroutput
             Generate Girr file. Inhibits all other output.
             Default: false
           -h, -?, --help
diff --git a/src/main/doc/Checklist.txt b/src/main/doc/Checklist.txt
index acdf0e07..a685db26 100644
--- a/src/main/doc/Checklist.txt
+++ b/src/main/doc/Checklist.txt
@@ -1,10 +1,12 @@
 Checklist for release (for maintainer)
 
 0. Check in good code ;-). Check that tests run ok, javadoc is ok.
+   cd src/test/teaserfiles; make clean; make -j 20 ; make nukeempty
    If necessary, merge rmProtocols.xml from rmir.
    (Ideally) update documentation IrpTransmogrifier,xml.
    Update subtree common. (git subtree pull --prefix common git@github.com:bengtmartensson/HarctoolboxCommon.git master)
    Make sure that all source files are checked in.
+   lirc.xml: In IrProtocolCodeGeneration, make -f tools/Makefile lirc.xml.
 1. Update pom.xml: Bump version; can use make setversion NEWVERSION=x.y.z.)
    Check/update version of IrpProtocols.xml.
    Update releasenotes. Update copyright year(?).
diff --git a/src/main/doc/IrpTransmogrifier.releasenotes.txt b/src/main/doc/IrpTransmogrifier.releasenotes.txt
index 08b4877b..eccd9239 100644
--- a/src/main/doc/IrpTransmogrifier.releasenotes.txt
+++ b/src/main/doc/IrpTransmogrifier.releasenotes.txt
@@ -3,6 +3,21 @@ Release Notes for IrpTransmogrifier.
 The notation #n refers to issues number n at
 https://github.com/bengtmartensson/IrpTransmogrifier/issues
 
+===============================================================================
+2024-12-31 (tentatively): Version 1.2.14.
+
+* New protocols: Balboa, Sharp_Old, Sharp_Old{1}, Sharp_Old{2}. Thanx Graham Dixon.
+* Updated protocols: Denon, Sharp, Sunfire. Thanx Graham Dixon.
+* Function also if schemaFactory == null. #260.
+* Fix for IrpDatabase version management.
+* New "contributed" file, from Lyndel McGee, containing alternative Apple protocol definition.
+* New functions [Protocol,ParameterSpecs].addDefaulteds(...).
+* Update JCommander to 1.85.
+* New function Decoder.decodeIrSignalWithFallback(...). IrScrutinizer's #531.
+* Fix for some tests for the Window's line ending, Thanx to Sean Young.
+* Some typos and illegal file names fixed, courtesy of Sean Young,
+* Option --girrinput for the analyze- and decode commands, to read inputs in girr format. #253.
+
 ===============================================================================
 2024-01-08: Version 1.2.13.