Overview

This is a patch release that includes some minor performance improvements, but mostly includes documentation and development process improvements, particularly for windows. Upgrading from v2.3.2 is recommended for most people, particularly windows users.

Included Changes

• Fix #244 Add windows build to stable release. Updated CONTRIBUTING.md release instructions to be clearer and include instructions on how to upload the win64 install artifact from the github "Check" action. (dbaarda, https://github.com/librsync/librsync/pull/245)

• Update github actions and fix iwyu build target. Update checkout and upload-artifact to v3. Update lint.yml installed packages for fixed iwyu deps. Fix iwyu build target to ignore fileutil.c and use neater clang output with noisy "note:" output removed. Run make iwyu-fix to fix includes for tests/rabinkarp_perf.c. (dbaarda https://github.com/librsync/librsync/pull/243)

• Add missing word to README.md. (AvdN, https://github.com/librsync/librsync/pull/237)

• Make delta directly process the input stream if it has enough data. Delta operations will only accumulate data into the internal scoop buffer if the input buffer is too small, otherwise it will process the input directly. This makes delta calculations 5%~15% faster by avoiding extra data copying. (dbaarda, https://github.com/librsync/librsync/pull/234)

• Add .gitignore for .cmake created by LSP on Windows. (sourcefrog, https://github.com/librsync/librsync/pull/232)

• Upload build and install artifacts from Github actions. This means we get downloadable build and install artifacts for all platforms from the "Check" action. (sourcefrog, https://github.com/librsync/librsync/pull/231)

• Improve documentation so that Doxygen generates more complete documentation with diagrams, renders better, and is more navigable as markdown docs on GitHub. (dbaarda, https://github.com/librsync/librsync/pull/230)

• Add github action and make targets for clang-tidy and iwyu. Added clang-tidy and iwyu make targets for checking code and includes, and iwyu-fix for fixing includes. Added lint.yml GitHub action to run these checks. Fixed all clang-tidy and iwyu warnings except for fileutil.c with platform related include complications. Added consistent include guards to all headers. Updated and improved documentation in CONTRIBUTING.md to include these changes. (rizsotto, dbaarda, https://github.com/librsync/librsync/pull/229)

• Tidy rdiff integration test scripts. Made the filenames and shell arguments for test scripts consistent. (dbaarda, https://github.com/librsync/librsync/pull/227)

• Add better cmake build type configuration support. Added BuildType.cmake with better support for selecting the build type and making it default to Debug. (dbaarda, https://github.com/librsync/librsync/pull/226)

• Fix #215 Migrate from Travis to GitHub Actions. Added a check.yml GitHub action with updated test/platform matrix including full testing of rdiff on Windows. (rizsotto, dbaarda, https://github.com/librsync/librsync/pull/225)

• Fix bash test scripts to work on Windows. Tweaked cmake configuration and bash script tests so that full rdiff tests using libpopt from vcpkg work. Running cmake --target check with rdiff compiled now works on windows. (dbaarda, https://github.com/librsync/librsync/pull/224)

• Remove obsolete unused tests. Removed some obsolete mdfour test data files and check-rdiff perl script. (dbaarda, https://github.com/librsync/librsync/pull/223)

• Fix warning for later CMake versions. New CMake versions started complaining about the filename Findlibb2.cmake not matching the LIBB2 variables being used. (rizsotto, https://github.com/librsync/librsync/pull/221)

Known Issues

• The debian package configs are still very out of date.

• There is still no documentation on how to compile on or cross-compile for windows. See https://github.com/librsync/librsync/issues/171 for help.