diff --git a/.ccmalloc b/.ccmalloc index a36a01dd..6be99260 100644 --- a/.ccmalloc +++ b/.ccmalloc @@ -9,7 +9,6 @@ ############################################################################## ## (C) 1997-1998 Armin Biere, 1998 Johannes Keukelaar -## $Id$ ############################################################################## %%% `%' and `#' are comments !!!!!!! diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 00000000..cf613b0a --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,2 @@ +# clang-analyzer-valist.Uninitialized has a bug https://bugs.llvm.org/show_bug.cgi?id=41311. +Checks: "-clang-analyzer-valist.Uninitialized" diff --git a/.cvsignore b/.cvsignore deleted file mode 100644 index a6498979..00000000 --- a/.cvsignore +++ /dev/null @@ -1,28 +0,0 @@ -.deps -.libs -libtool -ltmain.sh -Makefile -Makefile.in -aclocal.m4 -autom4te.cache -config.h -config.h.in -install-sh -missing -mkinstalldirs -config.guess -config.sub -config.log -config.status -configure -stamp-h -stamp-h1 -stamp-h.in -*.lo -rdiff -librsync.la -prototab.c -prototab.h -ChangeLog -librsync-config.h diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..e24e7bc0 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,6 @@ +# Data files used for tests. +*.data binary +*.input binary +*.sig binary +*.delta binary +*.expect binary diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml new file mode 100644 index 00000000..cefa6eca --- /dev/null +++ b/.github/workflows/check.yml @@ -0,0 +1,91 @@ +name: Check + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +defaults: + run: + shell: bash + +jobs: + check: + runs-on: ${{matrix.os}} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + build: [Release] + options: [""] + include: + - os: windows-latest + os_options: "-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake" + - os: ubuntu-latest + build_docs: true + - os: ubuntu-latest + build: Release + options: "-DBUILD_SHARED_LIBS=OFF" + - os: ubuntu-latest + build: Release + options: "-DBUILD_RDIFF=OFF" + - os: ubuntu-latest + build: Release + options: "-G Ninja -DCMAKE_C_COMPILER=clang" + - os: ubuntu-latest + build: Debug + + steps: + - uses: actions/checkout@v3 + + - name: Install Dependencies + # Unfortunately available Marketplace Actions for this are in a mess, so we do it manually. + run: | + if [ "$RUNNER_OS" == "Linux" ]; then + sudo apt-get update -y + sudo apt-get install -y libpopt-dev libb2-dev doxygen graphviz ninja-build + elif [ "$RUNNER_OS" == "macOS" ]; then + brew update + brew install popt + elif [ "$RUNNER_OS" == "Windows" ]; then + vcpkg update + vcpkg --triplet x64-windows install libpopt + fi + + - name: Configure CMake + # Configure CMake in a 'build' subdirectory. + # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type + run: cmake -B '${{github.workspace}}/build' -DCMAKE_BUILD_TYPE=${{matrix.build}} ${{matrix.os_options}} ${{matrix.options}} + + - name: Build all + # Build your program with the given configuration. + run: cmake --build '${{github.workspace}}/build' --config ${{matrix.build}} + + - name: Run tests + working-directory: ${{github.workspace}}/build + # Execute tests defined by the CMake configuration. + # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail + run: ctest -C ${{matrix.build}} --output-on-failure + + - name: Build install + # Build your program with the given configuration. + run: cmake --install 'build' --config ${{matrix.build}} --prefix 'install' + + - name: Build docs + if: ${{matrix.build_docs}} + run: cmake --build '${{github.workspace}}/build' --target doc + + - name: Upload build + uses: actions/upload-artifact@v3 + with: + name: build results ${{matrix.os}} ${{matrix.build}} ${{matrix.options}} + path: ${{github.workspace}}/build + if-no-files-found: error + + - name: Upload install + uses: actions/upload-artifact@v3 + with: + name: install results ${{matrix.os}} ${{matrix.build}} ${{matrix.options}} + path: ${{github.workspace}}/install + if-no-files-found: error diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 00000000..ca3e5c71 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,25 @@ +name: Lint + +on: [push, pull_request] + +jobs: + lint: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Install Dependencies + # Unfortunately available Marketplace Actions for this are in a mess, so we do it manually. + run: | + sudo apt-get update -y + sudo apt-get install -y libpopt-dev libb2-dev clang-tidy iwyu + + - name: Configure CMake + run: cmake . + + - name: clang-tidy + run: cmake --build . --target clang-tidy + + - name: iwyu + run: cmake --build . --target iwyu diff --git a/.gitignore b/.gitignore index c8fcfd1d..24b172fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,40 +1,14 @@ -.*.swp -.deps -Makefile -Makefile.in -aclocal.m4 -autom4te.cache -compile -config.guess -config.h -config.h.in -config.log -config.status -config.sub -configure -depcomp -doc/Doxyfile -doc/Makefile -doc/Makefile.in -install-sh -*.o -librsync-config.h -libtool -ltmain.sh -missing -popt/Makefile -popt/Makefile.in -popt/libpopt.a -prototab.c -prototab.h -stamp-h1 -*.Po -test-driver -testsuite/mutate.tmp -testsuite/isprefix.driver -testsuite/*.log -testsuite/*.trs rdiff +*.o +CMakeCache.txt +CTestTestfile.cmake +config.h +*.cbp +librsync.so* +librsync.a +librsync*.dylib +Makefile +CMakeFiles *.lo .libs librsync.la @@ -42,3 +16,60 @@ librsync-[0-9]*tar.gz librsync-[0-9]*/ /m4/ tags +*.dylib +cmake_install.cmake +*.la +doc/Doxyfile +tests/isprefix.driver +html +latex +Testing +*.user +.cmake + +# CMake generated Doxygen files +CMakeDoxyfile.in +CMakeDoxygenDefaults.cmake + +# Editor temp files +.sw? +.*.sw? +*~ + +# OSX build outputs +*.dSYM + +# Test binaries +*_test +*_test.exe +*_test.exe.manifest + +# Performance benchmark binaries +*_perf +*_perf.exe +*_perf.exe.manifest + +*.bak + +*.tmp + +# for rtags +compile_commands.json + +# Cache sometimes leftover by Doxygen, +# similar to https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=758975 +doxygen_sqlite3.db + +# Coverage reports +*.gcov + +# Optional build using http://build-ninja.org +.ninja_deps +.ninja_log +build.ninja +rules.ninja + +# Microsoft Visual Studio build files +*.sln +*.vcxproj +*.vcxproj.filters diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 5b303910..00000000 --- a/.travis.yml +++ /dev/null @@ -1,6 +0,0 @@ -# "It took the night to believe" - -language: c -script: ./autogen.sh && ./configure && make && make check -# separate `make` shouldn't be necessary - https://github.com/librsync/librsync/issues/1 - diff --git a/AUTHORS b/AUTHORS index b4425dd2..eaf74e90 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,3 +1,4 @@ Martin Pool Andrew Tridgell Donovan Baarda +Adam Schubert diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..6c2c0f4e --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,488 @@ +# Copyright (C) 2015 Adam Schubert +# Copyright 2016 Martin Pool +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation; either version 2.1 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + + +project(librsync C) +cmake_minimum_required(VERSION 3.6) + +INCLUDE(CMakeDependentOption) +include(GNUInstallDirs) + +set(LIBRSYNC_MAJOR_VERSION 2) +set(LIBRSYNC_MINOR_VERSION 3) +set(LIBRSYNC_PATCH_VERSION 5) + +set(LIBRSYNC_VERSION + ${LIBRSYNC_MAJOR_VERSION}.${LIBRSYNC_MINOR_VERSION}.${LIBRSYNC_PATCH_VERSION}) + +set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake") + +# Turn on generating compile_commands.json for clang-tidy and iwyu. +set(CMAKE_EXPORT_COMPILE_COMMANDS ON) + +if (NOT CMAKE_SYSTEM_PROCESSOR) + message(FATAL_ERROR "No target CPU architecture set") +endif() + +if (NOT CMAKE_SYSTEM_NAME) + message(FATAL_ERROR "No target OS set") +endif() + +# Set CMAKE_BUILD_TYPE if unset. +include(BuildType) +message (STATUS "CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE}") + +option(BUILD_SHARED_LIBS "Build librsync as a shared library." ON) + +# Option ENABLE_TRACE defaults to ON for Debug builds. +if (CMAKE_BUILD_TYPE MATCHES Debug) + option(ENABLE_TRACE "Compile in detailed trace messages" ON) +else () + option(ENABLE_TRACE "Compile in detailed trace messages" OFF) +endif() +set(DO_RS_TRACE 0) +if (ENABLE_TRACE) + set(DO_RS_TRACE 1) +endif (ENABLE_TRACE) +message(STATUS "DO_RS_TRACE=${DO_RS_TRACE}") + +# Add an option to include compression support +option(ENABLE_COMPRESSION "Whether or not to build with compression support" OFF) +# TODO: Remove this warning when compression is implemented. +# Consider turning compression ON by default. +if (ENABLE_COMPRESSION) + message(WARNING "Compression support is not functional. See issue #8.") +endif (ENABLE_COMPRESSION) + +include ( CheckIncludeFiles ) +check_include_files ( sys/file.h HAVE_SYS_FILE_H ) +check_include_files ( sys/stat.h HAVE_SYS_STAT_H ) +check_include_files ( sys/types.h HAVE_SYS_TYPES_H ) +check_include_files ( unistd.h HAVE_UNISTD_H ) +check_include_files ( io.h HAVE_IO_H ) +check_include_files ( fcntl.h HAVE_FCNTL_H ) +check_include_files ( mcheck.h HAVE_MCHECK_H ) +check_include_files ( zlib.h HAVE_ZLIB_H ) +check_include_files ( bzlib.h HAVE_BZLIB_H ) + +# Remove compression support if not needed +if (NOT ENABLE_COMPRESSION) + SET(HAVE_BZLIB_H 0) + SET(HAVE_ZLIB_H 0) +endif (NOT ENABLE_COMPRESSION) + +include ( CheckSymbolExists ) +check_symbol_exists ( __func__ "" HAVE___FUNC__ ) +check_symbol_exists ( __FUNCTION__ "" HAVE___FUNCTION__ ) + +include ( CheckFunctionExists ) +check_function_exists ( fseeko HAVE_FSEEKO ) +check_function_exists ( fseeko64 HAVE_FSEEKO64 ) +check_function_exists ( _fseeki64 HAVE__FSEEKI64 ) +check_function_exists ( fstat64 HAVE_FSTAT64 ) +check_function_exists ( _fstati64 HAVE__FSTATI64 ) +check_function_exists ( fileno HAVE_FILENO ) +check_function_exists ( _fileno HAVE__FILENO ) + +include(CheckTypeSize) +check_type_size ( "long" SIZEOF_LONG ) +check_type_size ( "long long" SIZEOF_LONG_LONG ) +check_type_size ( "off_t" SIZEOF_OFF_T ) +check_type_size ( "off64_t" SIZEOF_OFF64_T ) +check_type_size ( "size_t" SIZEOF_SIZE_T ) +check_type_size ( "unsigned int" SIZEOF_UNSIGNED_INT ) +check_type_size ( "unsigned long" SIZEOF_UNSIGNED_LONG ) +check_type_size ( "unsigned short" SIZEOF_UNSIGNED_SHORT ) + +# Check for printf "%zu" size_t formatting support. +if(WIN32) + # CheckCSourceRuns checking for "%zu" succeeds but still gives warnings on win32. + set(HAVE_PRINTF_Z OFF) + # Not using unsupported %zu generates warnings about using %I64 with MinGW. + # set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-format") + message (STATUS "Compiling to Win32 - printf \"%zu\" size_t formatting support disabled") +elseif(CMAKE_CROSSCOMPILING) + # CheckCSourceRuns doesn't work when cross-compiling; assume C99 compliant support. + set(HAVE_PRINTF_Z ON) + message (STATUS "Cross compiling - assuming printf \"%zu\" size_t formatting support") +else() + include(CheckCSourceRuns) + check_c_source_runs("#include \nint main(){char o[8];sprintf(o, \"%zu\", (size_t)7);return o[0] != '7';}" HAVE_PRINTF_Z) +endif() + +include (TestBigEndian) +TEST_BIG_ENDIAN(WORDS_BIGENDIAN) +if (WORDS_BIGENDIAN) + message(STATUS "System is big-endian.") +else (WORDS_BIGENDIAN) + message(STATUS "System is little-endian.") +endif (WORDS_BIGENDIAN) + +# OS X +if(APPLE) + set(CMAKE_MACOSX_RPATH ON) + set(CMAKE_SKIP_BUILD_RPATH FALSE) + set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") + set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) + list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}" isSystemDir) + if("${isSystemDir}" STREQUAL "-1") + set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}") + endif() +endif() + +if (CMAKE_C_COMPILER_ID MATCHES "(Clang|Gnu|GNU)") + # TODO: Set -Werror when the build is clean. + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -std=c99 -pedantic") + if (CMAKE_C_COMPILER_ID MATCHES "Clang") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wconversion") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-sign-conversion") + endif() +elseif(CMAKE_C_COMPILER_ID MATCHES "MSVC") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /D_CRT_SECURE_NO_WARNINGS") +endif() + +site_name(BUILD_HOSTNAME) + +message (STATUS "PROJECT_NAME = ${PROJECT_NAME}") +message (STATUS "BUILD_HOSTNAME = ${BUILD_HOSTNAME}") +message (STATUS "CMAKE_SYSTEM = ${CMAKE_SYSTEM}") + +# Find POPT +find_package(POPT) +if (POPT_FOUND) + message (STATUS "POPT_INCLUDE_DIRS = ${POPT_INCLUDE_DIRS}") + message (STATUS "POPT_LIBRARIES = ${POPT_LIBRARIES}") + include_directories(${POPT_INCLUDE_DIRS}) +endif (POPT_FOUND) + +# Add an option to exclude rdiff executable from build +# This is useful, because it allows to remove POPT dependency if a user is interested only in the +# rsync library itself and not in the rdiff executable +cmake_dependent_option(BUILD_RDIFF "Whether or not to build rdiff executable" ON "POPT_FOUND" OFF) + +# Find BZIP +find_package (BZip2) +if (BZIP2_FOUND) + message (STATUS "BZIP2_INCLUDE_DIRS = ${BZIP2_INCLUDE_DIRS}") + message (STATUS "BZIP2_LIBRARIES = ${BZIP2_LIBRARIES}") + include_directories(${BZIP2_INCLUDE_DIRS}) +endif (BZIP2_FOUND) + +# Find ZLIB +find_package (ZLIB) +if (ZLIB_FOUND) + message (STATUS "ZLIB_INCLUDE_DIRS = ${ZLIB_INCLUDE_DIRS}") + message (STATUS "ZLIB_LIBRARIES = ${ZLIB_LIBRARIES}") + include_directories(${ZLIB_INCLUDE_DIRS}) +endif (ZLIB_FOUND) + +# Find libb2 +find_package(LIBB2) +if (LIBB2_FOUND) + message (STATUS "LIBB2_INCLUDE_DIRS = ${LIBB2_INCLUDE_DIRS}") + message (STATUS "LIBB2_LIBRARIES = ${LIBB2_LIBRARIES}") +endif (LIBB2_FOUND) + +# Add an option to use LIBB2 if found. It defaults to off because the +# reference implementation is currently faster. +cmake_dependent_option(USE_LIBB2 "Use the libb2 blake2 implementation." OFF "LIBB2_FOUND" OFF) + +if (USE_LIBB2) + message (STATUS "Using libb2 blake2 implementation.") + include_directories(${LIBB2_INCLUDE_DIRS}) + set(blake2_LIBS ${LIBB2_LIBRARIES}) +else (USE_LIBB2) + message (STATUS "Using included blake2 implementation.") + include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src/blake2) + set(blake2_SRCS src/blake2/blake2b-ref.c) +endif (USE_LIBB2) + +# Doxygen doc generator. +find_package(Doxygen) +if(DOXYGEN_FOUND) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile @ONLY) + add_custom_target(doc + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMENT "Generating API documentation with Doxygen" VERBATIM + ) +endif(DOXYGEN_FOUND) + +# Code tidy target to reformat code with indent. +file(GLOB tidy_SRCS src/*.[ch] tests/*.[ch]) +set(TYPE_RE "(\\w+_t)") +set(CAST_RE "(\\(${TYPE_RE}( \\*+)?\\))") +add_custom_target(tidy + COMMENT "Reformatting all code to preferred coding style." + # Note indent requires all userdefined types to be specified with '-T ' args to + # format them correctly. Rather than do that, we just postprocess with sed. + # + # Hide the enclosing 'extern "C" {...}' block for indenting in librsync.h + COMMAND sed -r -i "s:^(extern \"C\") \\{:\\1;:; s:^\\}(\\s+/\\* extern \"C\" \\*/):;\\1:" src/librsync.h + # Linux format with no tabs, indent 4, preproc indent 2, 80 columns, swallow blank lines. + COMMAND indent -linux -nut -i4 -ppi2 -l80 -lc80 -fc1 -sob -T FILE -T Rollsum -T rs_result ${tidy_SRCS} + # Remove space between * or & and identifier after userdefined types, + # remove space after type cast for userdefined types like indent -ncs, + # and remove trailing whitespace. + COMMAND sed -r -i "s:((${TYPE_RE}|${CAST_RE}) (&|\\*+)) :\\1:g; s:(${CAST_RE}) :\\1:g; s:\\s+$::" ${tidy_SRCS} + # Restore the enclosing 'extern "C" {...}' block in librsync.h + COMMAND sed -r -i "s:^(extern \"C\");:\\1 {:; s:^;(\\s+/\\* extern \"C\" \\*/):}\\1:" src/librsync.h + VERBATIM +) +# Code tidyc target to reformat all code and comments with https://github.com/dbaarda/tidyc. +add_custom_target(tidyc + COMMENT "Reformatting all code and comments to preferred coding style." + # Recomended format, reformat linebreaks, reformat comments, 80 columns. + COMMAND tidyc -R -C -l80 -T FILE -T Rollsum -T rs_result ${tidy_SRCS} + VERBATIM +) + +# clang-tidy target to check code for errors. +add_custom_target(clang-tidy + COMMENT "Check code for errors using clang-tidy." + COMMAND run-clang-tidy -p ${CMAKE_CURRENT_BINARY_DIR} + VERBATIM +) + +# iwyu target to check includes for correctness. +# Note we ignore noisy "note:" output. +add_custom_target(iwyu + COMMENT "Check #includes for correctness using iwyu_tool." + COMMAND ! iwyu_tool -p ${CMAKE_CURRENT_BINARY_DIR} -o clang | egrep -v "note:" + VERBATIM +) + +# iwyu-fix target to fix includes for correctness. +add_custom_target(iwyu-fix + COMMENT "Fix #includes for correctness using iwyu_tool and fix_include." + COMMAND iwyu_tool -p ${CMAKE_CURRENT_BINARY_DIR} | fix_include --noblank_lines + VERBATIM +) + +# Testing + +add_executable(isprefix_test + tests/isprefix_test.c src/isprefix.c) +add_test(NAME isprefix_test COMMAND isprefix_test) + +add_executable(netint_test + tests/netint_test.c src/netint.c src/util.c src/trace.c src/tube.c + src/scoop.c) +target_compile_options(netint_test PRIVATE -DLIBRSYNC_STATIC_DEFINE) +add_test(NAME netint_test COMMAND netint_test) + +add_executable(rollsum_test + tests/rollsum_test.c src/rollsum.c) +add_test(NAME rollsum_test COMMAND rollsum_test) + +add_executable(rabinkarp_test + tests/rabinkarp_test.c src/rabinkarp.c) +add_test(NAME rabinkarp_test COMMAND rabinkarp_test) +add_executable(rabinkarp_perf + tests/rabinkarp_perf.c src/rabinkarp.c) + +add_executable(hashtable_test + tests/hashtable_test.c src/hashtable.c) +add_test(NAME hashtable_test COMMAND hashtable_test) + +add_executable(checksum_test + tests/checksum_test.c src/checksum.c src/rollsum.c src/rabinkarp.c src/mdfour.c ${blake2_SRCS}) +target_compile_options(checksum_test PRIVATE -DLIBRSYNC_STATIC_DEFINE) +target_link_libraries(checksum_test ${blake2_LIBS}) +add_test(NAME checksum_test COMMAND checksum_test) + +add_executable(sumset_test + tests/sumset_test.c src/sumset.c src/util.c src/trace.c src/hex.c + src/checksum.c src/rollsum.c src/rabinkarp.c src/mdfour.c src/hashtable.c ${blake2_SRCS}) +target_compile_options(sumset_test PRIVATE -DLIBRSYNC_STATIC_DEFINE) +target_link_libraries(sumset_test ${blake2_LIBS}) +add_test(NAME sumset_test COMMAND sumset_test) + +# On Windows we need to explicitly execute bash for scripts. +if (WIN32) + set(WIN_BASH bash -e) +endif (WIN32) + +# Disable rdiff specific tests +if (BUILD_RDIFF) + add_test(NAME rdiff_bad_option + COMMAND ${WIN_BASH} rdiff_bad_option.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Help + COMMAND ${WIN_BASH} help.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Mutate + COMMAND ${WIN_BASH} mutate.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Signature + COMMAND ${WIN_BASH} signature.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Sources + COMMAND ${WIN_BASH} sources.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Triple + COMMAND ${WIN_BASH} triple.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Delta + COMMAND ${WIN_BASH} delta.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) + add_test(NAME Changes + COMMAND ${WIN_BASH} changes.test $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests) +endif (BUILD_RDIFF) + + +# `make check` that will build everything and then run the tests. +# See https://cmake.org/Wiki/CMakeEmulateMakeCheck and +# https://github.com/librsync/librsync/issues/49 +if (BUILD_RDIFF) + set(LAST_TARGET rdiff) +else (BUILD_RDIFF) + set(LAST_TARGET rsync) +endif (BUILD_RDIFF) +add_custom_target(check COMMAND ${CMAKE_CTEST_COMMAND} -C Debug) +add_dependencies(check ${LAST_TARGET} + isprefix_test + netint_test + rollsum_test + rabinkarp_test + hashtable_test + checksum_test + sumset_test) + +enable_testing() + +# Create conf files +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/config.h.in ${CMAKE_CURRENT_BINARY_DIR}/src/config.h) + +# We need to be able to #include "file" from a few places, +# * The original source dir +# * The generated source dir +include_directories(${CMAKE_CURRENT_BINARY_DIR}/src) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src) + + +########### next target ############### + +# Only list the .c files that need to be compiled +# (Don't list .h files) + +set(rsync_LIB_SRCS + src/prototab.c + src/base64.c + src/buf.c + src/checksum.c + src/command.c + src/delta.c + src/emit.c + src/fileutil.c + src/hashtable.c + src/hex.c + src/job.c + src/mdfour.c + src/mksum.c + src/msg.c + src/netint.c + src/patch.c + src/readsums.c + src/rollsum.c + src/rabinkarp.c + src/scoop.c + src/stats.c + src/sumset.c + src/trace.c + src/tube.c + src/util.c + src/version.c + src/whole.c + ${blake2_SRCS}) + +add_library(rsync ${rsync_LIB_SRCS}) +# TODO: Enable this when GenerateExportHeader works more widely. +# include(GenerateExportHeader) +# generate_export_header(rsync BASE_NAME librsync +# EXPORT_FILE_NAME ${CMAKE_SOURCE_DIR}/src/librsync_export.h) +target_link_libraries(rsync ${blake2_LIBS}) + +# Optionally link zlib and bzip2 if +# - compression is enabled +# - and libraries are found +if (ENABLE_COMPRESSION) + if (ZLIB_FOUND AND BZIP2_FOUND) + target_link_libraries(rsync ${ZLIB_LIBRARIES} ${BZIP2_LIBRARIES}) + else (ZLIB_FOUND AND BZIP2_FOUND) + message (WARNING "zlib and bzip2 librares are required to enable compression") + endif (ZLIB_FOUND AND BZIP2_FOUND) +endif (ENABLE_COMPRESSION) + +# Set properties/options for shared vs static library. +if (BUILD_SHARED_LIBS) + set_target_properties(rsync PROPERTIES C_VISIBILITY_PRESET hidden) +else (BUILD_SHARED_LIBS) + target_compile_options(rsync PUBLIC -DLIBRSYNC_STATIC_DEFINE) +endif (BUILD_SHARED_LIBS) + +set_target_properties(rsync PROPERTIES + VERSION ${LIBRSYNC_VERSION} + SOVERSION ${LIBRSYNC_MAJOR_VERSION}) +install(TARGETS rsync ${INSTALL_TARGETS_DEFAULT_ARGS} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} +) + + +########### next target ############### + +if (BUILD_RDIFF) + set(rdiff_SRCS + src/rdiff.c + src/isprefix.c) + + add_executable(rdiff ${rdiff_SRCS}) + if (POPT_FOUND) + target_link_libraries(rdiff rsync ${POPT_LIBRARIES}) + else (POPT_FOUND) + message (WARNING "Popt library is required for rdiff target") + endif (POPT_FOUND) + + install(TARGETS rdiff ${INSTALL_TARGETS_DEFAULT_ARGS} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} + ) +endif (BUILD_RDIFF) + + +########### install files ############### + +install(FILES + src/librsync.h + src/librsync_export.h + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + +message (STATUS "CMAKE_C_FLAGS = ${CMAKE_C_FLAGS}") + +install(FILES + doc/librsync.3 + DESTINATION ${CMAKE_INSTALL_MANDIR}/man3) +install(FILES + doc/rdiff.1 + DESTINATION ${CMAKE_INSTALL_MANDIR}/man1) + +# vim: shiftwidth=4 expandtab diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4aa05273 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,319 @@ +# CONTRIBUTING + +Instructions and conventions for people wanting to work on librsync. Please +consider these guidelines even if you're doing your own fork. + +## Requirements + +There are a bunch of tools and libraries that are useful for development or +that librsync depends on. In addition to the standard cmake/gcc/make/etc C +development tools, the following packages are recommended; + +* libpopt-dev - the cmdline argument parsing library used by rdiff. If this is + not available rdiff cannot be compiled, and only the librsync library will + be compiled. + +* libb2-dev - blake2 hash library librsync can use if `USE_LIBB2` is set to + `ON` in cmake. If this is not avalable librsync will use its included copy + of blake2 (which may be older... or newer). + +* doxygen - documentation generator used to generate html documentation. If + installed `make doc` can be run to generate all the docs. + +* graphviz - graph generator used by doxygen for generating diagrams. If not + installed doxygen will not generate any diagrams. + +* indent - code reformatter for tidying code. If installed all the code can be + tidied with `make tidy`. + +* [tidyc](https://github.com/dbaarda/tidyc) - extension wrapper for indent + that includes better formatting of doxygen comments. If installed code and + comments can be tidied with `make tidyc`. + +* clang-tidy - code lint checker for potential problems. If installed the code + can be checked with `make clang-tidy`. + +* iwyu - `#include` checker and fixer. If installed includes can be checked + with `make iwyu`, and automatically fixed with `make iwyu-fix`. Note on some + platforms this package is [missing a + dependency](https://bugs.launchpad.net/ubuntu/+source/iwyu/+bug/1769334) and + also needs `libclang-common-9-dev` to be installed. + +These can all be installed on Debian/Ubuntu systems by running; + +```Shell +$ apt-get update +$ apt-get install libpopt-dev libb2-dev doxygen graphviz indent clang-tidy iwyu +$ git clone https://github.com/dbaarda/tidyc.git +$ cp tidyc/tidyc ~/bin +``` + +### Windows + +Not all the recommended packages are easily available on windows. +[Cygwin](https://cygwin.com/) and [MSYS2](http://msys2.org/) provide a +development environment similar to Linux. Some packages can also be found on +[Chocolatey](https://chocolatey.org/). For native development using standard +MSVC tools, libpopt can be found on [vcpkg](https://vcpkg.io/) and installed +by running; + +```Shell +$ vcpkg update +$ vcpkg --triplet x64-windows install libpopt +``` + +For cmake to find the installed libpopt you need to add `-D +CMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake` to the cmake +cmdline. This configures cmake to correctly search the vcpkg install locations +to find libraries. + +### MacOS + +MacOS is generally more similar to Linux than Windows, and several packages +are available on homebrew. The libpopt library can be installed by running; + +```Shell +$ brew update +$ brew install popt +``` + +## Building + +The minimal instructions to fetch, configure, compile, and test everything +using a in-place default Debug build with trace enabled using the internal +blake2 implementation is; + +```Shell +$ git clone https://github.com/librsync/librsync.git +$ cd librsync +$ cmake . +$ make check +``` + +For cmake, `-B` can be used to select a separate build directory, and `-G` can +select a different make system. Also the following settings can be changed +with `-D =` arguments when generating the project with cmake; + +* CMAKE_BUILD_TYPE=(Debug|Release|MinSizeRel|RelWithDebInfo) - the build type + to use, which selects compiler options. The default is `Debug`. + +* CMAKE_C_COMPILER=(cc|gcc|clang|...) - The compiler to use. The default is to + auto-detect the available compiler on the platform. + +* BUILD_RDIFF=(ON|OFF) - Whether to build and test the rdiff executable. + Defaults to ON if libpopt is available. + +* BUILD_SHARED_LIBS=(ON|OFF) - Whether to build dynamic libraries or use + static linking. Defaults to ON. + +* ENABLE_TRACE=(ON|OFF) - Whether to enable trace output in the library and + for rdiff using `-v`. Trace output can help with debugging but its a little + faster with ENABLE_TRACE=OFF. Defaults to ON for Debug builds, and OFF for + others. + +* USE_LIBB2=(ON|OFF) - Whether to use libb2 instead of the included blake2 + implementation. Defaults to OFF. + +So for a Release build in a separate directory using Ninja, clang, static +linking, and libb2 with trace enabled, do this instead; + +```Shell +$ cmake -B build -G Ninja + -D CMAKE_C_COMPILER=clang \ + -D CMAKE_BUILD_TYPE=Release \ + -D BUILD_SHARED_LIBS=OFF \ + -D USE_LIBB2=ON \ + -D ENABLE_TRACE=ON +$ cmake --build build --config Release --target check +``` + +You can also use ccmake or cmake-gui to interactively configure and generate +into a separate build directory with; + +```Shell +$ ccmake -B build +``` + +## Coding + +The prefered style for code is equivalent to using GNU indent with the +following arguments; + +```Shell +$ indent -linux -nut -i4 -ppi2 -l80 -lc80 -fc1 -sob -T FILE -T Rollsum -T rs_result +``` + +The preferred style for non-docbook comments are as follows; + +```C + + /*= + | A short poem that + | shall never ever be + | reformated or reindented + */ + + /* Single line comment indented to match code indenting. */ + + /* Blank line delimited paragraph multi-line comments. + + Without leading stars, or blank line comment delimiters. */ + + int a; /* code line comments */ +``` + +The preferred style for docbook comments is javadoc with autobrief as +follows; + +```C +/** /file file.c + * Brief summary paragraph. + * + * With blank line paragraph delimiters and leading stars. + * + * /param foo parameter descriptions... + * + * /param bar ...in separate blank-line delimited paragraphs. + * + * Example:/code + * code blocks that will never be reformated. + * /endcode + * + * Without blank-line comment delimiters. */ + + int a; /**< brief attribute description */ + int b; /**< multiline attribute description + * + * With blank line delimited paragraphs.*/ +``` + +There is a `make tidy` target that will use GNU indent to reformat all code +and non-docbook comments, doing some pre/post processing with sed to handle +some corner cases indent doesn't handle well. + +There is a `make tidyc` target that will reformat all code and comments with +[tidyc](https://github.com/dbaarda/tidyc). This will also correctly reformat +all docbook comments, equivalent to running tidyc with the following +arguments; + +```Shell +$ tidyc -R -C -l80 -T FILE -T Rollsum -T rs_result +``` + +There is `make clang-tidy` and `make iwyu` targets for checking for coding +errors and incorrect `#include` statements. Note that the iwyu check gets +confused by and will emit warnings about `fileutil.c` which has extra +conditional includes necessary to find working functions on various platforms. +Other than `fileutil.c` both checks should be clean. + +If iwyu finds problems, `make ifwu-fix` can be run to automatically fix them, +followed by `make tidyc` to reformat the result to our preferred style. Note +that this doesn't always produce an ideal result and may require manual +intervention. + +Please try to update docs and tests in parallel with code changes. + +## Testing + +Using `make check` will compile and run all tests. Additional code correctness +checks can be run with `make clang-tidy` and `make iwyu`. + +Note that `assert()` is used extensively within the code for verifying the +correctness of internal operations using a roughly design-by-contract +approach. These are only enabled for Debug builds, so testing with a Debug +build will give a better chance of identifying problems during development. +Once you are confident the code is correct, a Release build will turn these +off giving faster execution. + +There are also GitHub Actions configured for the librsync project to +configure, build, test, and lint everything on a variety of different +platforms with a variety of different settings. These are run against any pull +request or commit, and are a good way to check things are not broken for other +platforms. + +Test results for builds of public github branches are at +https://github.com/librsync/librsync/actions. + +## Documenting + +[NEWS.md](NEWS.md) contains a list of user-visible changes in the library +between release versions. This includes changes to the way it's packaged, bug +fixes, portability notes, changes to the API, and so on. Add and update items +under a "Changes in X.Y.Z" heading at the top of the file. Do this as you go +along, so that we don't need to work out what happened when it's time for a +release. + +[TODO.md](TODO.md) contains a list of ideas and proposals for the future. +Ideally entries should be formated in a way that can be just moved into +[NEWS.md](NEWS.md) when they are done. Regularly check to see if there is +anything that needs removing or updating. + +## Submitting + +Fixes or improvements in pull requests are welcome. Please: + +- [ ] Send small PRs that address one issues each. + +- [ ] Update `NEWS.md` to say what you changed. + +- [ ] Add a test as a self-contained C file in `tests/` that passes or fails, + and is hooked into `CMakeLists.txt`. + +- [ ] Keep the code style consistent with what's already there, especially in + keeping symbols with an `rs_` prefix. + +## Releasing + +If you are making a new tarball release of librsync, follow this checklist: + +* Make a "Release vx.x.x" pull request containing updates ready for the + release including; + + * Review the changes included and decide if the release should be a major + (non-backwards compatible change), minor (backwards compatible change), + or micro (bugfix only change) version number change to get the new + "X.Y.Z" version number. + + * NEWS.md - make sure the top "Changes in X.Y.Z" is correct, and the date + is correct. Make sure the changes since the last release are documented. + + * TODO.md - check if anything needs to be removed or updated. + + * `CMakeLists.txt` - version is correct. + + * `librsync.spec` - make sure version and URL are right. + +* Run `make all doc check` in a clean checkout of the release pull request + branch. Also check the GitHub Actions [check and lint + status](https://github.com/librsync/librsync/actions) of the last commit on + github. If it all looks good merge the release pull request on github. + +* Draft a new release on github, typing in the release details including an + overview, included changes, and known issues. The overview should give an + indication of the magnitude of the changes and their impact, and the + relative urgency to upgrade. The included changes should come from the + NEWS.md for the release. It's probably easiest to copy and edit the previous + release. + +* After creating the release, download the `Source code (tar.gz)` release + asset. Go to "Actions", find the workflow run for the "Check" corresponding + to the merge of the release pull request, and download the `install results + windows-latest Release` artifact renamed to `librsync-win64-X.Y.Z.zip`. Edit + the release, and upload the source code and windows artifacts. This ensures + that the release includes a stable tarball (See + https://github.com/librsync/librsync/issues/146 for details) and win64 + install. + +* Run `make doc` on a clean checkout of the new release tag and `cp -av html/*` + into a `rm -Rf *` emptied checkout of librsync.github.io and check it in. + This ensures it includes deletes of obsolete files as well as new and + updated files. Push this to update the online docs. + +* Create and merge a "Prepare vX.Y.Z+1." pull request containing updates to + prepare for the changes in the next release including; + + * Bump the minor version in `CMakeLists.txt`. + + * Add a `NOT RELEASED YET` version entry in `NEWS.md` + + * Bump the minor version and add a `%changelog` entry in `librsync.spec`. diff --git a/HACKING b/HACKING deleted file mode 100644 index f304ee1d..00000000 --- a/HACKING +++ /dev/null @@ -1,18 +0,0 @@ -Instructions and conventions for people wanting to work on librsync. Please -consider these guidelines even if you're doing your own fork. - - * If you make a significant change (of more than 15 lines, say), then - add yourself to the copyright for that file, and to the AUTHORS file. - - * THANKS contains a list of contributors for each release. If someone - contributed a patch or bugreport, please add them under a - "Contributors for X.Y.Z" heading at the bottom of the file. - - * NEWS contains a list of user-visible changes in the library between - releases version. This includes changes to the way it's packaged, - bug fixes, portability notes, changes to the API, and so on. Add - and update items under a "Changes in X.Y.Z" heading at the top of - the file. Do this as you go along, so that we don't need to work - out what happened when it's time for a release. - - * Please try to update docs and tests in parallel with code changes. diff --git a/Makefile.am b/Makefile.am deleted file mode 100644 index 2057cef8..00000000 --- a/Makefile.am +++ /dev/null @@ -1,75 +0,0 @@ -## Process this file with automake to produce Makefile.in - -# Copyright (C) 2000-2002, 2014, 2015 by Martin Pool -# Copyright (C) 2003 by Donovan Baarda - -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public License -# as published by the Free Software Foundation; either version 2.1 of -# the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this program; if not, write to the Free Software -# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -AUTOMAKE_OPTIONS = foreign -SUBDIRS = . doc testsuite popt -ACLOCAL_AMFLAGS = -I m4 - -MAINTAINERCLEANFILES = Makefile.in \ - aclocal.m4 config.guess config.h.in config.sub configure \ - depcomp install-sh ltmain.sh missing mkinstalldirs \ - prototab.c prototab.h - -EXTRA_DIST = autogen.sh configure.msc $(noinst_SCRIPTS) rdiff.magic \ - librsync.spec README.RPM libversions.txt \ - PCbuild/rdiff.dsp PCbuild/PCbuild.dsw PCbuild/config.h \ - PCbuild/librsync-config.h - -include_HEADERS = librsync.h librsync-config.h - -lib_LTLIBRARIES = librsync.la - -librsync_la_SOURCES = prototab.c prototab.h \ - base64.c buf.c buf.h checksum.c checksum.h command.c \ - command.h delta.c emit.c emit.h fileutil.c fileutil.h \ - hex.c job.c job.h mdfour.c mdfour.h mksum.c msg.c netint.c netint.h \ - patch.c readsums.c librsync.h librsync-config.h \ - rollsum.c rollsum.h \ - scoop.c search.c search.h stats.c stream.c stream.h sumset.c \ - sumset.h trace.c trace.h tube.c types.h util.c util.h \ - version.c whole.c whole.h snprintf.h \ - blake2b-ref.c blake2.h blake2-impl.h - -librsync_la_LIBADD = @LIBOBJS@ - -librsync_la_LDFLAGS = -version-info @librsync_libversion@ - -# This is the default for any programs that don't specify a preference. -LDADD = librsync.la - -# This is the rdiff application -bin_PROGRAMS = rdiff - -rdiff_SOURCES = rdiff.c isprefix.c isprefix.h librsync.h librsync-config.h \ - trace.h - -rdiff_LDADD = @BUILD_POPT@ librsync.la - -rdiff_DEPENDENCIES = @BUILD_POPT@ librsync.la - -# this script is used to build prototab.[ch] -noinst_SCRIPTS = mkprototab.pl - -# Autogenerated by a script. -prototab.c prototab.h: $(srcdir)/mkprototab.pl - perl $(srcdir)/mkprototab.pl prototab.c prototab.h - -# Rule to build popt if needed. -popt/libpopt.a: - (cd popt && $(MAKE) $(AM_MAKEFLAGS) libpopt.a) diff --git a/NEWS b/NEWS deleted file mode 100644 index 05075d5e..00000000 --- a/NEWS +++ /dev/null @@ -1,304 +0,0 @@ -Changes in librsync 1.0.1-HEAD (not released yet) - - * Better performance on large files. (VictorDenisov) - - * Restore shipped copy of popt, for easier building. popt is only - built into diffnot ibrsync. (Martin Pool) - - * Add comment on usage of rs_build_hash_table(), and assert correct use. - Callers must call rs_build_hash_table() after loading the signature, - and before calling rs_delta_begin(). - Thanks to Paul Harris - -Changes in librsync 1.0.0 (2015-01-23) - - * SECURITY: CVE-2014-8242: librsync previously used a truncated MD4 - "strong" check sum to match blocks. However, MD4 is not cryptographically - strong. It's possible that an attacker who can control the contents of one - part of a file could use it to control other regions of the file, if it's - transferred using librsync/rdiff. For example this might occur in a - database, mailbox, or VM image containing some attacker-controlled data. - - To mitigate this issue, signatures will by default be computed with a - 256-bit BLAKE2 hash. Old versions of librsync will complain about a - bad magic number when given these signature files. - - Backward compatibility can be obtained using the new - `rdiff sig --hash=md4` - option or through specifying the "signature magic" in the API, but - this should not be used when either the old or new file contain - untrusted data. - - Deltas generated from those signatures will also use BLAKE2 during - generation, but produce output that can be read by old versions. - - See https://github.com/librsync/librsync/issues/5 - - Thanks to Michael Samuel for reporting this and offering an - initial patch. - - * Various build fixes, thanks Timothy Gu. - - * Improved rdiff man page from Debian. - - * Improved librsync.spec file for building RPMs. - - * Fixed bug #1110812 'internal error: job made no progress'; on large - files. - - * Moved hosting to https://github.com/librsync/librsync/ - - * Travis-CI.org integration test at https://travis-ci.org/librsync/librsync/ - - * You can set `$LIBTOOLIZE` before running `autogen.sh`, for example on - OS X Homebrew where it is called `glibtoolize`. - -Changes in 0.9.7 (released 2004-10-10) - - * Yet more large file support fixes. - - * C++ support for easy #include in C++. - - * Removed Debian files from dist tarball. - - * Changed rdiff to an installed program on "make install". - - * Refactored delta calculation code to be cleaner and faster. - - * #879763: Fixed mdfour to work on little-endian machines which don't - like unaligned word access. This should make librsync work on - pa-risc, and it makes it slightly faster on ia64. - - * #1022764: Fix corrupted encoding of some COPY commands in large - files. - - * #1024881: Print long integers directly, rather than via casts to - double. - - * Fix printf formats for size_t: both the format and the argument - should be cast to long. - -Changes in 0.9.6 - - * Large file support fixes. - - * [v]snprintf or _[v]snprintf autoconf replacement function fix. - - * Changed installed include file from rsync.h to librsync.h. - - * Migration to sourceforge for hosting. - - * Rollsum bugfix that produces much smaller deltas. - - * Memory leaks bugfix patches. - - * mdfour bigendian and >512M bugfix, plus optimisations patch. - - * autoconf/automake updates and cleanups for autoconf 2.53. - - * Windows compilation patch, heavily modified. - - * MacOSX compilation patch, modified to autoconf vararg macro fix. - - * Debian package build scripts patch. - -Changes in 0.9.5: - - * Bugfix patch from Shirish Hemant Phatak - -Changes in 0.9.4: (library 1.1.0) - - * Fixes for rsync.h from Thorsten Schuett - - * RLL encoding fix from Shirish Hemant Phatak - - * RPM spec file by Peter J. Braam - - * No (intentional) changes to binary API. - -Changes in 0.9.3: - - * Big speed improvements in MD4 routines and generation of weak - checksums. - - * Patch to build on FreeBSD by Jos Backus - - * Suggestions to build on Solaris 2.6 from Alberto Accomazzi - - - * Add rs_job_drive, a generic mechanism for turning the library into - blocking mode. rs_whole_run now builds on top of this. The - filebuf interface has changed a little to accomodate it. - - * Generating and loading signatures now generates statistics. - - * More test cases. - - * I suspect there may be a bug in rolling checksums, but it probably - only causes inefficiency and not corruption. - - * Portability fixes for alphaev67-dec-osf5.1; at the moment builds - but does not work because librsync tries to do unaligned accesses. - - * Works on sparc64-unknown-linux-gnu (Debian/2.2) - -Changes in 0.9.2: - - * Improve delta algorithm so that deltas are actually - delta-compressed, rather than faked. - -Changes in 0.9.1: - - * Rename the library to `librsync'. - - * Portability fixes. - - * Include the popt library, and use it to build rdiff if the library - is not present on the host. - - * Add file(1) magic for rdiff. - - * Add more to the manual pages. - - * It's no longer necessary to call rs_buffers_init on a stream before - starting to use it: all the internal data is kept in the job, not - in the stream. - - * Rename rs_stream_t to rs_buffers_t, a more obvious name. Pass the - buffers to every rs_job_iter() call, rather than setting it at - startup. Similarly for all the _begin() functions. - - * rs_job_new also takes the initial state function. - - * Return RS_PARAM_ERROR when library is misused. - -Changes in 0.9.0: - - * Redesign API to be more like zlib/bzlib. - - * Put all command-line functions into a single rdiff(1) program. - - * New magic number `rs6' - - * Change to using popt for command line parsing. - - * Use Doxygen for API documentation. - -Changes in 0.5.7: - - * Changes stats string format. - - * Slightly improved test cases - -Changes in 0.5.6: - - * Don't install debugging tools into /usr/local/bin; leave them in - the source directory. - - * Fix libhsync to build on (sgi-mips, IRIX64, gcc, GNU Make) - - * Include README.CVS in tarball - - * Back out of using libtool and shared libraries, as it is - unnecessary at this stage, complicates installation and slows down - compilation. - - * Use mapptr when reading data to decode, so that decoding should - have less latency and be more reliable. - - * Cope better on systems that are missing functions like snprintf. - -Changes in 0.5.5: - - * Put genuine search encoding back into the nad algorithm, and - further clean up the nad code. Literals are now sent out using a - literal buffer integrated with the input mapptr so that data is not - copied. Checksums are still calculated from scratch each time - rather than by rolling -- this is very slow but simple. - - * Reshuffle test cases so that they use files generated by hsmapread, - rather than the source directory. This makes the tests quicker and - more reproducible, hopefully without losing coverage. Further - develop the test driver framework. - - * Add hsdumpsums debugging tool. - - * Hex strings (eg strong checksums) are broken up by underscores for - readability. - - * Stats now go to the log rather than stdout. - - * mapptr acts properly when we're skipping/rewinding to data already - present in the buffer -- it does a copy if required, but not - necessarily real IO. - -Changes in 0.5.4: - - * Improved mapptr input code - - * Turn on more warnings if using gcc - - * More test cases - -Changes in 0.5.3: - - * Improvements to mapptr to make it work better for network IO. - - * Debug trace code is compiled in unless turned off in ./configure - (although most programs will not write it out unless asked.) - - * Add libhsyncinfo program to show compiled-in settings and version. - - * Add test cases that run across localhost TCP sockets. - - * Improved build code; should now build easily from CVS through - autogen.sh. - - * Improved trace code. - - * Clean up to build on sparc-sun-solaris2.8, and in the process clean - up the handling of bytes vs chars, and of building without gcc - - * Reverse build scripts so that driver.sh calls the particular - script. - -Changes in 0.5.2: - - * Use mapptr for input. - - * Implement a new structure for encoding in nad.c. It doesn't - encode at the moment, but it's much more maintainable. - - * More regression cases. - - * Clean up build process. - -Changes in 0.5.0: - - * Rewrite hs_inbuf and hs_encode to make them simpler and more - reliable. - - * Test cases for input handling. - - * Use the map_ptr idea for input from both streams and files. - -Changes in 0.4.1: - - * automake/autoconf now works cleanly when the build directory is - different to the source directory. - - * --enable-ccmalloc works again. - -Changes in 0.4.0: - -* A much better regression suite. - -* CHECKSUM token includes the file's checksum up to the current - location, to aid in self-testing. - -* Various bug fixes, particularly to do with short IO returns. - - -Local variables: -mode: indented-text -End: diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 00000000..9a6ad2ad --- /dev/null +++ b/NEWS.md @@ -0,0 +1,675 @@ +# NEWS + +## librsync 2.3.5 + +NOT RELEASED YET + +## librsync 2.3.4 + +Released 2023-02-19 + + * Fix #248 by putting `#include "config.h"` with `/* IWYU pragma: keep */` in + most `src/*.c` files. Add `/* IWYU pragma: keep */` to includes in + `src/fileutil.c` that are needed on some platforms but not others so we can + remove the special exemptions to skip this file for the iwyu and iwyu-fix + targets in `CMakeLists.txt`. Also add some typecasts to `rollsum.[ch]` and + `patch.c` to silence warnings on Windows. (dbaarda, + https://github.com/librsync/librsync/pull/249) + +## librsync 2.3.3 + +Released 2023-02-16 + + * 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) + +## librsync 2.3.2 + +Released 2021-04-10 + + * Fix #214 heap corruption for too small kbloom. This could have crashed + delta operations for very small files/signatures. Strangely it didn't seem + to cause problems for most compilers/platforms, but did trigger errors for + new versions of MSVC. (ljusten, + https://github.com/librsync/librsync/pull/213) + + * Fix #207 and add Travis Windows checks and improve compatibility. Turn on + `-Wconversion -Wno-sign-conversion` warnings for clang. Add MSVC compiler + flags to turn off posix warnings. Make all code compile clean with no + warnings on all Travis platforms. Added cmake config checking for windows + `io.h` and improve `fileutil.c` for MSVC. Fix broken error handling in + `rs_file_copy_cb()`. Improved trace output, making it less spamy and more + consistent. Add patch checking for invalid literal lengths. Improve + internal variable and argument types. Add explicit type conversions. + (dbaarda, https://github.com/librsync/librsync/pull/208) + + * Fix a bug so patch will now fail returning RS_CORRUPT on encountering a + zero length copy command instead of hanging. Make copy_cb() copying more + data than requested an assert-fail on debug builds, and a log-warning for + release builds. Make trace output a little less spammy about copy_cb() + return values. (dbaarda, https://github.com/librsync/librsync/pull/206) + +## librsync 2.3.1 + +Released 2020-05-19 + + * Fix #198 cmake popt detection using pkg-config and #199 test scripts on + FreeBSD. Fixes and tidies FindPOPT.cmake and Findlibb2.cmake to use + pkg-config correctly and behave more like official FindPackage() cmake + modules. Makes all test scripts use /bin/sh instead of /bin/bash. (dbaarda, + mandree https://github.com/librsync/librsync/pull/200) + + * Change default block_len to always be a multiple of the blake2b 128 byte + blocksize for efficiency. Tidy and update docs to explain using + rs_sig_args() and rs_build_hash_table(), add rs_file_*() utils, and + document new magic types. Remove really obsolete entries in TODO.md. Update + to Doxygen 1.8.16. (dbaarda, https://github.com/librsync/librsync/pull/195) + + * Improve hashtable performance by adding a small optional bloom filter, + reducing max loadfactor from 80% to 70%, Fix hashcmp_count stats to include + comparing against empty buckets. This speeds up deltas by 20%~50%. + (dbaarda, https://github.com/librsync/librsync/pull/192, + https://github.com/librsync/librsync/pull/193, + https://github.com/librsync/librsync/pull/196) + + * Optimize rabinkarp_update() by correctly using unsigned constants and + manually unrolling the loop for best performance. (dbaarda, + https://github.com/librsync/librsync/pull/191) + +## librsync 2.3.0 + +Released 2020-04-07 + + * Bump minor version from 2.2.1 to 2.3.0 to reflect additional rs_sig_args() + and strong_len=-1 support. + + * Add public rs_sig_args() function for getting the recommend signature args + from the file size. Added support to rdiff for `--sum-size=-1` to indicate + "use minimum size safe against random block collisions". Added warning + output for sum-sizes that are too small to be safe. Fixed possible rdiff + bug affecting popt parsing on non-little-endian platforms. (dbaarda, + https://github.com/librsync/librsync/pull/109) + + * Fixed yet more compiler warnings for various platforms/compilers. + (Adsun701, texierp, https://github.com/librsync/librsync/pull/187, + https://github.com/librsync/librsync/pull/188) + + * Improved cmake popt handling to find popt dependencies using PkgConfig. + (ffontaine, https://github.com/librsync/librsync/pull/186) + + * Tidied internal code and improved tests for netint.[ch], tube.c, and + hashtable.h. (dbaarda, https://github.com/librsync/librsync/pull/183 + https://github.com/librsync/librsync/pull/185). + + * Improved C99 compatibility. Add `-std=c99 -pedantic` to `CMAKE_C_FLAGS` for + gcc and clang. Fix all C99 warnings by making all code C99 compliant. Tidy + all CMake checks, `#cmakedefines`, and `#includes`. Fix 64bit support for + mdfour checksums (texierp, dbaarda, + https://github.com/librsync/librsync/pull/181, + https://github.com/librsync/librsync/pull/182) + + * Usage clarified in rdiff (1) man page. (AaronM04, + https://github.com/librsync/librsync/pull/180) + +## librsync 2.2.1 + +Released 2019-10-16 + + * Fix #176 hangs calculating deltas for files larger than 4GB. (dbaarda, + https://github.com/librsync/librsync/pull/177) + +## librsync 2.2.0 + +Released 2019-10-12 + + * Bump minor version from 2.1.0 to 2.2.0 to reflect additional RabinKarp + rollsum support. + + * Fix MSVC builds by adding missing LIBRSYNC_EXPORT to variables in + librsync.h, add -DLIBRSYNC_STATIC_DEFINE to the sumset_test target, + and correctly install .dll files in the bin directory. + (adsun701, https://github.com/librsync/librsync/pull/161) + + * Add RabinKarp rollsum support and make it the default. RabinKarp is a much + better rolling hash, which reduces the risk of hash collision corruption + and speeds up delta calculations. The rdiff cmd gets a new `-R + (rollsum|rabinkarp)` argument with the default being `rabinkarp`, Use `-R + rollsum` to generate backwards-compatible signatures. (dbaarda, + https://github.com/librsync/librsync/issues/3) + + * Use single-byte literal commands for small inserts in deltas. This makes + each small insert use 1 less byte in deltas. (dbaarda, + https://github.com/librsync/librsync/issues/120) + + * Fix multiple warnings (cross-)compiling for windows. (Adsun701, + https://github.com/librsync/librsync/pull/165, + https://github.com/librsync/librsync/pull/166) + + * Change rs_file_size() to report -1 instead of 0 for unknown file sizes (not + a regular file). (dbaarda https://github.com/librsync/librsync/pull/168) + + * Add cmake BUILD_SHARED_LIBS option for static library support. + BUILD_SHARED_LIBS defaults to ON, and can be set to OFF using `ccmake .` to + build librsync as a static library. (dbaarda + https://github.com/librsync/librsync/pull/169) + + * Fix compile errors and add .gitignore entries for MSVS 2019. Fixes + hashtable.h to be C99 compliant. (ardovm + https://github.com/librsync/librsync/pull/170) + +## librsync 2.1.0 + +Released 2019-08-19 + + * Bump minor version from 2.0.3 to 2.1.0 to reflect additions to librsync.h. + + * Fix exporting of private symbols from librsync library. Add export of + useful large file functions `rs_file_open()`, `rs_file_close()`, and + `rs_file_size()` to librsync.h. Add export of `rs_signature_log_stats()` to + log signature hashtable hit/miss stats. Improve rdiff error output. + (dbaarda, https://github.com/librsync/librsync/issues/130) + + * Updated release process to include stable tarballs. (dbaarda, + https://github.com/librsync/librsync/issues/146) + + * Remove redundant and broken `--paranoia` argument from rdiff. (dbaarda, + https://github.com/librsync/librsync/issues/155) + + * Fix memory leak of `rs_signature_t->block_sigs` when freeing signatures. + (telles-simbiose, https://github.com/librsync/librsync/pull/147) + + * Document delta file format. (zmj, + https://github.com/librsync/librsync/issues/46) + + * Fix up doxygen comments. (dbaarda, + https://github.com/librsync/librsync/pull/151) + +## librsync 2.0.2 + +Released 2018-02-27 + + * Improve CMake install paths configuration (wRAR, + https://github.com/librsync/librsync/pull/133) and platform support + checking when cross-compiling (fornwall, + https://github.com/librsync/librsync/pull/136). + + * Fix Unaligned memory access for rs_block_sig_init() (dbaarda, + https://github.com/librsync/librsync/issues/135). + + * Fix hashtable_test.c name collision for key_t in sys/types.h on some + platforms (dbaarda, https://github.com/librsync/librsync/issues/134) + + * Format code with consistent style, adding `make tidy` and `make + tidyc` targets for reformating code and comments. (dbaarda, + https://github.com/librsync/librsync/issues/125) + + * Removed perl as a build dependency. Note it is still required for some + tests. (dbaarda, https://github.com/librsync/librsync/issues/75) + + * Update RPM spec file for v2.0.2 and fix cmake man page install. (deajan, + https://github.com/librsync/librsync/issues/47) + +## librsync 2.0.1 + +Released 2017-10-17 + + * Extensively reworked Doxygen documentation, now available at + http://librsync.sourcefrog.net/ (Martin Pool) + + * Removed some declarations from librsync.h that were unimplemented or no + longer ever useful: `rs_work_options`, `rs_accum_value`. Remove + declaration of unimplemented `rs_mdfour_file()`. (Martin Pool) + + * Remove shipped `snprintf` code: no longer acutally linked after changing to + CMake, and since it's part of C99 it should be widely available. + (Martin Pool) + + * Document that Ninja (http://ninja-build.org/) is supported under CMake. + It's a bit faster and nicer than Make. (Martin Pool) + + * `make check` (or `ninja check` etc) will now build and run the tests. + Previously due to a CMake limitation, `make test` would only run existing + tests and could fail if they weren't built. + (Martin Pool, https://github.com/librsync/librsync/issues/49) + + * Added cmake options to exclude rdiff target and compression from build. + See install documentation for details. Thanks to Michele Bertasi. + + * `popt` is only needed when `rdiff` is being built. (gulikoza) + + * Improved large file support for platforms using different variants + of `fseek` (`fseeko`, `fseeko64`, `_fseeki64`), `fstat` (`fstat64`, + `_fstati64`), and `fileno` (`_fileno`). (dbaarda, charlievieth, + gulikoza, marius-nicolae) + + * `rdiff -s` option now shows bytes read/written and speed. (gulikoza). + For delta operations it also shows hashtable match statistics. (dbaarda) + + * Running rdiff should not overwrite existing files (signatures, deltas and + new patched files) by default. If the destination file exists, rdiff will + now exit with an error. Add new option -f (--force) to overwrite existing + files. (gulikoza) + + * Improve signature memory allocation (doubling size instead of calling + realloc for every sig block) and added support for preallocation. See + streaming.md job->estimated_signature_count for usage when using the + library. `rdiff` uses this by default if possible. (gulikoza, dbaarda) + + * Significantly tidied signature handling code and testing, resulting in more + consistent error handling behaviour, and making it easier to plug in + alternative weak and strong sum implementations. Also fixed "slack delta" + support for delta calculation with no signature. (dbaarda) + + * `stdint.h` and `inttypes.h` from C99 is now required. Removed redundant + librsync-config.h header file. (dbaarda) + + * Lots of small fixes for windows platforms and building with MSVC. + (lasalvavida, mbrt, dbaarda) + + * New open addressing hashtable implementation that significantly speeds up + delta operations, particularly for large files. Also fixed degenerate + behaviour with large number of duplicate blocks like runs of zeros + in sparse files. (dbaarda) + + * Optional support with cmake option for using libb2 blake2 implementation. + Also updated included reference blake2 implementation with bug fixes + (dbaarda). + + * Improved default values for input and output buffer sizes. The defaults are + now --input-size=0 and --output-size=0, which will choose recommended + default sizes based on the --block-size and the operation being performed. + (dbaarda) + + * Fixed hanging for truncated input files. It will now correctly report an + error indicating an unexpected EOF was encountered. (dbaarda, + https://github.com/librsync/librsync/issues/32) + + * Fixed #13 so that faster slack delta's are used for signatures of + empty files. (dbaarda, + https://github.com/librsync/librsync/issues/13) + + * Fixed #33 so rs_job_iter() doesn't need calling twice with eof=1. + Also tidied and optimized it a bit. (dbaarda, + https://github.com/librsync/librsync/issues/33) + + * Fixed #55 remove excessive rs_fatal() calls, replacing checks for + programming errors with assert statements. Now rs_fatal() will only + be called for rare unrecoverable fatal errors like malloc failures or + impossibly large inputs. (dbaarda, + https://github.com/librsync/librsync/issues/55) + +## librsync 2.0.0 + +Released 2015-11-29 + +Note: despite the major version bump, this release has few changes and should +be binary and API compatible with the previous version. + + * Bump librsync version number to 2.0, to match the library + soname/dylib version. + (Martin Pool, https://github.com/librsync/librsync/issues/48) + +## librsync 1.0.1 (2015-11-21) + + * Better performance on large files. (VictorDenisov) + + * Add comment on usage of rs_build_hash_table(), and assert correct use. + Callers must call rs_build_hash_table() after loading the signature, + and before calling rs_delta_begin(). + Thanks to Paul Harris + + * Switch from autoconf to CMake. + + Thanks to Adam Schubert. + +## librsync 1.0.0 (2015-01-23) + + * SECURITY: CVE-2014-8242: librsync previously used a truncated MD4 + "strong" check sum to match blocks. However, MD4 is not cryptographically + strong. It's possible that an attacker who can control the contents of one + part of a file could use it to control other regions of the file, if it's + transferred using librsync/rdiff. For example this might occur in a + database, mailbox, or VM image containing some attacker-controlled data. + + To mitigate this issue, signatures will by default be computed with a + 256-bit BLAKE2 hash. Old versions of librsync will complain about a + bad magic number when given these signature files. + + Backward compatibility can be obtained using the new + `rdiff sig --hash=md4` + option or through specifying the "signature magic" in the API, but + this should not be used when either the old or new file contain + untrusted data. + + Deltas generated from those signatures will also use BLAKE2 during + generation, but produce output that can be read by old versions. + + See https://github.com/librsync/librsync/issues/5 + + Thanks to Michael Samuel for reporting this and offering an + initial patch. + + * Various build fixes, thanks Timothy Gu. + + * Improved rdiff man page from Debian. + + * Improved librsync.spec file for building RPMs. + + * Fixed bug #1110812 'internal error: job made no progress'; on large + files. + + * Moved hosting to https://github.com/librsync/librsync/ + + * Travis-CI.org integration test at https://travis-ci.org/librsync/librsync/ + + * You can set `$LIBTOOLIZE` before running `autogen.sh`, for example on + OS X Homebrew where it is called `glibtoolize`. + +## 0.9.7 (released 2004-10-10) + + * Yet more large file support fixes. + + * `extern "C"` guards in librsync.h to let it be used from C++. + + * Removed Debian files from dist tarball. + + * Changed rdiff to an installed program on "make install". + + * Refactored delta calculation code to be cleaner and faster. + + * \#879763: Fixed mdfour to work on little-endian machines which don't + like unaligned word access. This should make librsync work on + pa-risc, and it makes it slightly faster on ia64. + + * \#1022764: Fix corrupted encoding of some COPY commands in large + files. + + * \#1024881: Print long integers directly, rather than via casts to + double. + + * Fix printf formats for size_t: both the format and the argument + should be cast to long. + +## 0.9.6 + + * Large file support fixes. + + * [v]snprintf or _[v]snprintf autoconf replacement function fix. + + * Changed installed include file from rsync.h to librsync.h. + + * Migration to sourceforge for hosting. + + * Rollsum bugfix that produces much smaller deltas. + + * Memory leaks bugfix patches. + + * mdfour bigendian and >512M bugfix, plus optimisations patch. + + * autoconf/automake updates and cleanups for autoconf 2.53. + + * Windows compilation patch, heavily modified. + + * MacOSX compilation patch, modified to autoconf vararg macro fix. + + * Debian package build scripts patch. + +## 0.9.5 + + * Bugfix patch from Shirish Hemant Phatak + +## 0.9.4: (library 1.1.0) + + * Fixes for rsync.h from Thorsten Schuett + + * RLL encoding fix from Shirish Hemant Phatak + + * RPM spec file by Peter J. Braam + + * No (intentional) changes to binary API. + +## 0.9.3 + + * Big speed improvements in MD4 routines and generation of weak + checksums. + + * Patch to build on FreeBSD by Jos Backus + + * Suggestions to build on Solaris 2.6 from Alberto Accomazzi + + + * Add rs_job_drive, a generic mechanism for turning the library into + blocking mode. rs_whole_run now builds on top of this. The + filebuf interface has changed a little to accomodate it. + + * Generating and loading signatures now generates statistics. + + * More test cases. + + * I suspect there may be a bug in rolling checksums, but it probably + only causes inefficiency and not corruption. + + * Portability fixes for alphaev67-dec-osf5.1; at the moment builds + but does not work because librsync tries to do unaligned accesses. + + * Works on sparc64-unknown-linux-gnu (Debian/2.2) + +## 0.9.2 + + * Improve delta algorithm so that deltas are actually + delta-compressed, rather than faked. + +## 0.9.1 + + * Rename the library to `librsync'. + + * Portability fixes. + + * Include the popt library, and use it to build rdiff if the library + is not present on the host. + + * Add file(1) magic for rdiff. + + * Add more to the manual pages. + + * It's no longer necessary to call rs_buffers_init on a stream before + starting to use it: all the internal data is kept in the job, not + in the stream. + + * Rename rs_stream_t to rs_buffers_t, a more obvious name. Pass the + buffers to every rs_job_iter() call, rather than setting it at + startup. Similarly for all the _begin() functions. + + * rs_job_new also takes the initial state function. + + * Return RS_PARAM_ERROR when library is misused. + +## 0.9.0 + + * Redesign API to be more like zlib/bzlib. + + * Put all command-line functions into a single rdiff(1) program. + + * New magic number `rs6' + + * Change to using popt for command line parsing. + + * Use Doxygen for API documentation. + +## 0.5.7 + + * Changes stats string format. + + * Slightly improved test cases + +## 0.5.6 + + * Don't install debugging tools into /usr/local/bin; leave them in + the source directory. + + * Fix libhsync to build on (sgi-mips, IRIX64, gcc, GNU Make) + + * Include README.CVS in tarball + + * Back out of using libtool and shared libraries, as it is + unnecessary at this stage, complicates installation and slows down + compilation. + + * Use mapptr when reading data to decode, so that decoding should + have less latency and be more reliable. + + * Cope better on systems that are missing functions like snprintf. + +## 0.5.5 + + * Put genuine search encoding back into the nad algorithm, and + further clean up the nad code. Literals are now sent out using a + literal buffer integrated with the input mapptr so that data is not + copied. Checksums are still calculated from scratch each time + rather than by rolling -- this is very slow but simple. + + * Reshuffle test cases so that they use files generated by hsmapread, + rather than the source directory. This makes the tests quicker and + more reproducible, hopefully without losing coverage. Further + develop the test driver framework. + + * Add hsdumpsums debugging tool. + + * Hex strings (eg strong checksums) are broken up by underscores for + readability. + + * Stats now go to the log rather than stdout. + + * mapptr acts properly when we're skipping/rewinding to data already + present in the buffer -- it does a copy if required, but not + necessarily real IO. + +## 0.5.4 + + * Improved mapptr input code + + * Turn on more warnings if using gcc + + * More test cases + +## 0.5.3 + + * Improvements to mapptr to make it work better for network IO. + + * Debug trace code is compiled in unless turned off in ./configure + (although most programs will not write it out unless asked.) + + * Add libhsyncinfo program to show compiled-in settings and version. + + * Add test cases that run across localhost TCP sockets. + + * Improved build code; should now build easily from CVS through + autogen.sh. + + * Improved trace code. + + * Clean up to build on sparc-sun-solaris2.8, and in the process clean + up the handling of bytes vs chars, and of building without gcc + + * Reverse build scripts so that driver.sh calls the particular + script. + +## 0.5.2 + + * Use mapptr for input. + + * Implement a new structure for encoding in nad.c. It doesn't + encode at the moment, but it's much more maintainable. + + * More regression cases. + + * Clean up build process. + +## 0.5.0 + + * Rewrite hs_inbuf and hs_encode to make them simpler and more + reliable. + + * Test cases for input handling. + + * Use the map_ptr idea for input from both streams and files. + +## 0.4.1 + + * automake/autoconf now works cleanly when the build directory is + different to the source directory. + + * --enable-ccmalloc works again. + +## 0.4.0 + +* A much better regression suite. + +* CHECKSUM token includes the file's checksum up to the current + location, to aid in self-testing. + +* Various bug fixes, particularly to do with short IO returns. diff --git a/PCbuild/PCbuild.dsw b/PCbuild/PCbuild.dsw deleted file mode 100644 index aec1e972..00000000 --- a/PCbuild/PCbuild.dsw +++ /dev/null @@ -1,29 +0,0 @@ -Microsoft Developer Studio Workspace File, Format Version 6.00 -# WARNING: DO NOT EDIT OR DELETE THIS WORKSPACE FILE! - -############################################################################### - -Project: "rdiff"=".\rdiff.dsp" - Package Owner=<4> - -Package=<5> -{{{ -}}} - -Package=<4> -{{{ -}}} - -############################################################################### - -Global: - -Package=<5> -{{{ -}}} - -Package=<3> -{{{ -}}} - -############################################################################### - diff --git a/PCbuild/config.h b/PCbuild/config.h deleted file mode 100644 index 35eb0f92..00000000 --- a/PCbuild/config.h +++ /dev/null @@ -1,220 +0,0 @@ -/* config.h. Generated by configure. */ -/* config.h.in. Generated from configure.ac by autoheader. */ - -/* Define to one of `_getb67', `GETB67', `getb67' for Cray-2 and Cray-YMP - systems. This function is required for `alloca.c' support on those systems. - */ -/* #undef CRAY_STACKSEG_END */ - -/* Define to 1 if using `alloca.c'. */ -/* #undef C_ALLOCA */ - -/* Define this to enable trace code */ -/* #undef DO_RS_TRACE */ - -/* Define to 1 if you have `alloca', as a function or macro. */ -#define HAVE_ALLOCA 1 - -/* Define to 1 if you have and it should be used (not on Ultrix). - */ -/* #undef HAVE_ALLOCA_H */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_BZLIB_H */ - -/* Define to 1 if you have the `dgettext' function. */ -/* #undef HAVE_DGETTEXT */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_DLFCN_H */ - -/* Define to 1 if you have the header file. */ -#define HAVE_FCNTL_H 1 - -/* Define to 1 if fseeko (and presumably ftello) exists and is declared. */ -/* #undef HAVE_FSEEKO */ - -/* Define to 1 if you have the `gettext' function. */ -/* #undef HAVE_GETTEXT */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_INTTYPES_H */ - -/* Define to 1 if you have the `bz2' library (-lbz2). */ -/* #undef HAVE_LIBBZ2 */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_LIBINTL_H */ - -/* Define to 1 if you have the `popt' library (-lpopt). */ -/* #undef HAVE_LIBPOPT */ - -/* Define to 1 if you have the `z' library (-lz). */ -/* #undef HAVE_LIBZ */ - -/* Define to 1 if you have the header file. */ -#define HAVE_LIMITS_H 1 - -/* Define to 1 if you have the header file. */ -#define HAVE_MALLOC_H 1 - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_MCHECK_H */ - -/* Define to 1 if you have the `memmove' function. */ -#define HAVE_MEMMOVE 1 - -/* Define to 1 if you have the header file. */ -#define HAVE_MEMORY_H 1 - -/* Define to 1 if you have the `memset' function. */ -#define HAVE_MEMSET 1 - -/* GNU extension of saving argv[0] to program_invocation_short_name */ -/* #undef HAVE_PROGRAM_INVOCATION_NAME */ - -/* Define to 1 if you have the `snprintf' function. */ -/* #undef HAVE_SNPRINTF */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_STDINT_H */ - -/* Define to 1 if you have the header file. */ -#define HAVE_STDLIB_H 1 - -/* Define to 1 if you have the `strchr' function. */ -#define HAVE_STRCHR 1 - -/* Define to 1 if you have the `strerror' function. */ -#define HAVE_STRERROR 1 - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_STRINGS_H */ - -/* Define to 1 if you have the header file. */ -#define HAVE_STRING_H 1 - -/* Define to 1 if you have the `strtol' function. */ -#define HAVE_STRTOL 1 - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_SYS_FILE_H */ - -/* Define to 1 if you have the header file. */ -#define HAVE_SYS_STAT_H 1 - -/* Define to 1 if you have the header file. */ -#define HAVE_SYS_TYPES_H 1 - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_UNISTD_H */ - -/* Define if your cpp has vararg macros */ -/* #undef HAVE_VARARG_MACROS */ - -/* Define to 1 if you have the `vsnprintf' function. */ -/* #undef HAVE_VSNPRINTF */ - -/* Define to 1 if you have the header file. */ -/* #undef HAVE_ZLIB_H */ - -/* Define to 1 if you have the `_snprintf' function. */ -#define HAVE__SNPRINTF 1 - -/* Define to 1 if you have the `_vsnprintf' function. */ -#define HAVE__VSNPRINTF 1 - -/* Name of package */ -#define PACKAGE "librsync" - -/* Define to the address where bug reports for this package should be sent. */ -#define PACKAGE_BUGREPORT "" - -/* Define to the full name of this package. */ -#define PACKAGE_NAME "librsync" - -/* Define to the full name and version of this package. */ -#define PACKAGE_STRING "librsync 0.9.6" - -/* Define to the one symbol short name of this package. */ -#define PACKAGE_TARNAME "librsync" - -/* Define to the version of this package. */ -#define PACKAGE_VERSION "0.9.6" - -/* Canonical GNU hostname */ -#define RS_CANONICAL_HOST "i686-pc-cygwin" - -/* Version of the libtool interface. */ -#define RS_LIBVERSION "1:2:0" - -/* The size of a `int', as computed by sizeof. */ -#define SIZEOF_INT 4 - -/* The size of a `long', as computed by sizeof. */ -#define SIZEOF_LONG 4 - -/* The size of a `long long', as computed by sizeof. */ -#define SIZEOF_LONG_LONG 0 - -/* The size of a `off_t', as computed by sizeof. */ -#define SIZEOF_OFF_T 4 - -/* The size of a `short', as computed by sizeof. */ -#define SIZEOF_SHORT 2 - -/* The size of a `size_t', as computed by sizeof. */ -#define SIZEOF_SIZE_T 4 - -/* The size of a `unsigned char', as computed by sizeof. */ -#define SIZEOF_UNSIGNED_CHAR 1 - -/* The size of a `unsigned int', as computed by sizeof. */ -#define SIZEOF_UNSIGNED_INT 4 - -/* The size of a `unsigned long', as computed by sizeof. */ -#define SIZEOF_UNSIGNED_LONG 4 - -/* The size of a `unsigned short', as computed by sizeof. */ -#define SIZEOF_UNSIGNED_SHORT 2 - -/* If using the C implementation of alloca, define if you know the - direction of stack growth for your system; otherwise it will be - automatically deduced at run-time. - STACK_DIRECTION > 0 => grows toward higher addresses - STACK_DIRECTION < 0 => grows toward lower addresses - STACK_DIRECTION = 0 => direction of growth unknown */ -/* #undef STACK_DIRECTION */ - -/* Define to 1 if you have the ANSI C header files. */ -#define STDC_HEADERS 1 - -/* Version number of package */ -#define VERSION "0.9.6" - -/* Define to 1 if your processor stores words with the most significant byte - first (like Motorola and SPARC, unlike Intel and VAX). */ -/* #undef WORDS_BIGENDIAN */ - -/* Number of bits in a file offset, on hosts where this is settable. */ -/* #undef _FILE_OFFSET_BITS */ - -/* Enable GNU extensions on systems that have them. */ -#ifndef _GNU_SOURCE -# define _GNU_SOURCE 1 -#endif - -/* Define to 1 to make fseeko visible on some hosts (e.g. glibc 2.2). */ -/* #undef _LARGEFILE_SOURCE */ - -/* Define for large files, on AIX-style hosts. */ -/* #undef _LARGE_FILES */ - -/* Define to empty if `const' does not conform to ANSI C. */ -/* #undef const */ - -/* Define to `long' if does not define. */ -/* #undef off_t */ - -/* Define to `unsigned' if does not define. */ -/* #undef size_t */ diff --git a/PCbuild/librsync-config.h b/PCbuild/librsync-config.h deleted file mode 100644 index 88da4162..00000000 --- a/PCbuild/librsync-config.h +++ /dev/null @@ -1,40 +0,0 @@ -/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*- - * - * librsync -- library for network deltas - * - * Copyright (C) 2000, 2001 by Martin Pool - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation; either version 2.1 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -/** \file librsync-config.h - * - * \brief System-specific configuration for librsync.h. - */ - -#ifndef _LIBRSYNC_CONFIG_H -#define _LIBRSYNC_CONFIG_H - -/** - * \brief A long integer type that can handle the largest file - * offsets. - * - * Perhaps this might have to be configured to be 'long long', 'long', - * or something else depending on the platform. On WIN32, many config.h's - * define LONG_LONG as "__int64". - */ -typedef long rs_long_t; - -#endif /* _LIBRSYNC_CONFIG_H */ diff --git a/PCbuild/rdiff.dsp b/PCbuild/rdiff.dsp deleted file mode 100644 index 01306f85..00000000 --- a/PCbuild/rdiff.dsp +++ /dev/null @@ -1,341 +0,0 @@ -# Microsoft Developer Studio Project File - Name="rdiff" - Package Owner=<4> -# Microsoft Developer Studio Generated Build File, Format Version 6.00 -# ** DO NOT EDIT ** - -# TARGTYPE "Win32 (x86) Application" 0x0101 - -CFG=rdiff - Win32 Debug -!MESSAGE This is not a valid makefile. To build this project using NMAKE, -!MESSAGE use the Export Makefile command and run -!MESSAGE -!MESSAGE NMAKE /f "rdiff.mak". -!MESSAGE -!MESSAGE You can specify a configuration when running NMAKE -!MESSAGE by defining the macro CFG on the command line. For example: -!MESSAGE -!MESSAGE NMAKE /f "rdiff.mak" CFG="rdiff - Win32 Debug" -!MESSAGE -!MESSAGE Possible choices for configuration are: -!MESSAGE -!MESSAGE "rdiff - Win32 Release" (based on "Win32 (x86) Application") -!MESSAGE "rdiff - Win32 Debug" (based on "Win32 (x86) Application") -!MESSAGE - -# Begin Project -# PROP AllowPerConfigDependencies 0 -# PROP Scc_ProjName "" -# PROP Scc_LocalPath "" -CPP=cl.exe -MTL=midl.exe -RSC=rc.exe - -!IF "$(CFG)" == "rdiff - Win32 Release" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 0 -# PROP BASE Output_Dir "Release" -# PROP BASE Intermediate_Dir "Release" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 0 -# PROP Output_Dir "Release" -# PROP Intermediate_Dir "Release" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /YX /FD /c -# ADD CPP /nologo /W3 /GX /O2 /I "." /I ".." /I "../popt" /D "NDEBUG" /D "WIN32" /D "_CONSOLE" /D "_MBCS" /YX /FD /c -# ADD BASE MTL /nologo /D "NDEBUG" /mktyplib203 /win32 -# ADD MTL /nologo /D "NDEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0xc09 /d "NDEBUG" -# ADD RSC /l 0xc09 /d "NDEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /subsystem:windows /machine:I386 -# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /subsystem:console /machine:I386 -# SUBTRACT LINK32 /pdb:none - -!ELSEIF "$(CFG)" == "rdiff - Win32 Debug" - -# PROP BASE Use_MFC 0 -# PROP BASE Use_Debug_Libraries 1 -# PROP BASE Output_Dir "Debug" -# PROP BASE Intermediate_Dir "Debug" -# PROP BASE Target_Dir "" -# PROP Use_MFC 0 -# PROP Use_Debug_Libraries 1 -# PROP Output_Dir ".." -# PROP Intermediate_Dir "Debug" -# PROP Ignore_Export_Lib 0 -# PROP Target_Dir "" -# ADD BASE CPP /nologo /W3 /Gm /GX /ZI /Od /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /YX /FD /GZ /c -# ADD CPP /nologo /W3 /Gm /GX /ZI /Od /I "." /I ".." /I "../popt" /D "_DEBUG" /D "WIN32" /D "_CONSOLE" /D "_MBCS" /YX /FD /GZ /c -# ADD BASE MTL /nologo /D "_DEBUG" /mktyplib203 /win32 -# ADD MTL /nologo /D "_DEBUG" /mktyplib203 /win32 -# ADD BASE RSC /l 0xc09 /d "_DEBUG" -# ADD RSC /l 0xc09 /d "_DEBUG" -BSC32=bscmake.exe -# ADD BASE BSC32 /nologo -# ADD BSC32 /nologo -LINK32=link.exe -# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /subsystem:windows /debug /machine:I386 /pdbtype:sept -# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /subsystem:console /debug /machine:I386 /pdbtype:sept -# SUBTRACT LINK32 /pdb:none - -!ENDIF - -# Begin Target - -# Name "rdiff - Win32 Release" -# Name "rdiff - Win32 Debug" -# Begin Group "Source Files" - -# PROP Default_Filter "cpp;c;cxx;rc;def;r;odl;idl;hpj;bat" -# Begin Source File - -SOURCE=..\base64.c -# End Source File -# Begin Source File - -SOURCE=..\buf.c -# End Source File -# Begin Source File - -SOURCE=..\checksum.c -# End Source File -# Begin Source File - -SOURCE=..\command.c -# End Source File -# Begin Source File - -SOURCE=..\delta.c -# End Source File -# Begin Source File - -SOURCE=..\emit.c -# End Source File -# Begin Source File - -SOURCE=..\fileutil.c -# End Source File -# Begin Source File - -SOURCE=..\popt\findme.c -# End Source File -# Begin Source File - -SOURCE=..\hex.c -# End Source File -# Begin Source File - -SOURCE=..\isprefix.c -# End Source File -# Begin Source File - -SOURCE=..\job.c -# End Source File -# Begin Source File - -SOURCE=..\mdfour.c -# End Source File -# Begin Source File - -SOURCE=..\mksum.c -# End Source File -# Begin Source File - -SOURCE=..\msg.c -# End Source File -# Begin Source File - -SOURCE=..\netint.c -# End Source File -# Begin Source File - -SOURCE=..\patch.c -# End Source File -# Begin Source File - -SOURCE=..\popt\popt.c -# End Source File -# Begin Source File - -SOURCE=..\popt\poptconfig.c -# End Source File -# Begin Source File - -SOURCE=..\popt\popthelp.c -# End Source File -# Begin Source File - -SOURCE=..\popt\poptparse.c -# End Source File -# Begin Source File - -SOURCE=..\prototab.c -# End Source File -# Begin Source File - -SOURCE=..\rdiff.c -# End Source File -# Begin Source File - -SOURCE=..\readsums.c -# End Source File -# Begin Source File - -SOURCE=..\scoop.c -# End Source File -# Begin Source File - -SOURCE=..\search.c -# End Source File -# Begin Source File - -SOURCE=..\stats.c -# End Source File -# Begin Source File - -SOURCE=..\stream.c -# End Source File -# Begin Source File - -SOURCE=..\sumset.c -# End Source File -# Begin Source File - -SOURCE=..\trace.c -# End Source File -# Begin Source File - -SOURCE=..\tube.c -# End Source File -# Begin Source File - -SOURCE=..\util.c -# End Source File -# Begin Source File - -SOURCE=..\version.c -# End Source File -# Begin Source File - -SOURCE=..\whole.c -# End Source File -# End Group -# Begin Group "Header Files" - -# PROP Default_Filter "h;hpp;hxx;hm;inl" -# Begin Source File - -SOURCE=..\acconfig.h -# End Source File -# Begin Source File - -SOURCE=..\buf.h -# End Source File -# Begin Source File - -SOURCE=..\checksum.h -# End Source File -# Begin Source File - -SOURCE=..\command.h -# End Source File -# Begin Source File - -SOURCE=.\config.h -# End Source File -# Begin Source File - -SOURCE=..\emit.h -# End Source File -# Begin Source File - -SOURCE=..\fileutil.h -# End Source File -# Begin Source File - -SOURCE=..\popt\findme.h -# End Source File -# Begin Source File - -SOURCE=..\isprefix.h -# End Source File -# Begin Source File - -SOURCE=..\job.h -# End Source File -# Begin Source File - -SOURCE=".\librsync-config.h" -# End Source File -# Begin Source File - -SOURCE=..\librsync.h -# End Source File -# Begin Source File - -SOURCE=..\netint.h -# End Source File -# Begin Source File - -SOURCE=..\popt\popt.h -# End Source File -# Begin Source File - -SOURCE=..\popt\poptint.h -# End Source File -# Begin Source File - -SOURCE=..\protocol.h -# End Source File -# Begin Source File - -SOURCE=..\prototab.h -# End Source File -# Begin Source File - -SOURCE=..\search.h -# End Source File -# Begin Source File - -SOURCE=..\snprintf.h -# End Source File -# Begin Source File - -SOURCE=..\stream.h -# End Source File -# Begin Source File - -SOURCE=..\sumset.h -# End Source File -# Begin Source File - -SOURCE=..\popt\system.h -# End Source File -# Begin Source File - -SOURCE=..\trace.h -# End Source File -# Begin Source File - -SOURCE=..\types.h -# End Source File -# Begin Source File - -SOURCE=..\util.h -# End Source File -# Begin Source File - -SOURCE=..\whole.h -# End Source File -# End Group -# Begin Group "Resource Files" - -# PROP Default_Filter "ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe" -# End Group -# End Target -# End Project diff --git a/README.RPM b/README.RPM index 4a7c3855..10af3e58 100644 --- a/README.RPM +++ b/README.RPM @@ -5,4 +5,3 @@ To do this, simply execute the command: rpm -ta librsync-0.9.3.tar.gz -$Id$ diff --git a/README.md b/README.md index 4feb3878..dbe65640 100644 --- a/README.md +++ b/README.md @@ -1,146 +1,80 @@ -# librsync +# README -librsync implements the rolling-checksum algorithm of remote file -synchronization that was popularized by the rsync utility. +http://librsync.sourcefrog.net/ -This algorithm transfers the differences between 2 files without -needing both files on the same system. +\copyright -*librsync does not implement the rsync wire protocol. If you want to talk to -an rsync server to transfer files you'll need to shell out to `rsync`. -You cannot make use of librsync to talk to an rsync server.* +Copyright 1999-2016 Martin Pool and other contributors. -librsync also does not include any network functions for talking to SSH -or any other server. To access a remote filesystem, you need to provide -your own code or make use of some other virtual filesystem layer. +librsync is distributed under the [GNU LGPL v2.1][LGPL] (see COPYING), which +basically means that you can dynamically link librsync into non-GPL programs, +but you must redistribute the librsync source, with any modifications you have +made. -librsync is for building other programs that transfer files as efficiently -as rsync. You can use librsync in a program you write to do backups, -distribute binary patches to programs, or sync directories to a server -or between peers. - -This tree also produces the `rdiff` command-line tool that exposes the key -operations of librsync: generating file signatures, generating the delta from a -signature to a new file, and applying the delta to regenerate the new file -given the old file. - -## Copyright - -librsync is Copyright 1999-2015 Martin Pool and others. - -librsync is distributed under the GNU LGPL v2.1 (see COPYING), which basically -means that you can dynamically link librsync into non-GPL programs, but you -must redistribute the librsync source, with any modifications you have made. +[LGPL]: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html librsync contains the BLAKE2 hash algorithm, written by Samuel Neves and -released under the CC0 public domain -dedication, . - -## Contact - -librsync's home is - -- https://github.com/librsync/librsync/ -- http://librsync.sourcefrog.net/ - -There are two mailing lists: - -- https://groups.google.com/forum/#!forum/librsync-announce -- https://groups.google.com/forum/#!forum/librsync - -There are some questions and answers about librsync on stackoverflow.com tagged -`librsync`. That is a good place to start if you have questions. - -## Requirements - -To build librsync you will need: - -* A C compiler and appropriate headers and libraries - -* Make - -* popt command line parsing library - - Available from http://rpm5.org/files/popt/ - - A cut-down version of popt1.5 is included and will be used - automatically if there is no popt library on your build host. - -* automake, libtool, and autoconf - -## Compiling - - $ ./autogen.sh - -To build and test librsync then do - - $ ./configure - $ make all check - -You can also do what's called a `VPATH` build, where the build products are -kept separate from the source tree: - - $ mkdir _build # for example - $ cd _build - $ ../configure && make check - -After building you can install `rdiff` and `librsync` for system-wide use. The -destination is controlled by `--prefix` and related options to `./configure`. - - $ sudo make install - -## Note for Windows - -With cygwin you can build using gcc as under a normal unix system. It -is also possible to compile under cygwin using MSVC++. You must have -environment variables needed by MSCV set using the Vcvars32.bat -script. With these variables set, you just do; - - $ ./configure.msc - $ make all check - -The PCbuild directory contains a project and pre-generated config -files for use with the MSVC++ IDE. This should be enought to compile -rdiff.exe without requiring cygwin. - -## Library Versions - -librsync uses the GNU libtool library versioning system, so the filename -does not correspond to the librsync release. To show the library release -and version, use the librsyncinfo tool. See libversions.txt for more -information. +released under the [CC0 public domain dedication][CC0]. -## Platforms +[CC0]: http://creativecommons.org/publicdomain/zero/1.0/ -librsync should be widely portable. Patches to fix portability bugs are -welcome. -## Documentation +## Introduction -Documentation for the rdiff command-line tool: +librsync is a library for calculating and applying network deltas, with an +interface designed to ease integration into diverse network applications. -- http://librsync.sourcefrog.net/doc/rdiff.html -- http://librsync.sourcefrog.net/doc/rdiff.pdf +librsync encapsulates the core algorithms of the rsync protocol, which help +with efficient calculation of the differences between two files. The rsync +algorithm is different from most differencing algorithms because it does not +require the presence of the two files to calculate the delta. Instead, it +requires a set of checksums of each block of one file, which together form a +signature for that file. Blocks at any position in the other file which have the same +checksum are likely to be identical, and whatever remains is the difference. -and for the library: +This algorithm transfers the differences between two files without needing +both files on the same system. -- http://librsync.sourcefrog.net/doc/librsync.html -- http://librsync.sourcefrog.net/doc/librsync.pdf +librsync is for building other programs that transfer files as efficiently as +rsync. You can use librsync in a program you write to do backups, distribute +binary patches to programs, or sync directories to a server or between peers. -These are all produced from the source tree. +This tree also produces the \ref page_rdiff that exposes the key operations of +librsync: generating file signatures, generating the delta from a signature to +a new file, and applying the delta to regenerate the new file given the old +file. -## Debugging +librsync was originally written for the rproxy experiment in delta-compression +for HTTP. librsync is used by: [Dropbox](https://dropbox.com/), +[rdiff-backup](http://www.nongnu.org/rdiff-backup/), +[Duplicity](http://www.nongnu.org/duplicity/), and others. (If you would like +to be listed here, let me know.) -If you are using GNU libc, you might like to use +### What librsync is not - MALLOC_CHECK_=2 ./rdiff +1. librsync does not implement the rsync wire protocol. If you want to talk to +an rsync server to transfer files you'll need to shell out to `rsync`. You +cannot make use of librsync to talk to an rsync server. -to detect some allocation bugs. +2. librsync does not deal with file metadata or structure, such as filenames, +permissions, or directories. To this library, a file is just a stream of +bytes. Higher-level tools can deal with such issues in a way appropriate to +their users. -librsync has annotations for the SPLINT static checking tool. +3. librsync also does not include any network functions for talking to SSH or +any other server. To access a remote filesystem, you need to provide your own +code or make use of some other virtual filesystem layer. -## Testing -You can run the tests with `make check`. +## More information -Tests are automatically run at https://travis-ci.org/librsync/librsync. +* \ref page_downloads +* \ref page_versioning +* \ref page_install +* \ref page_rdiff +* \ref page_librsync +* \ref page_formats +* \ref page_support +* [CONTRIBUTING](CONTRIBUTING.md) +* [NEWS](NEWS.md) +* [TODO](TODO.md) diff --git a/RELEASING.md b/RELEASING.md deleted file mode 100644 index e18f1e35..00000000 --- a/RELEASING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Releasing - -If you are making a new tarball release of librsync, follow this checklist: - -* AUTHORS - make sure all significant authors are included. - -* NEWS - make sure the top "Changes in X.Y.Z" is correct. - -* THANKS - make sure the bottom "Contributors for X.Y.Z" is correct. - -* configure.ac - make sure AC_INIT and librsync_libversion are right. - -* libversions.txt - make sure libversion is added. - -* librsync.spec - make sure version and URL are right. - -* PCBuild/config.h,librsync-config.h - update using configure.msc - using cygwin. - -Do a complete configure and distcheck to ensure everything is properly -configured, built, and tested: - - $ ./autogen.sh [OPTIONS] - $ ./configure - $ make distcheck - diff --git a/TODO.md b/TODO.md index 5b0a8c13..1106bb0d 100644 --- a/TODO.md +++ b/TODO.md @@ -1,106 +1,21 @@ -* Upload built documentation to librsync.sourcefrog.net, delete dead sites. +# TODO -* Change to using SCons or some other build system? Much easier to build - shared libraries than - Make, and possibly easier to build on Windows. +* We have a few functions to do with reading a netint, stashing + it somewhere, then moving into a different state. Is it worth + writing generic functions for that, or would it be too confusing? -* Documentation - - Would be nice... - - Most importantly, some kind of manpage for rdiff, since it's - closest to being an end-user tool. After that, some API - documentation. - - Can either persist in doing the API documentation through - Doxygen, though I don't think it's very well suited to C - libraries. Perhaps it's better to just write a manpage as a - regular document, describing the functions in the most sensible - order. - - At the moment, reStructuredText looks like a good bet for an - input format. - -* Change existing text documentation in README.* etc to use a single - consistant format, probably markdown. - -* Version numbering: perhaps keep release numbers in sync with - (Unix) library versions. - -* Fix up consecutive matches - - We often have several consecutive matches, and we can combine them - into a single COPY command. So far so good. - - In some inputs, there might be several identical blocks. - - When we're matching, we want to prefer to match a block that comes - just after the previous match, so that they'll join up nicely into - a single larger match. rsync does this; librsync doesn't at the - moment. It does cause a measurable problem. - - In fact, we could introduce an additional optimization over rsync. - Suppose that the block A occurs twice, once followed by B and once - by C. When we first match it, we'll probably make an arbitrary - choice of which one to use. But if we next observe C, then it - might be better to have given the offset of the A that precedes C, - so that they can be joined into a single copy operation. - - This might be a bit complex. You can imagine in fact needing an - arbitrarily deep lookback. - - As a simpler optimization, we might just try to prefer matching - blocks in the same order that they occur in the input. - - But for now we ought to at least check for consecutive blocks. - - On the other hand, abo says: - - In reality copy's are such a huge gain that merging them efficiently - is a bit of a non-issue. Each copy command is only a couple of - bytes... who cares if we output twice as many as we need to... it's - the misses that take up whole blocks of data that people will notice. - - I believe we are already outputing consecutive blocks as a single - "copy" command, but have you looked at the "search" code? We have far - more serious problems with the hash-table that need to be fixed first - :-) - - We are not getting all the hits that we could due to a limited - hash-table, and this is going to make a much bigger difference than - optimizing the copy commands. - * Optimisations and code cleanups; scoop.c: Scoop needs major refactor. Perhaps the API needs tweaking? - rsync.h: documentation refers to rs_work(), which has been replaced - by rs_job_iter. Vestigial rs_work_options enum typedef should be - removed. rs_buffers_s and rs_buffers_t should be one typedef? Just - how useful is rs_job_drive anyway? Not implemented, rs_accum_value - Not implemented rs_mdfour_file - - patch.c: rs_patch_s_copying() does alloc, copy free, when it could - just copy directly into rs_buffer_t buffer. This _does_ mean the - callback can't allocate it's own data, though this can be done by - checking if the callback changed the pointer. + rsync.h: rs_buffers_s and rs_buffers_t should be one typedef? mdfour.c: This code has a different API to the RSA code in libmd and is coupled with librsync in unhealthy ways (trace?). Recommend - changing to RSA API. - -* Create library for autoconf replacement functions - - Make libreplace.a library in dir replace/ for autoconf replacement - functions. Move snprintf.[ch] into this library. Add malloc.c, memcmp.c, - and realloc.c functions, uncommenting checks in configure.in. - - Add common.h header to centralise all configure driven "#if SOMETHING" - header variations, replacing them throughout code with #include "common.h". - - Make snprintf.c into two proper replacement functions for snprintf - and vsnprintf instead of using conditional compilation. + changing to RSA API? + +* Just how useful is rs_job_drive anyway? * Don't use the rs_buffers_t structure. @@ -154,14 +69,6 @@ Some are more likely to change than others. We need a chart showing which source files depend on which variable. -* Error handling - - * What happens if the user terminates the request? - -* Encoding implementation - - * Join up signature commands - * Encoding algorithm * Self-referential copy commands @@ -180,63 +87,14 @@ However, I don't see many files which have repeated 1kB chunks, so I don't know if it would be worthwhile. - * Extended files - - Suppose the new file just has data added to the end. At the - moment, we'll match everything but the last block of the old - file. It won't match, because at the moment the search block - size is only reduced at the end of the *new* file. This is a - little inefficient, because ideally we'd know to look for the - last block using the shortened length. - - This is a little hard to implement, though perhaps not - impossible. The current rolling search algorithm can only look - for one block size at any time. Can we do better? Can we look - for all block lengths that could match anything? - - Remember also that at the moment we don't send the block length - in the signature; it's implied by the length of the new block - that it matches. This is kind of cute, and importantly helps - reduce the length of the signature. - - * State-machine searching - - Building a state machine from a regular expression is a brilliant - idea. (I think `The Practice of Programming' walks through the - construction of this at a fairly simple level.) - - In particular, we can search for any of a large number of - alternatives in a very efficient way, with much less effort than - it would take to search for each the hard way. Remember also the - string-searching algorithms and how much time they can take. - - I wonder if we can use similar principles here rather than the - current simple rolling-sum mechanism? Could it let us match - variable-length signatures? - - * Cross-file matches - - If the downstream server had many similar URLs, it might be nice - if it could draw on all of them as a basis. At the moment - there's no way to express this, and I think the work of sending - up signatures for all of them may be too hard. - - Better just to make sure we choose the best basis if there is - none present. Perhaps this needs to weigh several factors. - - One factor might be that larger files are better because they're - more likely to have a match. I'm not sure if that's very strong, - because they'll just bloat the request. Another is that more - recent files might be more useful. - -* Support gzip compression of the difference stream. Does this +* Support compression of the difference stream. Does this belong here, or should it be in the client and librsync just have an interface that lets it cleanly plug in? I think if we're going to just do plain gzip, rather than rsync-gzip, then it might as well be external. -* rsync-gzip: preload with the omitted text so as to get better + rsync-gzip: preload with the omitted text so as to get better compression. Abo thinks this gets significantly better compression. On the other hand we have to important and maintain our own zlib fork, at least until we can persuade the upstream to @@ -263,20 +121,6 @@ Will the GNU Lesser GPL work? Specifically, will it be a problem in distributing this with Mozilla or Apache? -* Checksums - - * Do we really need to require that signatures arrive after the - data they describe? Does it make sense in HTTP to resume an - interrupted transfer? - - I hope we can do this. If we can't, however, then we should - relax this constraint and allow signatures to arrive before the - data they describe. (Really? Do we care?) - - * Allow variable-length checksums in the signature; the signature - will have to describe the length of the sums and we must compare - them taking this into account. - * Testing * Just more testing in general. @@ -293,53 +137,11 @@ * Generate random data; do random mutations. - * Try different block lengths. - * Tests should fail if they can't find their inputs, or have zero inputs: at present they tend to succeed by default. - * Test varying strong-sum inputs: default, short, long. - * Security audit * If this code was to read differences or sums from random machines on the network, then it's a security boundary. Make sure that corrupt input data can't make the program crash or misbehave. - -* Use slprintf not strnprintf, etc. - -* Long files - - * How do we handle the large signatures required to support large - files? In particular, how do we choose an appropriate block size - when the length is unknown? Perhaps we should allow a way for - the signature to scale up as it grows. - - * What do we need to do to compile in support for this? - - * On GNU, defining _LARGEFILE_SOURCE as we now do should be - sufficient. - - * SCO and similar things on 32-bit platforms may be more - difficult. Some SCO systems have no 64-bit types at all, so - there we will have to do without. - - * On larger Unix platforms we hope that large file support will - be the default. - -* Perhaps make extracted signatures still be wrapped in commands. - What would this lead to? - - * We'd know how much signature data we expect to read, rather than - requiring it to be terminated by the caller. - -* Only use `inline` if the compiler supports it; perhaps allow it to be - disabled or even just let the compiler decide? - -* Fall back from `uint8_t` to probably `unsigned char` if necessary. - -* Don't randomly use chars and longs; use rs_byte_t and rs_size_t. - -* Fold snprintf.h into librsync-config.h.in or even maybe config.h.in. - -* Maybe just drop snprintf, if plausibly everyone has it? Or can we avoid it? diff --git a/autogen.sh b/autogen.sh deleted file mode 100755 index 1f403801..00000000 --- a/autogen.sh +++ /dev/null @@ -1,101 +0,0 @@ -#! /bin/sh - -# Copyright 2000, 2001, 2014, 2015 by Martin Pool - -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public License -# as published by the Free Software Foundation; either version 2.1 of -# the License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this program; if not, write to the Free Software -# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - - -# This script generates everything necessary to build librsync from a bare -# source tree. It is based on the file of the same name in glib. It is not -# needed for distributed versions, because all the necessary files are included -# in the tarball by autoconf. - -srcdir=`dirname $0` -test -z "$srcdir" && srcdir=. - -ORIGDIR=`pwd` -cd $srcdir -PROJECT=librsync -TEST_TYPE=-f -FILE=librsync.h - -DIE=0 - -cache="$srcdir/autom4te.cache" -test -d "$cache" && { - echo "Deleting $cache" - rm -Rf "$cache" -} - -# ChangeLog is autogenerated, and must be deleted otherwise automake makes -# assumptions about its existance. -changelog="$srcdir/ChangeLog" -test -f "$changelog" && { - echo "Deleting $changelog" - rm -Rf "$changelog" -} - -(autoconf --version) < /dev/null > /dev/null 2>&1 || { - echo - echo "You must have autoconf installed to compile $PROJECT." - echo "Download the appropriate package for your distribution," - echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/" - DIE=1 -} - -(automake --version) < /dev/null > /dev/null 2>&1 || { - echo - echo "You must have automake installed to compile $PROJECT." - echo "Download the appropriate package for your distribution," - echo "or get ftp://sourceware.cygnus.com/pub/automake/automake-1.4.tar.gz" - echo "(or a newer version if it is available)" - DIE=1 -} - -if [ -z "$LIBTOOLIZE" ] -then - LIBTOOLIZE=libtoolize -fi - -($LIBTOOLIZE --version) < /dev/null > /dev/null 2>&1 || { - echo - echo "You must have libtool installed to compile $PROJECT." - echo "Download the appropriate package for your distribution," - echo "or go to http://www.gnu.org/software/libtool/" - echo "You can set the \$LIBTOOLIZE environment variable." - DIE=1 -} - -if test "$DIE" -eq 1; then - exit 1 -fi - -test $TEST_TYPE $FILE || { - echo "You must run this script in the top-level $PROJECT directory" - exit 1 -} - -case $CC in -*xlc | *xlc\ * | *lcc | *lcc\ *) am_opt=--include-deps;; -esac - -set -x -aclocal $ACLOCAL_FLAGS -$LIBTOOLIZE --force -autoheader -automake -a --foreign $am_opt -autoconf -set +x -cd $ORIGDIR diff --git a/blake2-impl.h b/blake2-impl.h deleted file mode 100644 index ceb6f1b8..00000000 --- a/blake2-impl.h +++ /dev/null @@ -1,142 +0,0 @@ -/* - BLAKE2 reference source code package - reference C implementations - - Written in 2012 by Samuel Neves - - To the extent possible under law, the author(s) have dedicated all copyright - and related and neighboring rights to this software to the public domain - worldwide. This software is distributed without any warranty. - - You should have received a copy of the CC0 Public Domain Dedication along with - this software. If not, see . -*/ - -/* This code, but not the algorithm, has been slightly modified for use in - * librsync. - */ - -#pragma once -#ifndef __BLAKE2_IMPL_H__ -#define __BLAKE2_IMPL_H__ - -#include - -#ifndef WORDS_BIGENDIAN /* from librsync config.h */ -# define NATIVE_LITTLE_ENDIAN -#endif /* ndef WORDS_BIGENDIAN */ - -static inline uint32_t load32( const void *src ) -{ -#if defined(NATIVE_LITTLE_ENDIAN) - return *( const uint32_t * )( src ); -#else - const uint8_t *p = ( const uint8_t * )src; - uint32_t w = *p++; - w |= ( uint32_t )( *p++ ) << 8; - w |= ( uint32_t )( *p++ ) << 16; - w |= ( uint32_t )( *p++ ) << 24; - return w; -#endif -} - -static inline uint64_t load64( const void *src ) -{ -#if defined(NATIVE_LITTLE_ENDIAN) - return *( const uint64_t * )( src ); -#else - const uint8_t *p = ( const uint8_t * )src; - uint64_t w = *p++; - w |= ( uint64_t )( *p++ ) << 8; - w |= ( uint64_t )( *p++ ) << 16; - w |= ( uint64_t )( *p++ ) << 24; - w |= ( uint64_t )( *p++ ) << 32; - w |= ( uint64_t )( *p++ ) << 40; - w |= ( uint64_t )( *p++ ) << 48; - w |= ( uint64_t )( *p++ ) << 56; - return w; -#endif -} - -static inline void store32( void *dst, uint32_t w ) -{ -#if defined(NATIVE_LITTLE_ENDIAN) - *( uint32_t * )( dst ) = w; -#else - uint8_t *p = ( uint8_t * )dst; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; -#endif -} - -static inline void store64( void *dst, uint64_t w ) -{ -#if defined(NATIVE_LITTLE_ENDIAN) - *( uint64_t * )( dst ) = w; -#else - uint8_t *p = ( uint8_t * )dst; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; -#endif -} - -static inline uint64_t load48( const void *src ) -{ - const uint8_t *p = ( const uint8_t * )src; - uint64_t w = *p++; - w |= ( uint64_t )( *p++ ) << 8; - w |= ( uint64_t )( *p++ ) << 16; - w |= ( uint64_t )( *p++ ) << 24; - w |= ( uint64_t )( *p++ ) << 32; - w |= ( uint64_t )( *p++ ) << 40; - return w; -} - -static inline void store48( void *dst, uint64_t w ) -{ - uint8_t *p = ( uint8_t * )dst; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; w >>= 8; - *p++ = ( uint8_t )w; -} - -static inline uint32_t rotl32( const uint32_t w, const unsigned c ) -{ - return ( w << c ) | ( w >> ( 32 - c ) ); -} - -static inline uint64_t rotl64( const uint64_t w, const unsigned c ) -{ - return ( w << c ) | ( w >> ( 64 - c ) ); -} - -static inline uint32_t rotr32( const uint32_t w, const unsigned c ) -{ - return ( w >> c ) | ( w << ( 32 - c ) ); -} - -static inline uint64_t rotr64( const uint64_t w, const unsigned c ) -{ - return ( w >> c ) | ( w << ( 64 - c ) ); -} - -/* prevents compiler optimizing out memset() */ -static inline void secure_zero_memory( void *v, size_t n ) -{ - volatile uint8_t *p = ( volatile uint8_t * )v; - - while( n-- ) *p++ = 0; -} - -#endif - diff --git a/blake2.h b/blake2.h deleted file mode 100644 index f8aba833..00000000 --- a/blake2.h +++ /dev/null @@ -1,156 +0,0 @@ -/* - BLAKE2 reference source code package - reference C implementations - - Written in 2012 by Samuel Neves - - To the extent possible under law, the author(s) have dedicated all copyright - and related and neighboring rights to this software to the public domain - worldwide. This software is distributed without any warranty. - - You should have received a copy of the CC0 Public Domain Dedication along with - this software. If not, see . -*/ -#pragma once -#ifndef __BLAKE2_H__ -#define __BLAKE2_H__ - -#include -#include - -#if defined(_MSC_VER) -#define ALIGN(x) __declspec(align(x)) -#else -#define ALIGN(x) __attribute__((aligned(x))) -#endif - -#if defined(__cplusplus) -extern "C" { -#endif - - enum blake2s_constant - { - BLAKE2S_BLOCKBYTES = 64, - BLAKE2S_OUTBYTES = 32, - BLAKE2S_KEYBYTES = 32, - BLAKE2S_SALTBYTES = 8, - BLAKE2S_PERSONALBYTES = 8 - }; - - enum blake2b_constant - { - BLAKE2B_BLOCKBYTES = 128, - BLAKE2B_OUTBYTES = 64, - BLAKE2B_KEYBYTES = 64, - BLAKE2B_SALTBYTES = 16, - BLAKE2B_PERSONALBYTES = 16 - }; - -#pragma pack(push, 1) - typedef struct __blake2s_param - { - uint8_t digest_length; // 1 - uint8_t key_length; // 2 - uint8_t fanout; // 3 - uint8_t depth; // 4 - uint32_t leaf_length; // 8 - uint8_t node_offset[6];// 14 - uint8_t node_depth; // 15 - uint8_t inner_length; // 16 - // uint8_t reserved[0]; - uint8_t salt[BLAKE2S_SALTBYTES]; // 24 - uint8_t personal[BLAKE2S_PERSONALBYTES]; // 32 - } blake2s_param; - - ALIGN( 64 ) typedef struct __blake2s_state - { - uint32_t h[8]; - uint32_t t[2]; - uint32_t f[2]; - uint8_t buf[2 * BLAKE2S_BLOCKBYTES]; - size_t buflen; - uint8_t last_node; - } blake2s_state ; - - typedef struct __blake2b_param - { - uint8_t digest_length; // 1 - uint8_t key_length; // 2 - uint8_t fanout; // 3 - uint8_t depth; // 4 - uint32_t leaf_length; // 8 - uint64_t node_offset; // 16 - uint8_t node_depth; // 17 - uint8_t inner_length; // 18 - uint8_t reserved[14]; // 32 - uint8_t salt[BLAKE2B_SALTBYTES]; // 48 - uint8_t personal[BLAKE2B_PERSONALBYTES]; // 64 - } blake2b_param; - - ALIGN( 64 ) typedef struct __blake2b_state - { - uint64_t h[8]; - uint64_t t[2]; - uint64_t f[2]; - uint8_t buf[2 * BLAKE2B_BLOCKBYTES]; - size_t buflen; - uint8_t last_node; - } blake2b_state; - - typedef struct __blake2sp_state - { - blake2s_state S[8][1]; - blake2s_state R[1]; - uint8_t buf[8 * BLAKE2S_BLOCKBYTES]; - size_t buflen; - } blake2sp_state; - - typedef struct __blake2bp_state - { - blake2b_state S[4][1]; - blake2b_state R[1]; - uint8_t buf[4 * BLAKE2B_BLOCKBYTES]; - size_t buflen; - } blake2bp_state; -#pragma pack(pop) - - // Streaming API - int blake2s_init( blake2s_state *S, const uint8_t outlen ); - int blake2s_init_key( blake2s_state *S, const uint8_t outlen, const void *key, const uint8_t keylen ); - int blake2s_init_param( blake2s_state *S, const blake2s_param *P ); - int blake2s_update( blake2s_state *S, const uint8_t *in, uint64_t inlen ); - int blake2s_final( blake2s_state *S, uint8_t *out, uint8_t outlen ); - - int blake2b_init( blake2b_state *S, const uint8_t outlen ); - int blake2b_init_key( blake2b_state *S, const uint8_t outlen, const void *key, const uint8_t keylen ); - int blake2b_init_param( blake2b_state *S, const blake2b_param *P ); - int blake2b_update( blake2b_state *S, const uint8_t *in, uint64_t inlen ); - int blake2b_final( blake2b_state *S, uint8_t *out, uint8_t outlen ); - - int blake2sp_init( blake2sp_state *S, const uint8_t outlen ); - int blake2sp_init_key( blake2sp_state *S, const uint8_t outlen, const void *key, const uint8_t keylen ); - int blake2sp_update( blake2sp_state *S, const uint8_t *in, uint64_t inlen ); - int blake2sp_final( blake2sp_state *S, uint8_t *out, uint8_t outlen ); - - int blake2bp_init( blake2bp_state *S, const uint8_t outlen ); - int blake2bp_init_key( blake2bp_state *S, const uint8_t outlen, const void *key, const uint8_t keylen ); - int blake2bp_update( blake2bp_state *S, const uint8_t *in, uint64_t inlen ); - int blake2bp_final( blake2bp_state *S, uint8_t *out, uint8_t outlen ); - - // Simple API - int blake2s( uint8_t *out, const void *in, const void *key, const uint8_t outlen, const uint64_t inlen, uint8_t keylen ); - int blake2b( uint8_t *out, const void *in, const void *key, const uint8_t outlen, const uint64_t inlen, uint8_t keylen ); - - int blake2sp( uint8_t *out, const void *in, const void *key, const uint8_t outlen, const uint64_t inlen, uint8_t keylen ); - int blake2bp( uint8_t *out, const void *in, const void *key, const uint8_t outlen, const uint64_t inlen, uint8_t keylen ); - - static inline int blake2( uint8_t *out, const void *in, const void *key, const uint8_t outlen, const uint64_t inlen, uint8_t keylen ) - { - return blake2b( out, in, key, outlen, inlen, keylen ); - } - -#if defined(__cplusplus) -} -#endif - -#endif - diff --git a/buf.c b/buf.c deleted file mode 100644 index 2f9064e8..00000000 --- a/buf.c +++ /dev/null @@ -1,223 +0,0 @@ -/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*- - * - * librsync -- the library for network deltas - * - * Copyright (C) 2000, 2001 by Martin Pool - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - - /* - | Pick a window, Jimmy, you're leaving. - */ - - -/* - * buf.c -- Buffers that map between stdio file streams and librsync - * streams. As the stream consumes input and produces output, it is - * refilled from appropriate input and output FILEs. A dynamically - * allocated buffer of configurable size is used as an intermediary. - * - * TODO: Perhaps be more efficient by filling the buffer on every call - * even if not yet completely empty. Check that it's really our - * buffer, and shuffle remaining data down to the front. - * - * TODO: Perhaps expose a routine for shuffling the buffers. - */ - - -#include -#include - -#include -#include -#include -#include -#include - -#include "librsync.h" -#include "trace.h" -#include "buf.h" -#include "util.h" - -/* use fseeko instead of fseek for long file support if we have it */ -#ifdef HAVE_FSEEKO -#define fseek fseeko -#endif - -/** - * File IO buffer sizes. - */ -int rs_inbuflen = 16000, rs_outbuflen = 16000; - - -struct rs_filebuf { - FILE *f; - char *buf; - size_t buf_len; -}; - - -rs_filebuf_t *rs_filebuf_new(FILE *f, size_t buf_len) -{ - rs_filebuf_t *pf = rs_alloc_struct(rs_filebuf_t); - - pf->buf = rs_alloc(buf_len, "file buffer"); - pf->buf_len = buf_len; - pf->f = f; - - return pf; -} - - -void rs_filebuf_free(rs_filebuf_t *fb) -{ - free(fb->buf); - rs_bzero(fb, sizeof *fb); - free(fb); -} - - -/* - * If the stream has no more data available, read some from F into - * BUF, and let the stream use that. On return, SEEN_EOF is true if - * the end of file has passed into the stream. - */ -rs_result rs_infilebuf_fill(rs_job_t *job, rs_buffers_t *buf, - void *opaque) -{ - int len; - rs_filebuf_t *fb = (rs_filebuf_t *) opaque; - FILE *f = fb->f; - - /* This is only allowed if either the buf has no input buffer - * yet, or that buffer could possibly be BUF. */ - if (buf->next_in != NULL) { - assert(buf->avail_in <= fb->buf_len); - assert(buf->next_in >= fb->buf); - assert(buf->next_in <= fb->buf + fb->buf_len); - } else { - assert(buf->avail_in == 0); - } - - if (buf->eof_in || (buf->eof_in = feof(f))) { - rs_trace("seen end of file on input"); - buf->eof_in = 1; - return RS_DONE; - } - - if (buf->avail_in) - /* Still some data remaining. Perhaps we should read - anyhow? */ - return RS_DONE; - - len = fread(fb->buf, 1, fb->buf_len, f); - if (len <= 0) { - /* This will happen if file size is a multiple of input block len - */ - if (feof(f)) { - rs_trace("seen end of file on input"); - buf->eof_in = 1; - return RS_DONE; - } - if (ferror(f)) { - rs_error("error filling buf from file: %s", - strerror(errno)); - return RS_IO_ERROR; - } else { - rs_error("no error bit, but got %d return when trying to read", - len); - return RS_IO_ERROR; - } - } - buf->avail_in = len; - buf->next_in = fb->buf; - - return RS_DONE; -} - - -/* - * The buf is already using BUF for an output buffer, and probably - * contains some buffered output now. Write this out to F, and reset - * the buffer cursor. - */ -rs_result rs_outfilebuf_drain(rs_job_t *job, rs_buffers_t *buf, void *opaque) -{ - int present; - rs_filebuf_t *fb = (rs_filebuf_t *) opaque; - FILE *f = fb->f; - - /* This is only allowed if either the buf has no output buffer - * yet, or that buffer could possibly be BUF. */ - if (buf->next_out == NULL) { - assert(buf->avail_out == 0); - - buf->next_out = fb->buf; - buf->avail_out = fb->buf_len; - - return RS_DONE; - } - - assert(buf->avail_out <= fb->buf_len); - assert(buf->next_out >= fb->buf); - assert(buf->next_out <= fb->buf + fb->buf_len); - - present = buf->next_out - fb->buf; - if (present > 0) { - int result; - - assert(present > 0); - - result = fwrite(fb->buf, 1, present, f); - if (present != result) { - rs_error("error draining buf to file: %s", - strerror(errno)); - return RS_IO_ERROR; - } - - buf->next_out = fb->buf; - buf->avail_out = fb->buf_len; - } - - return RS_DONE; -} - - -/** - * Default copy implementation that retrieves a part of a stdio file. - */ -rs_result rs_file_copy_cb(void *arg, rs_long_t pos, size_t *len, void **buf) -{ - int got; - FILE *f = (FILE *) arg; - - if (fseek(f, pos, SEEK_SET)) { - rs_log(RS_LOG_ERR, "seek failed: %s", strerror(errno)); - return RS_IO_ERROR; - } - - got = fread(*buf, 1, *len, f); - if (got == -1) { - rs_error("read error: %s", strerror(errno)); - return RS_IO_ERROR; - } else if (got == 0) { - rs_error("unexpected eof on fd%d", fileno(f)); - return RS_INPUT_ENDED; - } else { - *len = got; - return RS_DONE; - } -} diff --git a/check-rdiff b/check-rdiff deleted file mode 100755 index eb6f9b8e..00000000 --- a/check-rdiff +++ /dev/null @@ -1,44 +0,0 @@ -#!/usr/bin/perl -# Creates a pair of semi-random files and check if rdiff -# correctlys updates the first to the second. - -# script is "./g" - -$size = 5 << 30; -$blocklen = 6000; - -use Getopt::Long; -GetOptions("size=i" => \$size, - "blocklen=i" => \$blocklen); - -$runlen = $blocklen / 3; - -sub makefile { # Make a moderately random $size-byte file - ($fname,$size)=@_; - print "Creating: $fname ($size bytes)\n"; - open OUT,">$fname" or die "Can't open $fname"; - for $i (1..$size/$runlen) { - $ch = chr(32+int(rand(127))) ; - print OUT ($ch x $runlen); - } - $ch = chr(32+int(rand(127))) ; - print OUT ($ch x ($size % $runlen)); -} - -sub run { - ($cmd)=@_; - print "Running: $cmd\n"; - system($cmd)==0 or die "FAILED!"; -} - -srand(0); -makefile('old',$size); -makefile('new',$size); -run("time rdiff signature -b $blocklen old old.sig"); -run("time rdiff delta -s old.sig new delta"); -run("time rdiff patch -s old delta new2"); -print "Comparing MD5 hashes...\n"; -$sum1 = `md5sum < new`; die 'Failed 1' unless $?==0; print $sum1; -$sum2 = `md5sum < new2`; die 'Failed 2' unless $?==0; print $sum2; -die "DIFFERENT\n" unless $sum1==$sum2; -print "SUCCESS\n" diff --git a/checksum.c b/checksum.c deleted file mode 100644 index 4e60da81..00000000 --- a/checksum.c +++ /dev/null @@ -1,90 +0,0 @@ -/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*- - * - * librsync -- the library for network deltas - * $Id$ - * - * Copyright (C) 1999, 2000, 2001 by Martin Pool - * Copyright (C) 1996 by Andrew Tridgell - * Copyright (C) 1996 by Paul Mackerras - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation; either version 2.1 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -#include - -#include -#include -#include - -#include "librsync.h" -#include "checksum.h" -#include "blake2.h" - - -/* This can possibly be used to restart the checksum system in the - * case where we detected corruption. I'm not sure yet how to make - * this useful in librsync. */ -int checksum_seed = 0; - -/* - * A simple 32 bit checksum that can be updated from either end - * (inspired by Mark Adler's Adler-32 checksum) - */ -unsigned int rs_calc_weak_sum(void const *p, int len) -{ - int i; - unsigned s1, s2; - unsigned char const *buf = (unsigned char const *) p; - - s1 = s2 = 0; - for (i = 0; i < (len - 4); i += 4) { - s2 += 4 * (s1 + buf[i]) + 3 * buf[i + 1] + - 2 * buf[i + 2] + buf[i + 3] + 10 * RS_CHAR_OFFSET; - s1 += (buf[i + 0] + buf[i + 1] + buf[i + 2] + buf[i + 3] + - 4 * RS_CHAR_OFFSET); - } - for (; i < len; i++) { - s1 += (buf[i] + RS_CHAR_OFFSET); - s2 += s1; - } - return (s1 & 0xffff) + (s2 << 16); -} - - -/** - * Calculate and store into SUM a strong MD4 checksum of the file - * blocks seen so far. - * - * In plain rsync, the checksum is perturbed by a seed value. This is - * used when retrying a failed transmission: we've discovered that the - * hashes collided at some point, so we're going to try again with - * different hashes to see if we can get it right. (Check tridge's - * thesis for details and to see if that's correct.) - * - * Since we can't retry a web transaction I'm not sure if it's very - * useful in rproxy. - */ -void rs_calc_md4_sum(void const *buf, size_t len, rs_strong_sum_t *sum) -{ - rs_mdfour((unsigned char *) sum, buf, len); -} - -void rs_calc_blake2_sum(void const *buf, size_t len, rs_strong_sum_t *sum) -{ - blake2b_state ctx; - blake2b_init(&ctx, RS_MAX_STRONG_SUM_LENGTH); - blake2b_update(&ctx, (const uint8_t *)buf, len); - blake2b_final(&ctx, (uint8_t *)sum, RS_MAX_STRONG_SUM_LENGTH); -} diff --git a/checksum.h b/checksum.h deleted file mode 100644 index 2c2aa632..00000000 --- a/checksum.h +++ /dev/null @@ -1,31 +0,0 @@ -/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*- - * - * librsync -- the library for network deltas - * $Id$ - * - * Copyright (C) 2000, 2001 by Martin Pool - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation; either version 2.1 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -rs_weak_sum_t rs_calc_weak_sum(void const *buf1, int len); - -void rs_calc_md4_sum(void const *buf, size_t buf_len, rs_strong_sum_t *); -void rs_calc_blake2_sum(void const *buf, size_t buf_len, rs_strong_sum_t *); - -/* We should make this something other than zero to improve the - * checksum algorithm: tridge suggests a prime number. */ -#define RS_CHAR_OFFSET 31 - diff --git a/cmake/BuildType.cmake b/cmake/BuildType.cmake new file mode 100644 index 00000000..a05e4303 --- /dev/null +++ b/cmake/BuildType.cmake @@ -0,0 +1,23 @@ +# Manage CMAKE_BUILD_TYPE. +# +# This sets the default build type to "Release or "Debug" for a git clone, and +# sets up the possible values for the cmake-gui. It understands multi-config +# generators and respects values set on the cmdline. It comes from; +# +# https://blog.kitware.com/cmake-and-the-default-build-type/ + +# Set the default build type for when none was specified. +set(DEFAULT_BUILD_TYPE "Release") +if(EXISTS "${CMAKE_SOURCE_DIR}/.git") + set(DEFAULT_BUILD_TYPE "Debug") +endif() + +# If CMAKE_BUILD_TYPE is not set and not using a multi-config generator, set +# it to the default and setup the possible values for the cmake-gui. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting build type to '${DEFAULT_BUILD_TYPE}' as none was specified.") + set(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}" CACHE + STRING "Choose the type of build." FORCE) + set_property(CACHE CMAKE_BUILD_TYPE + PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo") +endif() diff --git a/cmake/FindLIBB2.cmake b/cmake/FindLIBB2.cmake new file mode 100644 index 00000000..8eb19653 --- /dev/null +++ b/cmake/FindLIBB2.cmake @@ -0,0 +1,24 @@ +# - Check for the presence of libb2 +# +# The following vars can be set to change behaviour; +# LIBB2_INCLUDE_DIR - cached override for LIBB2_INCLUDE_DIRS. +# LIBB2_LIBRARY_RELEASE - cached override for LIBB2_LIBRARIES. +# +# The following variables are set when libb2 is found: +# LIBB2_FOUND = Set to true, if all components of libb2 have been found. +# LIBB2_INCLUDE_DIRS = Include path for the header files of libb2. +# LIBB2_LIBRARIES = Link these to use libb2. + +find_path (LIBB2_INCLUDE_DIR blake2.h) +find_library (LIBB2_LIBRARY_RELEASE b2) + +include (FindPackageHandleStandardArgs) +find_package_handle_standard_args (LIBB2 DEFAULT_MSG LIBB2_LIBRARY_RELEASE LIBB2_INCLUDE_DIR) + +# Set output vars from auto-detected/cached vars. +if (LIBB2_FOUND) + set(LIBB2_INCLUDE_DIRS "${LIBB2_INCLUDE_DIR}") + set(LIBB2_LIBRARIES "${LIBB2_LIBRARY_RELEASE}") +endif (LIBB2_FOUND) + +mark_as_advanced (LIBB2_INCLUDE_DIR LIBB2_LIBRARY_RELEASE) diff --git a/cmake/FindPOPT.cmake b/cmake/FindPOPT.cmake new file mode 100644 index 00000000..f2ab21d9 --- /dev/null +++ b/cmake/FindPOPT.cmake @@ -0,0 +1,74 @@ +#-------------------------------------------------------------------------------- +# Copyright (C) 2012-2013, Lars Baehren +# Copyright (C) 2015 Adam Schubert +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, +# are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, this +# list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +#-------------------------------------------------------------------------------- + +# - Check for the presence of POPT +# +# The following vars can be set to change behaviour; +# POPT_INCLUDE_DIR - cached override for POPT_INCLUDE_DIRS. +# POPT_LIBRARY_RELEASE - cached override for POPT_LIBRARIES. +# +# The following variables are set when POPT is found: +# POPT_FOUND = Set to true, if all components of POPT have been found. +# POPT_INCLUDE_DIRS = Include path for the header files of POPT. +# POPT_LIBRARIES = Link these to use POPT. + +# Check with PkgConfig (to retrieve static dependencies such as iconv) +find_package(PkgConfig) +if (PKG_CONFIG_FOUND) + pkg_search_module (POPT QUIET IMPORTED_TARGET popt) + if (POPT_FOUND) + # PkgConfig found it, set cached vars to use the imported target it created. + set(POPT_INCLUDE_DIR "" CACHE PATH "Path to headers for popt.") + set(POPT_LIBRARY_RELEASE PkgConfig::POPT CACHE FILEPATH "Path to library for popt.") + endif (POPT_FOUND) +endif (PKG_CONFIG_FOUND) + +# Fallback to searching for path and library if PkgConfig didn't work. +if (NOT POPT_FOUND) + find_path (POPT_INCLUDE_DIR popt.h) + find_library (POPT_LIBRARY_RELEASE popt) +endif (NOT POPT_FOUND) + +# Check library and paths and set POPT_FOUND appropriately. +INCLUDE(FindPackageHandleStandardArgs) +if (TARGET "${POPT_LIBRARY_RELEASE}") + # The library is a taget created by PkgConfig. + FIND_PACKAGE_HANDLE_STANDARD_ARGS(POPT + REQUIRED_VARS POPT_LIBRARY_RELEASE + VERSION_VAR POPT_VERSION) +else () + # The library is a library file and header include path. + FIND_PACKAGE_HANDLE_STANDARD_ARGS(POPT DEFAULT_MSG POPT_LIBRARY_RELEASE POPT_INCLUDE_DIR) +endif () + +# Set output vars from auto-detected/cached vars. +if (POPT_FOUND) + set(POPT_INCLUDE_DIRS "${POPT_INCLUDE_DIR}") + set(POPT_LIBRARIES "${POPT_LIBRARY_RELEASE}") +endif (POPT_FOUND) + +# Mark cache vars as advanced. +mark_as_advanced (POPT_INCLUDE_DIR POPT_LIBRARY_RELEASE) diff --git a/configure.ac b/configure.ac deleted file mode 100644 index 4c3f77eb..00000000 --- a/configure.ac +++ /dev/null @@ -1,146 +0,0 @@ -# -*- Autoconf -*- -# Process this file with autoconf to produce a configure script. - -AC_PREREQ(2.53) -AC_INIT([librsync],[1.0.1]) -AC_COPYRIGHT([Copyright (C) 1999-2015 by Martin Pool ]) -AC_CONFIG_SRCDIR([trace.c]) -AC_CONFIG_HEADERS([config.h]) -AC_CONFIG_MACRO_DIR([m4]) -AM_INIT_AUTOMAKE([foreign]) - -# GNU library versioning: This is NOT the librsync release number. -# See libversions.txt and the libtool manual for an explanation of the -# library versioning -librsync_libversion=2:0:0 - -# Disable shared libs by default. -AC_DISABLE_SHARED - -# Checks for programs. -AC_GNU_SOURCE -AC_PROG_CC -AC_ISC_POSIX -AC_PROG_CPP -AC_PROG_INSTALL -AC_PROG_MAKE_SET -AC_PROG_LIBTOOL - -# Checks for libraries. -AC_CHECK_LIB(z, deflate) -AC_CHECK_LIB(bz2, BZ2_bzCompress) -AC_CHECK_LIB(popt, poptGetContext,,[BUILD_POPT='popt/libpopt.a'; CFLAGS="$CFLAGS -I$srcdir/popt"]) - -# Checks for header files. -AC_FUNC_ALLOCA -AC_HEADER_STDC -AC_CHECK_HEADERS([mcheck.h bzlib.h zlib.h]) -AC_CHECK_HEADERS([fcntl.h inttypes.h libintl.h limits.h malloc.h stdint.h stdlib.h string.h sys/file.h unistd.h]) - -# Checks for typedefs, structures, and compiler characteristics. -AC_C_CONST -AC_C_BIGENDIAN -AC_TYPE_SIZE_T -AC_TYPE_OFF_T -AC_SYS_LARGEFILE - -AC_CHECK_SIZEOF([unsigned char], 1) -if test "$ac_cv_sizeof_unsigned_char" -ne 1; then - AC_MSG_WARN(unsigned char seems to be $ac_cv_sizeof_unsigned_char bytes. Expect trouble.) -fi -AC_CHECK_SIZEOF(short) -AC_CHECK_SIZEOF([unsigned short]) -AC_CHECK_SIZEOF(int) -AC_CHECK_SIZEOF([unsigned int]) -AC_CHECK_SIZEOF(long) -AC_CHECK_SIZEOF([unsigned long]) -AC_CHECK_SIZEOF([long long]) -AC_CHECK_SIZEOF(off_t) -AC_CHECK_SIZEOF(size_t) - -#XXX: is this really the best way to do it? I think the limitation on -# rs_long_t is that we need to be able to seek to it, which relates to -# long file support. With fseeko, rs_long_t should be off_t, otherwise -# it should be long. -AC_COMPILE_IFELSE([AC_LANG_PROGRAM( - [[#include -#ifndef LONG_LONG -#error not defined -#endif]], - [;])], - [ RS_LONG_T='LONG_LONG' ], - [ case "$ac_cv_sizeof_long_long" in - 0) RS_LONG_T='long' ;; - *) RS_LONG_T='long long' ;; - esac ]) -AC_SUBST(RS_LONG_T) - -# Checks for library functions. -#AC_FUNC_MALLOC #XXX: needs malloc.c replacement -#AC_FUNC_MEMCMP #XXX: needs memcmp.c replacement -#AC_FUNC_REALLOC #XXX: needs realloc.c replacement -AC_FUNC_FSEEKO -AC_CHECK_FUNCS([memmove memset strchr strerror strtol]) -AC_CHECK_FUNCS([gettext dgettext]) -AC_CHECK_FUNC(setreuid, [], - [ AC_CHECK_LIB(ucb, setreuid, - [ if echo $LIBS | grep -- -lucb >/dev/null ;then :; - else LIBS="$LIBS -lc -lucb"; USEUCB=y;fi]) -]) -# supply a snprintf and vsnprintf if the system doesn't have one. -# if missing, check MSVC _xxx varients, otherwise use snprintf.c -# replacement. -AC_CHECK_FUNCS(snprintf,,[AC_CHECK_FUNCS(_snprintf)]) -AC_CHECK_FUNCS(vsnprintf,,[AC_CHECK_FUNCS(_vsnprintf,,[AC_LIBOBJ(snprintf)])]) - -# Test if the compiler has the GNU feature of putting argv[0] into a global -AC_MSG_CHECKING([for program_invocation_short_name]) -AC_COMPILE_IFELSE([AC_LANG_PROGRAM( - [[#include ]], - [[strlen(program_invocation_short_name)]])], - [ AC_DEFINE(HAVE_PROGRAM_INVOCATION_NAME,, - [GNU extension of saving argv[0] to program_invocation_short_name]) - AC_MSG_RESULT(yes) ], - [ AC_MSG_RESULT(no) ]) - -# Test if the preprocessor understands vararg macros -AC_MSG_CHECKING([for vararg macro support]) -AC_COMPILE_IFELSE([AC_LANG_PROGRAM( - [#define func(a, b...) do {} while (0)], - [func("a", "b", "c");func("a")])], - [ AC_DEFINE(HAVE_VARARG_MACROS, , [Define if your cpp has vararg macros]) - AC_MSG_RESULT(yes) ], - [ AC_MSG_RESULT(no) ]) - -if test "$GCC" = "yes"; then # GCC - CFLAGS="-Wall -Wshadow -Wundef -Wwrite-strings -Wmissing-prototypes -Wmissing-declarations -Wstrict-prototypes -Wpointer-arith -Wcast-qual -Wcast-align $CFLAGS" -elif test "$CC" = "cl"; then # MSVC - CFLAGS="-Z7 -Od -MD $CFLAGS" -fi -# TODO: Similar conditions for other known compilers. For SUNWspro, use `-v'. - -AC_ARG_ENABLE(ccmalloc, - AC_HELP_STRING([--enable-ccmalloc],[use ccmalloc debugger (default no)]), - [ LIBS="$LIBS -lccmalloc -ldl" ]) - -AC_ARG_ENABLE(trace, - AC_HELP_STRING([--disable-trace],[turn off library tracing]), - [enable_trace=$enableval],[enable_trace=yes]) -if test "$enable_trace" = "yes"; then - AC_DEFINE(DO_RS_TRACE,,[Define this to enable trace code]) -fi - -AC_DEFINE_UNQUOTED(RS_LIBVERSION, "$librsync_libversion",[Version of the libtool interface.]) -AC_DEFINE_UNQUOTED(RS_CANONICAL_HOST, "$host",[Canonical GNU hostname]) - -AC_SUBST(librsync_libversion) -AC_SUBST(BUILD_POPT) - -AC_CONFIG_FILES([ - Makefile - doc/Makefile - doc/Doxyfile - popt/Makefile - testsuite/Makefile - librsync-config.h]) -AC_OUTPUT diff --git a/configure.msc b/configure.msc deleted file mode 100644 index b3462805..00000000 --- a/configure.msc +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -./configure CC=cl --prefix='C:/Progra~1/librsync' diff --git a/delta.c b/delta.c deleted file mode 100644 index ccbccc54..00000000 --- a/delta.c +++ /dev/null @@ -1,474 +0,0 @@ -/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*- - * - * librsync -- library for network deltas - * - * Copyright (C) 2000, 2001 by Martin Pool - * Copyright (C) 2003 by Donovan Baarda - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation; either version 2.1 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - - /* - | Let's climb to the TOP of that - | MOUNTAIN and think about STRIP - | MINING!! - */ - - -/* - * delta.c -- Generate in streaming mode an rsync delta given a set of - * signatures, and a new file. - * - * The size of blocks for signature generation is determined by the - * block size in the incoming signature. - * - * To calculate a signature, we need to be able to see at least one - * block of the new file at a time. Once we have that, we calculate - * its weak signature, and see if there is any block in the signature - * hash table that has the same weak sum. If there is one, then we - * also compute the strong sum of the new block, and cross check that. - * If they're the same, then we can assume we have a match. - * - * The final block of the file has to be handled a little differently, - * because it may be a short match. Short blocks in the signature - * don't include their length -- we just allow for the final short - * block of the file to match any block in the signature, and if they - * have the same checksum we assume they must have the same length. - * Therefore, when we emit a COPY command, we have to send it with a - * length that is the same as the block matched, and not the block - * length from the signature. - */ - -/* - * Profiling results as of v1.26, 2001-03-18: - * - * If everything matches, then we spend almost all our time in - * rs_mdfour64 and rs_weak_sum, which is unavoidable and therefore a - * good profile. - * - * If nothing matches, it is not so good. - */ - - -#include - -#include -#include -#include - -#include "librsync.h" -#include "emit.h" -#include "stream.h" -#include "util.h" -#include "sumset.h" -#include "job.h" -#include "trace.h" -#include "search.h" -#include "types.h" -#include "rollsum.h" - -const int RS_MD4_SUM_LENGTH = 16; -const int RS_BLAKE2_SUM_LENGTH = 32; - -/** - * 2002-06-26: Donovan Baarda - * - * The following is based entirely on pysync. It is much cleaner than the - * previous incarnation of this code. It is slightly complicated because in - * this case the output can block, so the main delta loop needs to stop - * when this happens. - * - * In pysync a 'last' attribute is used to hold the last miss or match for - * extending if possible. In this code, basis_len and scoop_pos are used - * instead of 'last'. When basis_len > 0, last is a match. When basis_len = - * 0 and scoop_pos is > 0, last is a miss. When both are 0, last is None - * (ie, nothing). - * - * Pysync is also slightly different in that a 'flush' method is available - * to force output of accumulated data. This 'flush' is use to finalise - * delta calculation. In librsync input is terminated with an eof flag on - * the input stream. I have structured this code similar to pysync with a - * seperate flush function that is used when eof is reached. This allows - * for a flush style API if one is ever needed. Note that flush in pysync - * can be used for more than just terminating delta calculation, so a flush - * based API can in some ways be more flexible... - * - * The input data is first scanned, then processed. Scanning identifies - * input data as misses or matches, and emits the instruction stream. - * Processing the data consumes it off the input scoop and outputs the - * processed miss data into the tube. - * - * The scoop contains all data yet to be processed. The scoop_pos is an - * index into the scoop that indicates the point scanned to. As data is - * scanned, scoop_pos is incremented. As data is processed, it is removed - * from the scoop and scoop_pos adjusted. Everything gets complicated - * because the tube can block. When the tube is blocked, no data can be - * processed. - * - */ - -/* used by rdiff, but now redundant */ -int rs_roll_paranoia = 0; - -static rs_result rs_delta_s_scan(rs_job_t *job); -static rs_result rs_delta_s_flush(rs_job_t *job); -static rs_result rs_delta_s_end(rs_job_t *job); -void rs_getinput(rs_job_t *job); -inline int rs_findmatch(rs_job_t *job, rs_long_t *match_pos, size_t *match_len); -inline rs_result rs_appendmatch(rs_job_t *job, rs_long_t match_pos, size_t match_len); -inline rs_result rs_appendmiss(rs_job_t *job, size_t miss_len); -inline rs_result rs_appendflush(rs_job_t *job); -inline rs_result rs_processmatch(rs_job_t *job); -inline rs_result rs_processmiss(rs_job_t *job); - -/** - * \brief Get a block of data if possible, and see if it matches. - * - * On each call, we try to process all of the input data available on the - * scoop and input buffer. */ -static rs_result rs_delta_s_scan(rs_job_t *job) -{ - rs_long_t match_pos; - size_t match_len; - rs_result result; - Rollsum test; - - rs_job_check(job); - /* read the input into the scoop */ - rs_getinput(job); - /* output any pending output from the tube */ - result=rs_tube_catchup(job); - /* while output is not blocked and there is a block of data */ - while ((result==RS_DONE) && - ((job->scoop_pos + job->block_len) < job->scoop_avail)) { - /* check if this block matches */ - if (rs_findmatch(job,&match_pos,&match_len)) { - /* append the match and reset the weak_sum */ - result=rs_appendmatch(job,match_pos,match_len); - RollsumInit(&job->weak_sum); - } else { - /* rotate the weak_sum and append the miss byte */ - RollsumRotate(&job->weak_sum,job->scoop_next[job->scoop_pos], - job->scoop_next[job->scoop_pos+job->block_len]); - result=rs_appendmiss(job,1); - if (rs_roll_paranoia) { - RollsumInit(&test); - RollsumUpdate(&test, job->scoop_next+job->scoop_pos, - job->block_len); - if (RollsumDigest(&test) != RollsumDigest(&job->weak_sum)) { - rs_fatal("mismatch between rolled sum %#x and check %#x", - (int)RollsumDigest(&job->weak_sum), - (int)RollsumDigest(&test)); - } - - } - } - } - /* if we completed OK */ - if (result==RS_DONE) { - /* if we reached eof, we can flush the last fragment */ - if (job->stream->eof_in) { - job->statefn=rs_delta_s_flush; - return RS_RUNNING; - } else { - /* we are blocked waiting for more data */ - return RS_BLOCKED; - } - } - return result; -} - - -static rs_result rs_delta_s_flush(rs_job_t *job) -{ - rs_long_t match_pos; - size_t match_len; - rs_result result; - - rs_job_check(job); - /* read the input into the scoop */ - rs_getinput(job); - /* output any pending output */ - result=rs_tube_catchup(job); - /* while output is not blocked and there is any remaining data */ - while ((result==RS_DONE) && (job->scoop_pos < job->scoop_avail)) { - /* check if this block matches */ - if (rs_findmatch(job,&match_pos,&match_len)) { - /* append the match and reset the weak_sum */ - result=rs_appendmatch(job,match_pos,match_len); - RollsumInit(&job->weak_sum); - } else { - /* rollout from weak_sum and append the miss byte */ - RollsumRollout(&job->weak_sum,job->scoop_next[job->scoop_pos]); - rs_trace("block reduced to %d", (int)job->weak_sum.count); - result=rs_appendmiss(job,1); - } - } - /* if we are not blocked, flush and set end statefn. */ - if (result==RS_DONE) { - result=rs_appendflush(job); - job->statefn=rs_delta_s_end; - } - if (result==RS_DONE) { - return RS_RUNNING; - } - return result; -} - - -static rs_result rs_delta_s_end(rs_job_t *job) -{ - rs_emit_end_cmd(job); - return RS_DONE; -} - - -void rs_getinput(rs_job_t *job) { - size_t len; - - len=rs_scoop_total_avail(job); - if (job->scoop_avail < len) { - rs_scoop_input(job,len); - } -} - - -/** - * find a match at scoop_pos, returning the match_pos and match_len. - * Note that this will calculate weak_sum if required. It will also - * determine the match_len. - * - * Note that this routine could be modified to do xdelta style matches that - * would extend matches past block boundaries by matching backwards and - * forwards beyond the block boundaries. Extending backwards would require - * decrementing scoop_pos as appropriate. - */ -inline int rs_findmatch(rs_job_t *job, rs_long_t *match_pos, size_t *match_len) { - /* calculate the weak_sum if we don't have one */ - if (job->weak_sum.count == 0) { - /* set match_len to min(block_len, scan_avail) */ - *match_len=job->scoop_avail - job->scoop_pos; - if (*match_len > job->block_len) { - *match_len = job->block_len; - } - /* Update the weak_sum */ - RollsumUpdate(&job->weak_sum,job->scoop_next+job->scoop_pos,*match_len); - rs_trace("calculate weak sum from scratch length %d",(int)job->weak_sum.count); - } else { - /* set the match_len to the weak_sum count */ - *match_len=job->weak_sum.count; - } - return rs_search_for_block(RollsumDigest(&job->weak_sum), - job->scoop_next+job->scoop_pos, - *match_len, - job->signature, - &job->stats, - match_pos); -} - - -/** - * Append a match at match_pos of length match_len to the delta, extending - * a previous match if possible, or flushing any previous miss/match. */ -inline rs_result rs_appendmatch(rs_job_t *job, rs_long_t match_pos, size_t match_len) -{ - rs_result result=RS_DONE; - - /* if last was a match that can be extended, extend it */ - if (job->basis_len && (job->basis_pos + job->basis_len) == match_pos) { - job->basis_len+=match_len; - } else { - /* else appendflush the last value */ - result=rs_appendflush(job); - /* make this the new match value */ - job->basis_pos=match_pos; - job->basis_len=match_len; - } - /* increment scoop_pos to point at next unscanned data */ - job->scoop_pos+=match_len; - /* we can only process from the scoop if output is not blocked */ - if (result==RS_DONE) { - /* process the match data off the scoop*/ - result=rs_processmatch(job); - } - return result; -} - - -/** - * Append a miss of length miss_len to the delta, extending a previous miss - * if possible, or flushing any previous match. - * - * This also breaks misses up into block_len segments to avoid accumulating - * too much in memory. */ -inline rs_result rs_appendmiss(rs_job_t *job, size_t miss_len) -{ - rs_result result=RS_DONE; - - /* if last was a match, or block_len misses, appendflush it */ - if (job->basis_len || (job->scoop_pos >= rs_outbuflen)) { - result=rs_appendflush(job); - } - /* increment scoop_pos */ - job->scoop_pos+=miss_len; - return result; -} - - -/** - * Flush any accumulating hit or miss, appending it to the delta. - */ -inline rs_result rs_appendflush(rs_job_t *job) -{ - /* if last is a match, emit it and reset last by resetting basis_len */ - if (job->basis_len) { - rs_trace("matched " PRINTF_FORMAT_U64 " bytes at " PRINTF_FORMAT_U64 "!", - PRINTF_CAST_U64(job->basis_len), - PRINTF_CAST_U64(job->basis_pos)); - rs_emit_copy_cmd(job, job->basis_pos, job->basis_len); - job->basis_len=0; - return rs_processmatch(job); - /* else if last is a miss, emit and process it*/ - } else if (job->scoop_pos) { - rs_trace("got %ld bytes of literal data", (long) job->scoop_pos); - rs_emit_literal_cmd(job, job->scoop_pos); - return rs_processmiss(job); - } - /* otherwise, nothing to flush so we are done */ - return RS_DONE; -} - - -/** - * The scoop contains match data at scoop_next of length scoop_pos. This - * function processes that match data, returning RS_DONE if it completes, - * or RS_BLOCKED if it gets blocked. After it completes scoop_pos is reset - * to still point at the next unscanned data. - * - * This function currently just removes data from the scoop and adjusts - * scoop_pos appropriately. In the future this could be used for something - * like context compressing of miss data. Note that it also calls - * rs_tube_catchup to output any pending output. */ -inline rs_result rs_processmatch(rs_job_t *job) -{ - job->scoop_avail-=job->scoop_pos; - job->scoop_next+=job->scoop_pos; - job->scoop_pos=0; - return rs_tube_catchup(job); -} - -/** - * The scoop contains miss data at scoop_next of length scoop_pos. This - * function processes that miss data, returning RS_DONE if it completes, or - * RS_BLOCKED if it gets blocked. After it completes scoop_pos is reset to - * still point at the next unscanned data. - * - * This function uses rs_tube_copy to queue copying from the scoop into - * output. and uses rs_tube_catchup to do the copying. This automaticly - * removes data from the scoop, but this can block. While rs_tube_catchup - * is blocked, scoop_pos does not point at legit data, so scanning can also - * not proceed. - * - * In the future this could do compression of miss data before outputing - * it. */ -inline rs_result rs_processmiss(rs_job_t *job) -{ - rs_tube_copy(job, job->scoop_pos); - job->scoop_pos=0; - return rs_tube_catchup(job); -} - - -/** - * \brief State function that does a slack delta containing only - * literal data to recreate the input. - */ -static rs_result rs_delta_s_slack(rs_job_t *job) -{ - rs_buffers_t * const stream = job->stream; - size_t avail = stream->avail_in; - - if (avail) { - rs_trace("emit slack delta for " PRINTF_FORMAT_U64 - " available bytes", PRINTF_CAST_U64(avail)); - rs_emit_literal_cmd(job, avail); - rs_tube_copy(job, avail); - return RS_RUNNING; - } else { - if (rs_job_input_is_ending(job)) { - job->statefn = rs_delta_s_end; - return RS_RUNNING; - } else { - return RS_BLOCKED; - } - } -} - - -/** - * State function for writing out the header of the encoding job. - */ -static rs_result rs_delta_s_header(rs_job_t *job) -{ - rs_emit_delta_header(job); - - if (job->block_len) { - if (!job->signature) { - rs_error("no signature is loaded into the job"); - return RS_PARAM_ERROR; - } - job->statefn = rs_delta_s_scan; - } else { - rs_trace("block length is zero for this delta; " - "therefore using slack deltas"); - job->statefn = rs_delta_s_slack; - } - - return RS_RUNNING; -} - - -/** - * Prepare to compute a streaming delta. - */ -rs_job_t *rs_delta_begin(rs_signature_t *sig) -{ - /* Caller must have called rs_build_hash_table() by now */ - if (!sig->tag_table) - rs_fatal("Must call rs_build_hash_table() prior to calling rs_delta_begin()"); - - rs_job_t *job; - - job = rs_job_new("delta", rs_delta_s_header); - job->signature = sig; - - RollsumInit(&job->weak_sum); - - if ((job->block_len = sig->block_len) < 0) { - rs_log(RS_LOG_ERR, "unreasonable block_len %d in signature", - job->block_len); - return NULL; - } - - job->strong_sum_len = sig->strong_sum_len; - if (job->strong_sum_len < 0 || job->strong_sum_len > RS_MAX_STRONG_SUM_LENGTH) { - rs_log(RS_LOG_ERR, "unreasonable strong_sum_len %d in signature", - job->strong_sum_len); - return NULL; - } - - return job; -} - diff --git a/doc/.cvsignore b/doc/.cvsignore deleted file mode 100644 index 592cbabc..00000000 --- a/doc/.cvsignore +++ /dev/null @@ -1,3 +0,0 @@ -Makefile -Makefile.in -Doxyfile diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index c2d4c010..5d8fc5d9 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,149 +1,2523 @@ -# Doxygen configuration generated by Doxywizard version 0.1 +# Doxyfile 1.8.16 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + #--------------------------------------------------------------------------- -# General configuration options +# Project related configuration options #--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + PROJECT_NAME = librsync -PROJECT_NUMBER = -OUTPUT_DIRECTORY = . + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = @LIBRSYNC_VERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + OUTPUT_LANGUAGE = English -EXTRACT_ALL = NO -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + FULL_PATH_NAMES = NO -STRIP_FROM_PATH = + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + INTERNAL_DOCS = NO -CLASS_DIAGRAMS = NO -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + HIDE_SCOPE_NAMES = NO -VERBATIM_HEADERS = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + SHOW_INCLUDE_FILES = NO -JAVADOC_AUTOBRIEF = YES -INHERIT_DOCS = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + SORT_MEMBER_DOCS = NO -DISTRIBUTE_GROUP_DOC = NO -TAB_SIZE = 8 -ENABLED_SECTIONS = + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + GENERATE_TESTLIST = YES -ALIASES = + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + MAX_INITIALIZER_LINES = 30 -OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + WARN_IF_UNDOCUMENTED = NO + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = @top_srcdir@ + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/src \ + @CMAKE_CURRENT_SOURCE_DIR@ \ + @CMAKE_CURRENT_SOURCE_DIR@/doc + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + FILE_PATTERNS = *.c \ *.h \ - *.dox + *.dox \ + *.md + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + RECURSIVE = NO -EXCLUDE = -EXCLUDE_PATTERNS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -IMAGE_PATH = -INPUT_FILTER = + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = _* + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + #--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + ALPHABETICAL_INDEX = NO + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + HTML_OUTPUT = html -HTML_HEADER = @srcdir@/header.html -HTML_FOOTER = @srcdir@/footer.html -HTML_STYLESHEET = @srcdir@/doxygen.css -HTML_ALIGN_MEMBERS = YES + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/doc/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/doc/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/doc/doxygen.css + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /