Skip to content

Commit

Permalink
Doc update, in preparation for release 1.2.14.
Browse files Browse the repository at this point in the history
  • Loading branch information
bengtmartensson committed Dec 27, 2024
1 parent ad33832 commit 297df10
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/main/doc/Checklist.txt
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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(?).
Expand Down
15 changes: 15 additions & 0 deletions src/main/doc/IrpTransmogrifier.releasenotes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 297df10

Please sign in to comment.