pax_global_header00006660000000000000000000000064144361707250014523gustar00rootroot0000000000000052 comment=9bd24425690e488e3b8c8fb89f4b9b2d69a7eec0 librsync-2.3.4/000077500000000000000000000000001443617072500133565ustar00rootroot00000000000000librsync-2.3.4/.ccmalloc000066400000000000000000000401771443617072500151450ustar00rootroot00000000000000 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%% generic configureation file for %%%% %%%% the ccmalloc memory profiler %%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %-----------------------------------------------------------------% % COPY THIS FILE TO `.ccmalloc' in your project or home directory % %-----------------------------------------------------------------% ############################################################################## ## (C) 1997-1998 Armin Biere, 1998 Johannes Keukelaar ############################################################################## %%% `%' and `#' are comments !!!!!!! % This file must be called `.ccmalloc' and is searched for in the % current directory and in the home directory of the user. If it % does not exist then the default values mentioned below are used. % It is also the currently only available user manual ;-) So here % is a reading hint. First have a look at the short one line % descriptions of each option ... %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % with `file' the executable is specified [a.out] % ---------------------------------------------------------------------- % This should not be necessary for Linux and Solaris because the proc % file system can be used to find argv[0]. % % (the rest of this comment only applies to other OS) % % For other OS you should use this option unless the executable is % in the current directory or its name is `a.out'. % % If you do not specify this then ccmalloc tries to find an executable % in the current directory that matches the running program starting % with `a.out'. For this process it must call `nm' on each executable % file in the directory which may be time consuming. With this option % you can speed up this process. % % You can also specify absolute or relative path names. This is % necessary if you do not start your program from the current directory. % But you can also simply link or name your program to `a.out'. %file FILE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `log' specify the logfile [stderr] % ---------------------------------------------------------------------- % The default is to use stderr. The argument to `log' is the name of % the file you want to write to. It can also be `stdout' or `-' which % sets stdout as logfile. If the logfile is stdout or stderr and is % connected to a terminal then the output is slightly different. % % For big programs the logfile can be really big. To reduce the size % you can use a small chain length (see `chain-length' below). The other % possibility is to use compressed logfiles. This can be done by % specifying a logfile name with a `.gz' (or a `.Z') suffix. This means % that gnuzip (resp. compress) is used to compress the output. %log FILE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `logpid' specify the logfile % ---------------------------------------------------------------------- % Can be used alternatively to the `log' command if you want to use % ccmalloc for debugging parallel applications where several copies of % the program you are debugging must be run simoultaneously. In this % case you can not use `log' because you do not want to write to the same % log file. Using `logpid' uses a file name ending with the of % the process which means the name is unique even if several copies of % your program are run simoultaneously. % % If you use the compressing suffixes then the is inserted before % the suffix (e.g. `logpid ccmalloc.log.gz' uses `ccmalloc.log..gz' % as the name for the log file). %logpid FILE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `dont-log-chain' skip info about certain chains [] % ---------------------------------------------------------------------- % This command may be repeated any number of times. The argument to this % command is a comma-separated list of function-or-file-and-line % specifications. Garbage allocated from a callchain that contains this % subchain anywhere will _not_ be logged. % % The comma-separated list should not contain any spaces. E.g. not: % main, foo, bar % but: % main,foo,bar % A function-or-file-and-line specification is a string followed by an % optional colon and number, for example: main or main:14 or main.c or % main.c:15. Note that the string is compared with both the function and % the file name, if available. If main.c happens to be a function name, % that will cause a match (for that string at least). % Not specifying a line number will match any line number. If line number % information is not available, anything will match! % Not specifying a name (e.g. ,,,) will match an unknown function name. % Not giving any parameters at all, will match a chain containing at least % one unknown function. % % Note that if you say % dont-log-chain wrapper.c % _nothing_ will be logged... %dont-log-chain %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `only-log-chain' skip info about other chains [] % ---------------------------------------------------------------------- % The obvious counterpart to dont-log-chain. In this case, only matching % chains will be reported. Non-matching chains will not be reported. % Can be repeated any number of times; if the chain matches any of the % instances, it will be reported. %only-log-chain ######################################################################## # # # This is the `flag' section # # # # `set FLAG' is the same as `set FLAG 1' # # # # The default values are those set below. If `silent' is disabled # # then you will find the banner in the log file (or it is listed on # # stdout or stderr). The banner describes the current settings of all # # these flags. # # # ######################################################################## %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % with `only-count' ccmalloc only counts garbage - no call chains [0] % ---------------------------------------------------------------------- % If only-count is set to one then only one additional pointer for % each allocated data is used and no call chain is generated. This is % the fasted and most space efficient mode ccmalloc can operate % in. In this mode you get at least the size of garbage produced. % % Note that `check-free-space' does not work at all with `only-count' % set and over writes (`check-overwrites') are only checked when % calling free. %set only-count 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `load-dynlibs' load dynamic linked libraries into gdb [0] % ---------------------------------------------------------------------- % If your program is linked with dynamic libraries, function and file % name information is not available for addresses in those libraries, % unless you set `load-dynlibs' to 1. %set load-dynlibs 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `keep-deallocated-data' does not recycle deallocated data [0] % ---------------------------------------------------------------------- % If you enable keep-deallocated-data then all data deallocated with % `free' (or `delete' in C++) is not given back to the free store % but stays associated with the call chain of its allocation. This is % very useful if your program does multiple deallocation of the % same data. %set keep-deallocated-data 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `check-overwrites' detect overwrites [0] % ---------------------------------------------------------------------- % If you want to detect `off by n bytes' errors you should set % `checking-overwrites' to n/4 (on 32-Bit machines). % % ccmalloc inserts a boundary above allocated data. This boundary % consists of `check-overwrites' words. If your program writes to % this area then ccmalloc can detect this (see also check-start % and check-interval). `ccmalloc' also does checking for overwrites % at non word boundaries (e.g. strcpy(malloc(strlen("hello")),"hello");) %set check-overwrites 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `check-underwrites' detect overwrites [0] % ---------------------------------------------------------------------- % same with writes below allocated data. You do not have to set this % option if you only want detect `off (below) by one' errors because % ccmalloc keeps a magic value just before the user data. %set check-overwrites 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `check-free-space' can be used to find dangling pointers. [0] % ---------------------------------------------------------------------- % A very serious type of bug is to write on data that has already been % freed. If this happens the free space management of malloc is in % trouble and you will perhaps encounter non deterministic behaviour of % your program. To test this first enable `keep-deallocated-data' and % restart your program. If the problem goes away and ccmalloc does not % report anything then you should *also* enable `check-free-space'. Now % ccmalloc checks already deallocated data for corruption. % % Note that to perform this check `keep-deallocated-data' also must % be enabled and `only-count' disabled. %set check-free-space 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `check-interval' can be used to speed up checks [0] % ---------------------------------------------------------------------- % If check-overwrite, check-underwrites or check-free-space is set then % the default is to do `write checks' when data is deallocated and % to do `free space checks' when reporting together with % `write checks' for garbage. When you want these checks to be % performed more often then you should set `check-interval' to a % positive number. This number is the interval between the number of % calls to free or malloc without performing the checks. %set check-interval 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `check-start' can be used to speed up checks [0] % ---------------------------------------------------------------------- % The flag `check-start' delays the start of checks until the given % number of calls to free and malloc have occured. Together with % `check-interval' you can use a binary search to find an aproximation % when a corruption occured! If you simply set check-interval to 1 and % check-start to 0 then this will slow done your program too much. %set check-start 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `silent' disables banner [0] % ---------------------------------------------------------------------- % If you don't want to see the banner of ccmalloc then set % `silent' to 1 (f.e. when logging to stderr) %set silent set silent 1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `file-info' en/disables file and line number information [1] % ---------------------------------------------------------------------- % If your program was compiled with debugging information (-g) then % ccmalloc can generate line number and file info for call chains opening % a pipe to gdb. For very big programs this method is slow. In this case % you can set `file-info' to zero and you will only get the function % names. For SunOS 4.3.1 `nm' does not `demangle' C++ identifiers % very well. So gdb is called instead but only if `file-info' is % not set to 0. %set file-info 1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `continue' if ccmalloc aborts when something weired happened [0] % ---------------------------------------------------------------------- % If the free function of ccmalloc is called with an argument that does % not make sense to ccmalloc or that has already been freed then you % probably want the program to stop at this point. This is also % the default behaviour. But you can force ccmalloc also to ignore % this if you set `continue' to 1. This flag also controls the behaviour % of ccmalloc when free space is found to be corrupted or a write % boundary has been overwritten. %set continue 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `chain-length' is the length of the maximal call chain [0 = infinite] % ---------------------------------------------------------------------- % You can restrict the length of call chains by setting `chain-length' % to a number greater than zero. If `chain-length' is zero (the default) % then chains are as long as possible (on a non x86 system only call % chains with a finite maximal length can be generated). For big % programs especially if keep-deallocated-data is enabled this can % reduce the size of the log file from over 100MB to several MB! %set chain-length 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `print-addresses' of data [0] % ---------------------------------------------------------------------- % If you want to see the addresses of the allocated data (and % deallocated data if keep-deallocated-data is set to 1) set % `print-addresses' to 1. %set print-addresses 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `print-on-one-line' shortens log file [0] % ---------------------------------------------------------------------- % The default is to print function names and file/line number info % on separate lines. With `print-on-one-line' set 1 all are printed % on one line. set print-on-one-line 1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `additional-line' enlarges readability [1] % ---------------------------------------------------------------------- % When printing call chains an empty line is printed between to % call points. Set `additional-line' to 0 to disable this feature. set additional-line 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % `statistics' enables more accurate profiling [0] % ---------------------------------------------------------------------- % Calculate number of allocations and deallocations and bytes also on % a per call chain basis. This uses 4 additional pointers for each % call chain. set statistics 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % set order for sorting of call chains [1] [1] % ---------------------------------------------------------------------- % When printing the report to the log file the call chains are sorted by % default with respect to the largest accumulated garbage produced by % that call chain. This can be changed with setting `sort-by-wasted' % to 0. In this case they are sorted by the number of allocated bytes. % If you want the number of allocations (only possible if `statistics' % is enabled) as sorting criteria instead then set `sort-by-size' to 0. %set sort-by-wasted 1 %set sort-by-size 1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % report library chains [0] % ---------------------------------------------------------------------- % Some external libraries (like libg++) have memory leaks. On some % systems even a call to printf produces a leak. ccmalloc tries to % detect this (only heuristically!) and with this flag you can control % if leaks produced by such library calls are reported. % % Since version 0.2.1 some similar effect can be achieved by using % `dont-log-chain' with no argument. %set library-chains 0 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % print debugging information [X] (compile time dependend) % ---------------------------------------------------------------------- %set debug X %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % align memory on 8 byte boundary [0] (no effect on SunOS or Solaris) % ---------------------------------------------------------------------- %set align-8-byte 0 librsync-2.3.4/.clang-tidy000066400000000000000000000002141443617072500154070ustar00rootroot00000000000000# clang-analyzer-valist.Uninitialized has a bug https://bugs.llvm.org/show_bug.cgi?id=41311. Checks: "-clang-analyzer-valist.Uninitialized" librsync-2.3.4/.gdbinit000066400000000000000000000000211443617072500147700ustar00rootroot00000000000000set print pretty librsync-2.3.4/.gitattributes000066400000000000000000000001461443617072500162520ustar00rootroot00000000000000# Data files used for tests. *.data binary *.input binary *.sig binary *.delta binary *.expect binary librsync-2.3.4/.github/000077500000000000000000000000001443617072500147165ustar00rootroot00000000000000librsync-2.3.4/.github/workflows/000077500000000000000000000000001443617072500167535ustar00rootroot00000000000000librsync-2.3.4/.github/workflows/check.yml000066400000000000000000000056411443617072500205610ustar00rootroot00000000000000name: 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 librsync-2.3.4/.github/workflows/lint.yml000066400000000000000000000010431443617072500204420ustar00rootroot00000000000000name: 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 librsync-2.3.4/.gitignore000066400000000000000000000016451443617072500153540ustar00rootroot00000000000000rdiff *.o CMakeCache.txt CTestTestfile.cmake config.h *.cbp librsync.so* librsync.a librsync*.dylib Makefile CMakeFiles *.lo .libs librsync.la 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 librsync-2.3.4/.lclintrc000066400000000000000000000000461443617072500151710ustar00rootroot00000000000000-type +posixlib -predboolint +boolint librsync-2.3.4/AUTHORS000066400000000000000000000002321443617072500144230ustar00rootroot00000000000000Martin Pool Andrew Tridgell Donovan Baarda Adam Schubert librsync-2.3.4/CMakeLists.txt000066400000000000000000000414561443617072500161300ustar00rootroot00000000000000# 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 4) 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 librsync-2.3.4/CONTRIBUTING.md000066400000000000000000000273751443617072500156250ustar00rootroot00000000000000# 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`. librsync-2.3.4/COPYING000066400000000000000000000636441443617072500144260ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. ^L Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. ^L GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. ^L Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. ^L 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. ^L 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. ^L 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. ^L 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS ^L How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library 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 of the License, or (at your option) any later version. This library 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 library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! librsync-2.3.4/NEWS.md000066400000000000000000000615471443617072500144710ustar00rootroot00000000000000# NEWS ## 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. librsync-2.3.4/README.RPM000066400000000000000000000003271443617072500146750ustar00rootroot00000000000000librsync now comes with an RPM .spec file contributed by Peter Braam and Shirish Hemant Phatak that will allow you to build an RPM package. To do this, simply execute the command: rpm -ta librsync-0.9.3.tar.gz librsync-2.3.4/README.md000066400000000000000000000061031443617072500146350ustar00rootroot00000000000000# README http://librsync.sourcefrog.net/ \copyright Copyright 1999-2016 Martin Pool and other contributors. 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. [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][CC0]. [CC0]: http://creativecommons.org/publicdomain/zero/1.0/ ## Introduction librsync is a library for calculating and applying network deltas, with an interface designed to ease integration into diverse network applications. 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. This algorithm transfers the differences between two files without needing both files on the same system. 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 \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. 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.) ### What librsync is not 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. 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. 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. ## More information * \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) librsync-2.3.4/THANKS000066400000000000000000000066711443617072500143030ustar00rootroot00000000000000 -*- text -*- Originators and Contributors up to 0.9.5 --------------------------------------- Andrew Tridgell and Paulus Mackerras started this whole mess. Luke Leighton was a tremendous help in sorting out the combined encoding/signature algorithm. Thanks to Linuxcare, Inc, for their support of this project. Neale Banks : the first known user outside of OzLabs. Paul `Rusty' Russell Andrew Tridgell Paulus Mackerras Peter Barker Neale Banks Luke Kenneth Casson Leighton Tim Potter Hugh Blemings David Gibson Contributors by release ----------------------- The following is a list of contributors for each release. It is possible we have missed some contributors. If you know of anyone who has been omitted and deserves to be included, please send the details so they can be added. For later releases, contributors are listed in NEWS. Contributors for 0.9.6 * Wayne Davison - librsync sf project admin - sf project creation, import cvs etc - many cvs commits of submitted patches - rsync.h -> librsync.h rename - librsync-conf.h addition and config.h issue resolution * Martin Pool - sf project admin - sf project developers setup * Donovan Baarda - librsync sf project admin - sf project tracker and lists setup - MSVC6 and cygwin compiling patch and updates - mdfour optimisations and cleanups patch - autconf/autmake cleanups - large file debugging and fixes - build and release * Ben Escoto - librsync sf project admin * Ben Elliston - many cvs commits before migrating to sf * Robert Weber - bigendian and >512M mdfour patch * Skip Montanaro - librsync on MacOSX patch * Diego Liziero - memory leak patches - again rdiff cosmetic patch * Berkan Eskikaya - Control files for librsync debian packages patch * Mark Moraes - cygwin testsuite fixes email patch * Robert Collins - autoconf/automake cleanups email (old patch) * Paul Green - large file testing and debugging Contributors for 0.9.7 * Donovan Baarda - librsync sf project admin - delta refactor patch - bug resolution * Martin Pool - sf project admin - documentation updates. - bug fixes * John Goerzen - Debian package maintainence * Dave Coombs - C++ wrapper patch * Eran Tromer - [#855477] buf.c incorrect header order, and fix. - [#1022764] Reported and diagnosed nasty corruption bug with large files. * Simon Law - [#879763] Fixed problems with unaligned access in mdfour. Contributors for 0.9.8 (release pending) * Charles Duffy - [#1056544] Submitted patch with improved spec file for building RPMs. - [#1056548] Reported man page bug about using '-' for stdin/stdout. * Don Malcolm - [#1439412] Submitted patch for bug #1110812 error on large files. librsync-2.3.4/TODO.md000066400000000000000000000123541443617072500144520ustar00rootroot00000000000000# TODO * 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? * Optimisations and code cleanups; scoop.c: Scoop needs major refactor. Perhaps the API needs tweaking? 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? * Just how useful is rs_job_drive anyway? * Don't use the rs_buffers_t structure. There's something confusing about the existence of this structure. In part it may be the name. I think people expect that it will be something that behaves like a FILE* or C++ stream, and it really does not. Also, the structure does not behave as an object: it's really just a shorthand for passing values in to the encoding routines, and so does not have a lot of identity of its own. An alternative might be result = rs_job_iter(job, in_buf, &in_len, in_is_ending, out_buf, &out_len); where we update the length parameters on return to show how much we really consumed. One technicality here will be to restructure the code so that the input buffers are passed down to the scoop/tube functions that need them, which are relatively deeply embedded. I guess we could just stick them into the job structure, which is becoming a kind of catch-all "environment" for poor C programmers. * Meta-programming * Plot lengths of each function * Some kind of statistics on delta each day * Encoding format * Include a version in the signature and difference fields * Remember to update them if we ever ship a buggy version (nah!) so that other parties can know not to trust the encoded data. * abstract encoding In fact, we can vary on several different variables: * what signature format are we using * what command protocol are we using * what search algorithm are we using? * what implementation version are we? Some are more likely to change than others. We need a chart showing which source files depend on which variable. * Encoding algorithm * Self-referential copy commands Suppose we have a file with repeating blocks. The gdiff format allows for COPY commands to extend into the *output* file so that they can easily point this out. By doing this, they get compression as well as differencing. It'd be pretty simple to implement this, I think: as we produce output, we'd also generate checksums (using the search block size), and add them to the sum set. Then matches will fall out automatically, although we might have to specially allow for short blocks. However, I don't see many files which have repeated 1kB chunks, so I don't know if it would be worthwhile. * 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 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 take the necessary patch. Can that be done? abo says It does get better compression, but at a price. I actually think that getting the code to a point where a feature like this can be easily added or removed is more important than the feature itself. Having generic pre and post processing layers for hit/miss data would be useful. I would not like to see it added at all if it tangled and complicated the code. It also doesn't require a modified zlib... pysync uses the standard zlib to do it by compressing the data, then throwing it away. I don't know how much benefit the rsync modifications to zlib actually are, but if I was implementing it I would stick to a stock zlib until it proved significantly better to go with the fork. * Licensing Will the GNU Lesser GPL work? Specifically, will it be a problem in distributing this with Mozilla or Apache? * Testing * Just more testing in general. * Test broken pipes and that IO errors are handled properly. * Test files >2GB, >4GB. Presumably these must be done in streams so that the disk requirements to run the test suite are not too ridiculous. I wonder if it will take too long to run these tests? Probably, but perhaps we can afford to run just one carefully-chosen test. * Fuzz instruction streams. ? * Generate random data; do random mutations. * Tests should fail if they can't find their inputs, or have zero inputs: at present they tend to succeed by default. * 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. librsync-2.3.4/cmake/000077500000000000000000000000001443617072500144365ustar00rootroot00000000000000librsync-2.3.4/cmake/BuildType.cmake000066400000000000000000000017471443617072500173520ustar00rootroot00000000000000# 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() librsync-2.3.4/cmake/FindLIBB2.cmake000066400000000000000000000016361443617072500170410ustar00rootroot00000000000000# - 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) librsync-2.3.4/cmake/FindPOPT.cmake000066400000000000000000000066031443617072500170300ustar00rootroot00000000000000#-------------------------------------------------------------------------------- # 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) librsync-2.3.4/debian/000077500000000000000000000000001443617072500146005ustar00rootroot00000000000000librsync-2.3.4/debian/changelog000066400000000000000000000025201443617072500164510ustar00rootroot00000000000000librsync (0.9.6-2) unstable; urgency=low * Manually install the rdiff bin because it wasn't anymore. Closes: #205469. * Fixed description. Closes: #191658. -- John Goerzen Mon, 18 Aug 2003 11:25:03 -0500 librsync (0.9.6-1) unstable; urgency=low * New upstream release -- John Goerzen Mon, 11 Aug 2003 17:36:26 -0500 librsync (0.9.5.1-3) unstable; urgency=low * Ran autoreconf --force, then rebuilt. Should make mips even happier now. Closes: #180005. -- John Goerzen Fri, 7 Feb 2003 14:06:35 -0600 librsync (0.9.5.1-2) unstable; urgency=low * Copied /usr/share/misc/config.{guess,sub} over the package defaults. This is apparently needed for the mips arch. Closes: #172497. -- John Goerzen Wed, 5 Feb 2003 15:00:55 -0600 librsync (0.9.5.1-1) unstable; urgency=low * New upstream release -- John Goerzen Tue, 3 Dec 2002 15:04:04 -0600 librsync (0.9.5-2) unstable; urgency=low * Applied patch from Mark van Walraven. Closes: #149267. -- John Goerzen Fri, 26 Jul 2002 15:05:42 -0500 librsync (0.9.5-1) unstable; urgency=low * Initial Release, lintian-clean. Closes: #133441. -- John Goerzen Mon, 11 Feb 2002 13:03:19 -0500 librsync-2.3.4/debian/control000066400000000000000000000017511443617072500162070ustar00rootroot00000000000000Source: librsync Section: utils Priority: optional Maintainer: John Goerzen Build-Depends: debhelper (>> 3.0.0), libpopt-dev (>= 1.6.2), zlib1g-dev, autoconf2.13 Standards-Version: 3.5.2 Package: librsync1 Section: libs Architecture: any Depends: ${shlibs:Depends} Description: Binary diff library based on the rsync algorithm librsync is the next generation of librsync, and provides flexible checksum-based differencing. The main application at the moment in rproxy, but the library should eventually be generally useful. Package: librsync-dev Section: devel Architecture: any Depends: librsync1 (= ${Source-Version}), libc6-dev Description: Binary diff library based on the rsync algorithm These are the development files for librsync1. Package: rdiff Section: utils Architecture: any Depends: ${shlibs:Depends} Description: Binary diff tool for signature-based differences rdiff is a little like diff and patch all rolled into one, with support for binary files. librsync-2.3.4/debian/copyright000066400000000000000000000005041443617072500165320ustar00rootroot00000000000000This package was debianized by John Goerzen on Mon, 11 Feb 2002 13:03:19 -0500. The homepage is http://librsync.sourcefrog.net/. Upstream Author(s): Martin Pool Andrew Tridgell Copyright: GNU LGPL version 2.1, found at /usr/share/common-licenses/LGPL-2.1 librsync-2.3.4/debian/dirs000066400000000000000000000000211443617072500154550ustar00rootroot00000000000000usr/bin usr/sbin librsync-2.3.4/debian/docs000066400000000000000000000000541443617072500154520ustar00rootroot00000000000000NEWS README README.CVS TODO libversions.txt librsync-2.3.4/debian/librsync-dev.dirs000066400000000000000000000000241443617072500200600ustar00rootroot00000000000000usr/lib usr/include librsync-2.3.4/debian/librsync-dev.files000066400000000000000000000000751443617072500202270ustar00rootroot00000000000000usr/include/* usr/lib/lib*.a usr/lib/lib*.la usr/lib/lib*.so librsync-2.3.4/debian/librsync1.dirs000066400000000000000000000000101443617072500173600ustar00rootroot00000000000000usr/lib librsync-2.3.4/debian/librsync1.files000066400000000000000000000000471443617072500175330ustar00rootroot00000000000000usr/lib/lib*.so.* usr/share/man/man3/* librsync-2.3.4/debian/rdiff.files000066400000000000000000000000371443617072500167160ustar00rootroot00000000000000usr/bin/* usr/share/man/man1/* librsync-2.3.4/debian/rules000077500000000000000000000040721443617072500156630ustar00rootroot00000000000000#!/usr/bin/make -f # Sample debian/rules that uses debhelper. # GNU copyright 1997 to 1999 by Joey Hess. # Uncomment this to turn on verbose mode. #export DH_VERBOSE=1 # This is the debhelper compatability version to use. export DH_COMPAT=3 # shared library versions, option 1 version=2.0.5 major=2 # option 2, assuming the library is created as src/.libs/libfoo.so.2.0.5 or so #version=`ls src/.libs/lib*.so.* | \ # awk '{if (match($$0,/[0-9]+\.[0-9]+\.[0-9]+$$/)) print substr($$0,RSTART)}'` #major=`ls src/.libs/lib*.so.* | \ # awk '{if (match($$0,/\.so\.[0-9]+$$/)) print substr($$0,RSTART+4)}'` configure: configure-stamp configure-stamp: dh_testdir # Add here commands to configure the package. ./configure --prefix=/usr --mandir=\$${prefix}/share/man --infodir=\$${prefix}/share/info --enable-shared touch configure-stamp build: build-stamp build-stamp: configure-stamp dh_testdir # Add here commands to compile the package. $(MAKE) all check touch build-stamp clean: dh_testdir dh_testroot rm -f build-stamp configure-stamp # Add here commands to clean up after the build process. -$(MAKE) distclean dh_clean install: build dh_testdir dh_testroot dh_clean -k dh_installdirs # Add here commands to install the package into debian/tmp $(MAKE) install prefix=$(CURDIR)/debian/tmp/usr -mkdir debian/tmp/usr/bin cp .libs/rdiff debian/tmp/usr/bin # Build architecture-independent files here. binary-indep: build install # We have nothing to do by default. # Build architecture-dependent files here. binary-arch: build install dh_testdir dh_testroot dh_movefiles # dh_installdebconf dh_installdocs dh_installexamples dh_installmenu # dh_installlogrotate # dh_installemacsen # dh_installpam # dh_installmime # dh_installinit dh_installcron dh_installman dh_installinfo # dh_undocumented dh_installchangelogs NEWS dh_link dh_strip dh_compress dh_fixperms dh_makeshlibs dh_installdeb # dh_perl dh_shlibdeps dh_gencontrol dh_md5sums dh_builddeb binary: binary-indep binary-arch .PHONY: build clean binary-indep binary-arch binary install configure librsync-2.3.4/debian/watch000066400000000000000000000005411443617072500156310ustar00rootroot00000000000000# Example watch control file for uscan # Rename this file to "watch" and then you can run the "uscan" command # to check for upstream updates and more. # Site Directory Pattern Version Script #sunsite.unc.edu /pub/Linux/Incoming librsync-(.*)\.tar\.gz debian uupdate ftp.sourceforge.net /pub/sourceforge/rproxy librsync-(.*)\.tar\.gz debian uupdate librsync-2.3.4/doc/000077500000000000000000000000001443617072500141235ustar00rootroot00000000000000librsync-2.3.4/doc/Doxyfile.in000066400000000000000000003304261443617072500162460ustar00rootroot00000000000000# 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 (\" \"). #--------------------------------------------------------------------------- # 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 # 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 # 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 # 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 # 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 # 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 # 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 # 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 # 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 # 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 #--------------------------------------------------------------------------- # 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" # 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 #--------------------------------------------------------------------------- # 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 \ *.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 # 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 #--------------------------------------------------------------------------- # 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 # 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 #--------------------------------------------------------------------------- # 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 # 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 # 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 # , /