diff --git a/.ci/config.cmake b/.ci/config.cmake new file mode 100644 index 00000000000..38573e6a7c1 --- /dev/null +++ b/.ci/config.cmake @@ -0,0 +1,18 @@ +set(FORCE_ENABLED 0 CACHE BOOL "") +set(ENABLE_ASAN 0 CACHE BOOL "") +set(ENABLE_TSAN 0 CACHE BOOL "") +set(ENABLE_CEPH 1 CACHE BOOL "") +set(ENABLE_FUSE 1 CACHE BOOL "") +set(ENABLE_HTTP 1 CACHE BOOL "") +set(ENABLE_KRB5 1 CACHE BOOL "") +set(ENABLE_MACAROONS 1 CACHE BOOL "") +set(ENABLE_PYTHON 1 CACHE BOOL "") +set(ENABLE_READLINE 1 CACHE BOOL "") +set(ENABLE_SCITOKENS 1 CACHE BOOL "") +set(ENABLE_TESTS 1 CACHE BOOL "") +set(ENABLE_VOMS 1 CACHE BOOL "") +set(ENABLE_XRDCL 1 CACHE BOOL "") +set(ENABLE_XRDCLHTTP 1 CACHE BOOL "") +set(ENABLE_XRDEC 1 CACHE BOOL "") +set(XRDCL_LIB_ONLY 0 CACHE BOOL "") +set(XRDCL_ONLY 0 CACHE BOOL "") diff --git a/.gitattributes b/.gitattributes index 0893fe6afee..5f72683f8fc 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -VERSION_INFO export-subst +VERSION export-subst diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml new file mode 100644 index 00000000000..c2cdc9f6bd2 --- /dev/null +++ b/.github/workflows/CI.yml @@ -0,0 +1,303 @@ +name: CI + +on: + push: + branches-ignore: + - master + paths-ignore: + - .gitignore + - .gitlab-ci.yml + - .mailmap + - '**.md' + - 'docs/**' + - 'docker/**' + tags-ignore: + pull_request: + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +env: + CDASH: ${{ vars.CDASH }} + CMAKE_VERBOSE_MAKEFILE: true + CTEST_OUTPUT_ON_FAILURE: true + +jobs: + alpine: + name: Alpine + runs-on: ubuntu-latest + container: alpine + + env: + CMAKE_ARGS: -DCMAKE_INSTALL_PREFIX=/usr + + steps: + - name: Install dependencies + shell: sh + run: | + apk add \ + bash \ + cmake \ + ceph-dev \ + curl-dev \ + fuse-dev \ + fuse3-dev \ + g++ \ + git \ + gtest-dev \ + isa-l-dev \ + json-c-dev \ + krb5-dev \ + libxml2-dev \ + linux-headers \ + make \ + openssl \ + openssl-dev \ + py3-pip \ + py3-setuptools \ + py3-wheel \ + python3-dev \ + readline-dev \ + sudo \ + tinyxml-dev \ + util-linux-dev \ + uuidgen \ + zlib-dev + + - name: Clone repository + uses: actions/checkout@v1 + + - name: Setup GitHub runner user within container + run: adduser -D --uid 1001 runner && chown -R runner:runner ${GITHUB_WORKSPACE} + + - name: Build and Test with CTest + run: sudo -E -u runner ctest -VV -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + tests/post-install.sh + tests/check-headers.sh + + centos7: + name: CentOS 7 + runs-on: ubuntu-latest + container: centos:7 + + env: + CMAKE_ARGS: "-DCMAKE_INSTALL_PREFIX=/usr;-DCMAKE_INSTALL_RPATH='$ORIGIN/../$LIB'" + + steps: + - name: Install dependencies + run: | + yum install -y centos-release-scl epel-release git + yum install -y epel-rpm-macros rpmdevtools sudo yum-utils + + - name: Clone repository + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Setup GitHub runner user within container + run: adduser --uid 1001 runner && chown -R runner:runner . + + - name: Install XRootD build dependencies + run: yum-builddep -y xrootd.spec + + - name: Build and Test with CTest + run: | + source /opt/rh/devtoolset-7/enable + su -p runner -c 'ctest3 -VV -S test.cmake' + + alma8: + name: Alma 8 + runs-on: ubuntu-latest + container: almalinux:8 + + env: + CMAKE_ARGS: "-DCMAKE_INSTALL_PREFIX=/usr;-DCMAKE_INSTALL_RPATH='$ORIGIN/../$LIB'" + + steps: + - name: Install dependencies + run: | + dnf install -y dnf-plugins-core epel-release git rpmdevtools sudo + dnf config-manager --set-enabled powertools + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup GitHub runner user within container + run: adduser --uid 1001 runner && chown -R runner:runner ${GITHUB_WORKSPACE} + + - name: Install XRootD build dependencies + run: dnf builddep -y xrootd.spec + + - name: Build and Test with CTest + run: sudo -E -u runner ctest -VV -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + tests/post-install.sh + tests/check-headers.sh + + alma9: + name: Alma 9 + runs-on: ubuntu-latest + container: almalinux:9 + + env: + CMAKE_ARGS: "-DCMAKE_INSTALL_PREFIX=/usr;-DCMAKE_INSTALL_RPATH='$ORIGIN/../$LIB'" + + steps: + - name: Install dependencies + run: | + dnf install -y dnf-plugins-core epel-release git rpmdevtools sudo + dnf config-manager --set-enabled crb + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup GitHub runner user within container + run: adduser --uid 1001 runner && chown -R runner:runner ${GITHUB_WORKSPACE} + + - name: Install XRootD build dependencies + run: dnf builddep -y xrootd.spec + + - name: Build and Test with CTest + run: sudo -E -u runner ctest -VV -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + tests/post-install.sh + tests/check-headers.sh + + fedora: + name: Fedora + runs-on: ubuntu-latest + container: fedora + + env: + CMAKE_GENERATOR: Ninja + CMAKE_ARGS: "-DCMAKE_INSTALL_PREFIX=/usr;-DCMAKE_INSTALL_RPATH='$ORIGIN/../$LIB'" + + steps: + - name: Install dependencies + run: dnf install -y dnf-plugins-core git ninja-build rpmdevtools + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup GitHub runner user within container + run: adduser --uid 1001 runner && chown -R runner:runner ${GITHUB_WORKSPACE} + + - name: Install XRootD build dependencies + run: dnf builddep -y --define 'with_ceph 1' xrootd.spec + + - name: Build and Test with CTest + run: sudo -E -u runner ctest -VV -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + tests/post-install.sh + tests/check-headers.sh + + ubuntu: + name: Ubuntu + runs-on: ubuntu-latest + + strategy: + matrix: + compiler: [ gcc, clang ] + + env: + CC: ${{ matrix.compiler }} + DEBIAN_FRONTEND: noninteractive + CMAKE_ARGS: '-DINSTALL_PYTHON_BINDINGS=0;-DUSE_SYSTEM_ISAL=1;-DCMAKE_INSTALL_PREFIX=/usr' + + steps: + - name: Install development tools + run: | + sudo apt update -qq + sudo apt install -y build-essential devscripts equivs git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install XRootD build dependencies + run: mk-build-deps --install --remove -s sudo debian/control <<< yes + + - name: Build and Test with CTest + run: env CC=${CC} CXX=${CC/g*/g++} ctest -VV -S test.cmake + + - name: Install with CMake + run: sudo cmake --install build + + - name: Install Python bindings + run: | + sudo python3 -m pip install \ + --target /usr/lib/python3/dist-packages \ + --use-pep517 --verbose build/bindings/python + + - name: Run post-install tests + run: | + tests/post-install.sh + tests/check-headers.sh + + macos: + name: macOS + runs-on: macos-13 + + env: + CC: clang + CXX: clang++ + CMAKE_ARGS: "-DPython_FIND_UNVERSIONED_NAMES=FIRST" + CMAKE_PREFIX_PATH: /usr/local/opt/openssl@3 + + steps: + - name: Workaround for issue 1772 + run: sudo sed -i -e "s/localhost/localhost $(hostname)/g" /etc/hosts + + - name: Install dependencies with Homebrew + run: brew install davix googletest python-setuptools + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build and Test with CTest + run: ctest -VV --repeat until-pass:3 -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + export PYVERSION=$(python3 --version | grep -o 3...) + export PYTHONPATH=/usr/local/lib/python${PYVERSION}/site-packages + tests/post-install.sh diff --git a/.github/workflows/DEB.yml b/.github/workflows/DEB.yml new file mode 100644 index 00000000000..561a3518f19 --- /dev/null +++ b/.github/workflows/DEB.yml @@ -0,0 +1,127 @@ +name: DEB + +on: + push: + branches: + - master + paths-ignore: + - .gitignore + - .gitlab-ci.yml + - .mailmap + - '**.md' + - 'docs/**' + - 'docker/**' + tags-ignore: + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +env: + DEBIAN_FRONTEND: noninteractive + +jobs: + debian: + name: Debian + + strategy: + matrix: + version: [ 11, 12 ] + + runs-on: ubuntu-latest + container: debian:${{ matrix.version }} + + steps: + - name: Install development tools + run: | + apt update -qq + apt install -y build-essential devscripts git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install XRootD build dependencies + run: mk-build-deps --install --remove debian/control <<< yes + + - name: Build DEBs + run: | + git config --global --add safe.directory "$GITHUB_WORKSPACE" + VERSION=$(./genversion.sh --sanitize) + dch --create --package xrootd -v ${VERSION} -M 'XRootD automated build.' + debuild --no-tgz-check --no-sign -- binary-arch + + - name: Install DEBs + run: apt install -y ../*.deb + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move DEBs to Artifact Directory + run: | + source /etc/os-release + mkdir -p debian/${VERSION_CODENAME} + mv ../*.* debian/${VERSION_CODENAME} + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: debian-${{ matrix.version }} + path: debian + retention-days: 14 + + ubuntu: + name: Ubuntu + + strategy: + matrix: + version: [ "22.04", "24.04" ] + + runs-on: ubuntu-latest + container: ubuntu:${{ matrix.version }} + + steps: + - name: Install development tools + run: | + apt update -qq + apt install -y build-essential devscripts equivs git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install XRootD build dependencies + run: mk-build-deps --install --remove debian/control <<< yes + + - name: Build DEBs + run: | + git config --global --add safe.directory "$GITHUB_WORKSPACE" + VERSION=$(./genversion.sh --sanitize) + dch --create --package xrootd -v ${VERSION} -M 'XRootD automated build.' + debuild --no-tgz-check --no-sign -- binary-arch + + - name: Install DEBs + run: apt install -y ../*.deb + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move DEBs to Artifact Directory + run: | + source /etc/os-release + mkdir -p ubuntu/${VERSION_CODENAME} + mv ../*.* ubuntu/${VERSION_CODENAME} + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: ubuntu-${{ matrix.version }} + path: ubuntu + retention-days: 14 diff --git a/.github/workflows/QEMU.yml b/.github/workflows/QEMU.yml new file mode 100644 index 00000000000..bedd6c63bbf --- /dev/null +++ b/.github/workflows/QEMU.yml @@ -0,0 +1,57 @@ +name: QEMU + +on: + workflow_dispatch: + inputs: + os: + description: 'OS' + required: true + default: 'fedora' + type: choice + options: + - alma8 + - alma9 + - centos7 + - debian + - fedora + - ubuntu + arch: + description: 'Architecture' + required: true + default: 's390x' + type: choice + options: + - 386 + - amd64 + - arm + - arm64 + - ppc64le + - s390x + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.os }}-${{ inputs.arch }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +env: + DOCKER: podman + +jobs: + buildx: + name: QEMU (${{ inputs.os }}-${{ inputs.arch }}) + runs-on: ubuntu-latest + + steps: + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup QEMU for cross-building images + run: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes + + - name: Cross-build container with docker/podman buildx + run: cd docker && ./xrd-docker buildx ${{ inputs.os }} ${{ inputs.arch }} diff --git a/.github/workflows/RPM.yml b/.github/workflows/RPM.yml new file mode 100644 index 00000000000..70b4e7667a5 --- /dev/null +++ b/.github/workflows/RPM.yml @@ -0,0 +1,197 @@ +name: RPM + +on: + push: + branches: + - master + paths-ignore: + - .gitignore + - .gitlab-ci.yml + - .mailmap + - '**.md' + - 'docs/**' + - 'docker/**' + tags-ignore: + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + centos7: + name: CentOS 7 + runs-on: ubuntu-latest + container: centos:7 + + steps: + - name: Install git + run: yum install -y git + + - name: Clone repository + uses: actions/checkout@v1 + + - name: Install RPM development tools + run: | + yum install -y centos-release-scl epel-release + yum install -y epel-rpm-macros rpmdevtools yum-utils + + - name: Install XRootD build dependencies + run: yum-builddep -y xrootd.spec + + - name: Build RPMs + run: | + rpmdev-setuptree + git config --global --add safe.directory "$GITHUB_WORKSPACE" + git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + rpmbuild -bb --with git xrootd.spec + + - name: Install RPMs + run: yum install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move RPMs to Artifact Directory + run: mkdir RPMS && mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + + - name: Upload Artifacts + uses: actions/upload-artifact@v3 + with: + name: centos7 + path: RPMS + retention-days: 14 + + alma8: + name: Alma Linux 8 + runs-on: ubuntu-latest + container: almalinux:8 + + steps: + - name: Install git + run: yum install -y git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install RPM development tools + run: | + dnf install -y epel-release rpmdevtools dnf-plugins-core + dnf config-manager --set-enabled powertools + + - name: Install XRootD build dependencies + run: dnf builddep -y xrootd.spec + + - name: Build RPMs + run: | + rpmdev-setuptree + git config --global --add safe.directory "$GITHUB_WORKSPACE" + git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + rpmbuild -bb --with git xrootd.spec + + - name: Install RPMs + run: dnf install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move RPMs to Artifact Directory + run: mkdir RPMS && mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: alma8 + path: RPMS + retention-days: 14 + + alma9: + name: Alma Linux 9 + runs-on: ubuntu-latest + container: almalinux:9 + + steps: + - name: Install git + run: yum install -y git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install RPM development tools + run: | + dnf install -y epel-release rpmdevtools dnf-plugins-core + dnf config-manager --set-enabled crb + + - name: Install XRootD build dependencies + run: dnf builddep -y xrootd.spec + + - name: Build RPMs + run: | + rpmdev-setuptree + git config --global --add safe.directory "$GITHUB_WORKSPACE" + git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + rpmbuild -bb --with git xrootd.spec + + - name: Install RPMs + run: dnf install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move RPMs to Artifact Directory + run: mkdir RPMS && mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: alma9 + path: RPMS + retention-days: 14 + + fedora: + name: Fedora 39 + runs-on: ubuntu-latest + container: fedora:39 + + steps: + - name: Install git + run: yum install -y git + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install RPM development tools + run: | + dnf install -y rpmdevtools dnf-plugins-core + + - name: Install XRootD build dependencies + run: dnf builddep -y --define 'with_ceph 1' xrootd.spec + + - name: Build RPMs + run: | + rpmdev-setuptree + git config --global --add safe.directory "$GITHUB_WORKSPACE" + git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + rpmbuild -bb --with git --with ceph xrootd.spec + + - name: Install RPMs + run: dnf install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + + - name: Run post-install tests + run: tests/post-install.sh + + - name: Move RPMs to Artifact Directory + run: mkdir RPMS && mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: fc39 + path: RPMS + retention-days: 14 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index f3932993d3a..00000000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,904 +0,0 @@ -name: build - -on: - push: - pull_request: - schedule: - - cron: '23 1 * * 0' - release: - types: [published] - workflow_dispatch: - -defaults: - run: - shell: bash - -concurrency: - group: build-${{ github.ref }} - cancel-in-progress: true - -jobs: - - cmake-almalinux8: - - runs-on: ubuntu-latest - container: almalinux:8 - - steps: - - name: Install external dependencies with yum - run: | - dnf update -y - dnf clean all - dnf install -y epel-release - dnf install -y --enablerepo=powertools \ - cmake \ - cppunit-devel \ - curl-devel \ - davix-devel \ - diffutils \ - file \ - fuse-devel \ - gcc-c++ \ - git \ - json-c-devel \ - krb5-devel \ - libmacaroons-devel \ - libtool \ - libuuid-devel \ - libxml2-devel \ - make \ - openssl-devel \ - python3-devel \ - python3-setuptools \ - readline-devel \ - scitokens-cpp-devel \ - systemd-devel \ - tinyxml-devel \ - voms-devel \ - yasm \ - zlib-devel - dnf clean all - - - name: Clone repository - uses: actions/checkout@v2 - - - name: Build with cmake - run: | - cd .. - cmake \ - -DCMAKE_CXX_STANDARD=17 \ - -DCMAKE_BUILD_TYPE=RelWithDebInfo \ - -DCMAKE_INSTALL_PREFIX=/usr \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DFORCE_ENABLED=ON \ - -DENABLE_TESTS=ON \ - -DENABLE_XRDEC=ON \ - -DENABLE_MACAROONS=ON \ - -DENABLE_SCITOKENS=ON \ - -DPIP_OPTIONS="--verbose" \ - -S xrootd \ - -B build - cmake build -LH - cmake \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - cmake --build build --target install - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - - name: Run libXrdCl tests - run: | - cd ../build/tests - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/UtilsTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/SocketTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PollerTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PostMasterTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/FileSystemTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/LocalFileHandlerTest/' - - cmake-almalinux9: - - runs-on: ubuntu-latest - container: almalinux:9 - - steps: - - name: Install external dependencies with yum - run: | - dnf update -y - dnf clean all - dnf install -y epel-release - dnf install -y --enablerepo=crb \ - cmake \ - cppunit-devel \ - curl-devel \ - davix-devel \ - diffutils \ - file \ - fuse-devel \ - gcc-c++ \ - git \ - json-c-devel \ - krb5-devel \ - libmacaroons-devel \ - libtool \ - libuuid-devel \ - libxml2-devel \ - make \ - openssl-devel \ - python3-devel \ - python3-setuptools \ - readline-devel \ - scitokens-cpp-devel \ - systemd-devel \ - tinyxml-devel \ - voms-devel \ - yasm \ - zlib-devel - dnf clean all - - - name: Clone repository - uses: actions/checkout@v2 - - - name: Build with cmake - run: | - cd .. - cmake \ - -DCMAKE_CXX_STANDARD=17 \ - -DCMAKE_BUILD_TYPE=RelWithDebInfo \ - -DCMAKE_INSTALL_PREFIX=/usr \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DFORCE_ENABLED=ON \ - -DENABLE_TESTS=ON \ - -DENABLE_XRDEC=ON \ - -DENABLE_MACAROONS=ON \ - -DENABLE_SCITOKENS=ON \ - -DPIP_OPTIONS="--verbose" \ - -S xrootd \ - -B build - cmake build -LH - cmake \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - cmake --build build --target install - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - - name: Run libXrdCl tests - run: | - cd ../build/tests - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/UtilsTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/SocketTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PollerTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PostMasterTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/FileSystemTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/LocalFileHandlerTest/' - - cmake-centos7: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - - name: Install external dependencies with yum - run: | - yum update -y - yum install -y epel-release centos-release-scl - yum clean all - yum install --nogpg -y \ - cmake3 \ - make \ - krb5-devel \ - libuuid-devel \ - libxml2-devel \ - openssl-devel \ - systemd-devel \ - zlib-devel \ - devtoolset-7-gcc-c++ \ - python3-devel \ - python3-setuptools \ - git \ - cppunit-devel - yum clean all - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - - name: Build with cmake - run: | - . /opt/rh/devtoolset-7/enable - cd .. - cmake3 \ - -DCMAKE_INSTALL_PREFIX=/usr/local/ \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DENABLE_TESTS=ON \ - -DPIP_OPTIONS="--verbose" \ - -S xrootd \ - -B build - cmake3 build -LH - cmake3 \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - cmake3 --build build --target install - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - - name: Run libXrdCl tests - run: | - cd ../build/tests - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/UtilsTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/SocketTest/' - ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PollerTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/PostMasterTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/FileSystemTest/' - # ./common/test-runner ./XrdClTests/libXrdClTests.so 'All Tests/LocalFileHandlerTest/' - - cmake-centos7-updated-python: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - - name: Install external dependencies with yum - run: | - yum update -y - yum install -y epel-release centos-release-scl - yum clean all - yum install --nogpg -y \ - cmake3 \ - make \ - krb5-devel \ - libuuid-devel \ - libxml2-devel \ - openssl-devel \ - systemd-devel \ - zlib-devel \ - devtoolset-7-gcc-c++ \ - python3-devel \ - python3-setuptools \ - git \ - cppunit-devel - yum clean all - python3 -m pip --no-cache-dir install --upgrade pip setuptools wheel - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - # Use extra PIP_OPTIONS strings as example that this is possible. - # N.B.: None of the PIP_OPTIONS are required for this step to work. - - name: Build with cmake - run: | - . /opt/rh/devtoolset-7/enable - cd .. - cmake3 \ - -DCMAKE_INSTALL_PREFIX=/usr/local/ \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DENABLE_TESTS=ON \ - -DPIP_OPTIONS="--verbose --force-reinstall --prefix /usr/local/" \ - -S xrootd \ - -B build - cmake3 build -LH - cmake3 \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - cmake3 --build build --target install - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - # TODO: Drop once Python 2 support is dropped - cmake-centos7-python2: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - # python2-pip is broken on CentOS so can't upgrade pip, setuptools, or wheel - - name: Install external dependencies with yum - run: | - yum update -y - yum install -y epel-release centos-release-scl - yum clean all - yum install --nogpg -y \ - cmake3 \ - make \ - krb5-devel \ - libuuid-devel \ - libxml2-devel \ - openssl-devel \ - systemd-devel \ - zlib-devel \ - devtoolset-7-gcc-c++ \ - python2-pip \ - python2-setuptools \ - python2-devel \ - git \ - cppunit-devel - yum clean all - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - # Deprecated setup.py install will try to install under ${CMAKE_INSTALL_PREFIX}/lib64 - # so set CMAKE_INSTALL_PREFIX=/usr/ to make testing easy - - name: Build with cmake - run: | - . /opt/rh/devtoolset-7/enable - cd .. - cmake3 \ - -DCMAKE_INSTALL_PREFIX=/usr/ \ - -DPYTHON_EXECUTABLE=$(command -v python2) \ - -DENABLE_TESTS=ON \ - -DPIP_OPTIONS="--verbose" \ - -DXRD_PYTHON_REQ_VERSION="2.7" \ - -S xrootd \ - -B build - cmake3 build -LH - cmake3 \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - cmake3 --build build --target install - python2 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python2 --version - python2 -m pip list - python2 -m pip show xrootd - python2 -c 'import XRootD; print(XRootD)' - python2 -c 'import pyxrootd; print(pyxrootd)' - python2 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - cmake-ubuntu-updated-python: - - # Use of sudo as https://github.com/actions/virtual-environments requires it - runs-on: ubuntu-latest - - steps: - - name: Install external dependencies with apt-get - run: | - sudo apt-get update -y - DEBIAN_FRONTEND=noninteractive sudo apt-get install -y \ - g++ \ - git \ - cmake \ - uuid-dev \ - dpkg-dev \ - libssl-dev \ - libx11-dev \ - python3 \ - python3-pip \ - python3-venv \ - python3-dev - sudo apt-get autoclean -y - python3 -m pip --no-cache-dir install --upgrade pip setuptools wheel - - - name: Clone repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Build with cmake - run: | - cd .. - cmake \ - -DCMAKE_INSTALL_PREFIX=/usr \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DENABLE_TESTS=ON \ - -DPIP_OPTIONS="--verbose" \ - -S xrootd \ - -B build - cmake build -LH - cmake \ - --build build \ - --clean-first \ - --parallel $(($(nproc) - 1)) - sudo cmake --build build --target install - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - cmake-macos: - - runs-on: macos-latest - - steps: - - name: Install external dependencies with homebrew - run: | - brew install \ - cmake \ - make \ - gcc \ - zlib \ - krb5 \ - ossp-uuid \ - libxml2 \ - openssl@3 - - - name: Install necessary Python libraries - run: | - python3 -m pip install --upgrade pip setuptools wheel - python3 -m pip list - - - name: Clone repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - # Given how homebrew installs things, openssl needs to be have its locations - # be given explicitly. - - name: Build with cmake - run: | - cd .. - cmake \ - -DCMAKE_C_COMPILER=clang \ - -DCMAKE_CXX_COMPILER=clang++ \ - -DCMAKE_INSTALL_PREFIX=/usr/local/ \ - -DCMAKE_PREFIX_PATH=/usr/local/opt/openssl@3 \ - -DPYTHON_EXECUTABLE=$(command -v python3) \ - -DENABLE_TESTS=ON \ - -DPIP_OPTIONS="--verbose" \ - -S xrootd \ - -B build - cmake build -LH - cmake \ - --build build \ - --clean-first \ - --parallel $(($(sysctl -n hw.ncpu) - 1)) - cmake --build build --target install - python3 -m pip install --user build/bindings/python - python3 -m pip list - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - export DYLD_LIBRARY_PATH=/usr/local/lib - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - rpm-centos7: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - - name: Overwrite /etc/yum.repos.d/epel.repo to remove epel-source - run: | - yum install -y epel-release centos-release-scl - head -n -8 /etc/yum.repos.d/epel.repo > /tmp/epel.repo - mv -f /tmp/epel.repo /etc/yum.repos.d/epel.repo - yum clean all - - - name: Install external dependencies with yum - run: | - yum update -y - yum install --nogpg -y \ - gcc-c++ \ - rpm-build \ - git \ - python-srpm-macros \ - centos-release-scl - yum clean all - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - - name: Build - run: | - cd packaging/ - ./makesrpm.sh \ - --define "_with_python3 1" \ - --define "_with_tests 1" \ - --define "_with_xrdclhttp 1" \ - --define "_with_scitokens 1" \ - --define "_with_isal 1" - yum-builddep --nogpgcheck -y *.src.rpm - mkdir RPMS - rpmbuild --rebuild \ - --define "_rpmdir RPMS/" \ - --define "_with_python3 1" \ - --define "_with_tests 1" \ - --define "_with_xrdclhttp 1" \ - --define "_with_scitokens 1" \ - --define "_with_isal 1" \ - --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" \ - *.src.rpm - - - name: Install - run: | - ls -lh packaging/RPMS/ - yum install -y \ - ./packaging/RPMS/xrootd-*.rpm \ - ./packaging/RPMS/python3-xrootd-*.rpm - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - - name: Build sdist using publishing workflow - run: | - cp packaging/wheel/* . - ./publish.sh - ls -lhtra dist/ - - rpm-fedora: - - runs-on: ubuntu-latest - container: fedora:37 - - steps: - - name: Install external dependencies with dnf - run: | - dnf update -y - dnf install --nogpg -y \ - gcc-c++ \ - rpm-build \ - tar \ - dnf-plugins-core \ - git - dnf clean all - - - name: Clone repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Build - run: | - # c.f. https://github.com/actions/checkout/issues/760 - git config --global --add safe.directory "$GITHUB_WORKSPACE" - cd packaging/ - ./makesrpm.sh \ - --define "_with_python3 1" \ - --define "_with_ceph11 1" - dnf builddep --nogpgcheck -y *.src.rpm - mkdir RPMS - rpmbuild --rebuild \ - --define "_rpmdir RPMS/" \ - --define "_with_python3 1" \ - --define "_with_ceph11 1" \ - --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" \ - *.src.rpm - - - name: Install - run: | - ls -lh packaging/RPMS/ - dnf install -y \ - ./packaging/RPMS/xrootd-*.rpm \ - ./packaging/RPMS/python3-xrootd-*.rpm - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - dpkg-ubuntu: - - # Use of sudo as https://github.com/actions/virtual-environments requires it - runs-on: ubuntu-latest - - steps: - - name: Install external dependencies with apt-get - run: | - sudo apt-get update -y - DEBIAN_FRONTEND=noninteractive sudo apt-get install -y \ - g++ \ - git \ - cmake \ - debhelper \ - devscripts \ - equivs \ - gdebi-core - sudo apt-get autoclean -y - - - name: Clone repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Build .deb - run: | - mv packaging/debian/python3-xrootd.install.new packaging/debian/python3-xrootd.install - cp -R packaging/debian/ . - mk-build-deps --build-dep debian/control - sudo gdebi -n xrootd-build-deps-depends*.deb - version=`./genversion.sh --print-only` - dch --create -v `echo $version | sed 's/^v\(.*\)/\1/'` --package xrootd --urgency low --distribution $(lsb_release -cs) -M "This package is built and released automatically. For important notices and releases subscribe to our maling lists or visit our website." - dpkg-buildpackage -b -us -uc -tc --buildinfo-option="-udeb_packages" --buildinfo-file="deb_packages/xrootd_$(dpkg-parsechangelog -S version)_$(dpkg-architecture -qDEB_BUILD_ARCH).buildinfo" --changes-option="-udeb_packages" --buildinfo-file="deb_packages/xrootd_$(dpkg-parsechangelog -S version)_$(dpkg-architecture -qDEB_BUILD_ARCH).changes" - - - name: Install - run: | - ls -lh deb_packages/*.deb - sudo apt-get install -y \ - ./deb_packages/libxr*_*.deb \ - ./deb_packages/xrootd-libs_*.deb \ - ./deb_packages/xrootd-client*_*.deb \ - ./deb_packages/xrootd-devel_*.deb \ - ./deb_packages/xrootd-plugins_*.deb \ - ./deb_packages/xrootd-server*_*.deb \ - ./deb_packages/python3-xrootd_*.deb - - - name: Verify install - run: | - command -v xrootd - command -v xrdcp - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - sdist-centos7: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - - name: Install external dependencies with yum - run: | - yum update -y - yum install -y epel-release centos-release-scl - yum clean all - yum install --nogpg -y \ - cmake3 \ - gcc-c++ \ - make \ - krb5-devel \ - libuuid-devel \ - libxml2-devel \ - openssl-devel \ - systemd-devel \ - zlib-devel \ - devtoolset-7-gcc-c++ \ - python3-devel \ - python3-setuptools \ - git \ - tree \ - cppunit-devel - yum clean all - python3 -m pip --no-cache-dir install wheel - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - - name: Build sdist using publishing workflow - run: | - cp packaging/wheel/* . - ./publish.sh - python3 -m pip --verbose install --upgrade ./dist/xrootd-*.tar.gz - python3 -m pip list - - - name: Show site-packages layout for XRootD modules - run: | - find $(python3 -c 'import XRootD; import pathlib; print(str(pathlib.Path(XRootD.__path__[0]).parent))') \ - -type d \ - -iname "*xrootd*" | xargs tree - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - sdist-centos7-updated-python: - - runs-on: ubuntu-latest - container: centos:7 - - steps: - - name: Install external dependencies with yum - run: | - yum update -y - yum install -y epel-release centos-release-scl - yum clean all - yum install --nogpg -y \ - cmake3 \ - gcc-c++ \ - make \ - krb5-devel \ - libuuid-devel \ - libxml2-devel \ - openssl-devel \ - systemd-devel \ - zlib-devel \ - devtoolset-7-gcc-c++ \ - python3-devel \ - python3-setuptools \ - git \ - tree \ - cppunit-devel - yum clean all - python3 -m pip --no-cache-dir install --upgrade pip setuptools wheel - - # Need to use v1 of action as image Git is too old - - name: Clone repository now that Git is available - uses: actions/checkout@v1 - - - name: Build sdist using publishing workflow - run: | - cp packaging/wheel/* . - ./publish.sh - python3 -m pip --verbose install --upgrade ./dist/xrootd-*.tar.gz - python3 -m pip list - - - name: Show site-packages layout for XRootD modules - run: | - find $(python3 -c 'import XRootD; import pathlib; print(str(pathlib.Path(XRootD.__path__[0]).parent))') \ - -type d \ - -iname "*xrootd*" | xargs tree - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' - - sdist-ubuntu: - - # Use of sudo as https://github.com/actions/virtual-environments requires it - runs-on: ubuntu-latest - - steps: - - name: Install external dependencies with apt-get - run: | - sudo apt-get update -y - DEBIAN_FRONTEND=noninteractive sudo apt-get install -y \ - g++ \ - git \ - cmake \ - uuid-dev \ - dpkg-dev \ - libssl-dev \ - libx11-dev \ - python3 \ - python3-pip \ - python3-venv \ - python3-dev \ - pkg-config \ - tree - sudo apt-get autoclean -y - # Remove packages with invalid versions which cause sdist build to fail - sudo apt-get remove python3-debian python3-distro-info - python3 -m pip --no-cache-dir install --upgrade pip setuptools wheel - python3 -m pip list - - - name: Clone repository - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Build sdist using publishing workflow - run: | - cp packaging/wheel/* . - ./publish.sh - python3 -m pip --verbose install --upgrade ./dist/xrootd-*.tar.gz - python3 -m pip list - - - name: Show site-packages layout for XRootD modules - run: | - find $(python3 -c 'import XRootD; import pathlib; print(str(pathlib.Path(XRootD.__path__[0]).parent))') \ - -type d \ - -iname "*xrootd*" | xargs tree - - - name: Verify Python bindings - run: | - python3 --version --version - python3 -m pip list - python3 -m pip show xrootd - python3 -c 'import XRootD; print(XRootD)' - python3 -c 'import pyxrootd; print(pyxrootd)' - python3 -c 'from XRootD import client; print(client.FileSystem("root://someserver:1094"))' diff --git a/.github/workflows/macOS.yml b/.github/workflows/macOS.yml new file mode 100644 index 00000000000..ee34f594091 --- /dev/null +++ b/.github/workflows/macOS.yml @@ -0,0 +1,68 @@ +name: macOS + +on: + push: + branches: + - macos + paths-ignore: + - .gitignore + - .gitlab-ci.yml + - .mailmap + - '**.md' + - 'docs/**' + - 'docker/**' + tags-ignore: + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +defaults: + run: + shell: bash + +env: + CDASH: ${{ vars.CDASH }} + CMAKE_VERBOSE_MAKEFILE: true + CTEST_OUTPUT_ON_FAILURE: true + +jobs: + macos: + strategy: + matrix: + version: [ 12, 13, 14 ] + fail-fast: false + + name: macOS + runs-on: macos-${{ matrix.version }} + + env: + CC: clang + CXX: clang++ + CMAKE_ARGS: "-DPython_FIND_UNVERSIONED_NAMES=FIRST" + CMAKE_PREFIX_PATH: /usr/local/opt/openssl@3 + + steps: + - name: Workaround for issue 1772 + run: sudo sed -i -e "s/localhost/localhost $(hostname)/g" /etc/hosts + + - name: Install dependencies with Homebrew + run: brew install davix googletest python-setuptools + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build and Test with CTest + run: ctest -VV --repeat until-pass:3 -S test.cmake + + - name: Install with CMake + run: cmake --install build + + - name: Run post-install tests + run: | + export PYVERSION=$(python3 --version | grep -o 3...) + export PYTHONPATH=/usr/local/lib/python${PYVERSION}/site-packages + tests/post-install.sh diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml new file mode 100644 index 00000000000..a634f9916da --- /dev/null +++ b/.github/workflows/python.yml @@ -0,0 +1,75 @@ +name: Python + +on: + push: + branches: + - devel + - master + paths: + - setup.py + - pyproject.toml + - bindings/python + tags-ignore: + pull_request: + paths: + - setup.py + - pyproject.toml + - bindings/python + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + manylinux: + name: Python + runs-on: ubuntu-latest + container: quay.io/pypa/manylinux_2_28_x86_64 + + strategy: + matrix: + version: [ "3.6", "3.8", "3.10", "3.11", "3.12" ] + + env: + PYTHON: python${{ matrix.version }} + + steps: + - name: Install dependencies + run: dnf install -y git krb5-devel libuuid-devel openssl-devel + + - name: Clone repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build source distribution tarball + run: | + git config --global --add safe.directory "$GITHUB_WORKSPACE" + ./genversion.sh --sanitize >| VERSION + ${PYTHON} -m build --sdist + + - name: Build binary wheel + run: ${PYTHON} -m pip wheel --use-pep517 --verbose dist/*.tar.gz + + - name: Install binary wheel + run: ${PYTHON} -m pip install xrootd*.whl + + - name: Run post-installation tests + run: | + command -v ${PYTHON} && ${PYTHON} --version + ${PYTHON} -m pip show xrootd + ${PYTHON} -c 'import XRootD; print(XRootD)' + ${PYTHON} -c 'import pyxrootd; print(pyxrootd)' + ${PYTHON} -c 'from XRootD import client; help(client)' + ${PYTHON} -c 'from XRootD import client; print(client.FileSystem("root://localhost"))' + + - name: Move binary wheels to artifact directory + run: mv *.whl dist/ + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: python-${{ matrix.version }} + path: dist + retention-days: 14 diff --git a/.gitignore b/.gitignore index 15dff770410..11165537c4d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,60 +1,7 @@ -*.o -*.lo -.libs -.deps -Makefile -Makefile.in -*.la -GNUmakefile.classic -aclocal.m4 -autom4te.cache/ -compile -config/GNUmake.rules.sunCC -config/GNUmake.rules.sunCCamd -config/GNUmake.rules.sunCCamd510 -config/GNUmake.rules.sunCCamd64 -config/GNUmake.rules.sunCCi86pc -config.guess -config.log -config.status -config.sub -configure -depcomp -install-sh -lib/ -libtool -ltmain.sh -missing -src/GNUmake.env -src/GNUmake.options -src/Makefile_include -src/XrdAcc/XrdAccTest -src/XrdApps/mpxstats -src/XrdApps/wait41 -src/XrdApps/xrdadler32 -src/XrdClient/TestXrdClient -src/XrdClient/TestXrdClient_read -src/XrdClient/XrdClientAdmin_c_wrap.cc -src/XrdClient/xprep -src/XrdClient/xrd -src/XrdClient/xrdcp -src/XrdClient/xrdstagetool -src/XrdCms/cmsd -src/XrdCns/XrdCnsd -src/XrdCns/cns_ssi -src/XrdFrm/frm_admin -src/XrdFrm/frm_purged -src/XrdFrm/frm_xfragent -src/XrdFrm/frm_xfrd -src/XrdSec/testclient -src/XrdSec/testserver -src/XrdSecgsi/xrdgsiproxy -src/XrdSecpwd/xrdpwdadmin -src/XrdSecssl/xrdsecssltest -src/XrdSecsss/xrdsssadmin -src/XrdXrootd/xrootd -test/testconfig.sh -xrootd.spec -dist +# CMake build directory +build/ +# docker builds +docker/xrootd.tar.gz +# Python build artifacts +dist/ *.egg-info -bindings/python/VERSION diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a23eca3238e..680157a0caf 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,846 +1,97 @@ stages: - - build:rpm - - build:dockerimage:prepare - - build:dockerimage - - test - - publish - - post:publish - - clean + - build -.template:deb_ubuntu_build: &deb_ubuntu_build_def - stage: build:rpm - script: - - export DEBIAN_FRONTEND=noninteractive - - apt-get update - - apt-get install -y git cmake g++ debhelper devscripts equivs gdebi-core - - cp -R packaging/debian/ . - - mk-build-deps --build-dep debian/control - - gdebi -n xrootd-build-deps-depends*.deb - - version=`./genversion.sh --print-only` - - dch --create -v `echo $version | sed 's/^v\(.*\)/\1/'` --package xrootd --urgency low --distribution ${DIST} -M "This package is built and released automatically. For important notices and releases subscribe to our maling lists or visit our website." - - dpkg_version=`dpkg-query --showformat='${Version}' --show dpkg` - - rc=0 ; dpkg --compare-versions $dpkg_version "ge" "1.18.11" || rc=$? - - if [ $rc -eq "0" ]; then - dpkg-buildpackage -b -us -uc -tc --buildinfo-option="-udeb_packages" --changes-option="-udeb_packages" ; - else - dpkg-buildpackage -b -us -uc -tc --changes-option="-udeb_packages" ; - fi - - mkdir ${DIST}/ - - cp deb_packages/*.deb ${DIST}/ - - if [[ $DEBUG = "true" ]] ; then cp deb_packages/*.ddeb ${DIST}/; fi - artifacts: - expire_in: 1 day - paths: - - ${DIST}/ - tags: - - docker_node - -.template:deb_ubuntu_build: &deb_ubuntu_build_new_def - stage: build:rpm - script: - - export DEBIAN_FRONTEND=noninteractive - - apt-get update - - apt-get install -y git cmake g++ debhelper devscripts equivs gdebi-core - - mv packaging/debian/python3-xrootd.install.new packaging/debian/python3-xrootd.install - - cp -R packaging/debian/ . - - mk-build-deps --build-dep debian/control - - gdebi -n xrootd-build-deps-depends*.deb - - version=`./genversion.sh --print-only` - - dch --create -v `echo $version | sed 's/^v\(.*\)/\1/'` --package xrootd --urgency low --distribution ${DIST} -M "This package is built and released automatically. For important notices and releases subscribe to our maling lists or visit our website." - - dpkg-buildpackage -b -us -uc -tc --buildinfo-option="-udeb_packages" --buildinfo-file="deb_packages/xrootd_$(dpkg-parsechangelog -S version)_$(dpkg-architecture -qDEB_BUILD_ARCH).buildinfo" --changes-option="-udeb_packages" --buildinfo-file="deb_packages/xrootd_$(dpkg-parsechangelog -S version)_$(dpkg-architecture -qDEB_BUILD_ARCH).changes" - - mkdir ${DIST}/ - - cp deb_packages/*.deb ${DIST}/ - - if [[ $DEBUG = "true" ]] ; then cp deb_packages/*.ddeb ${DIST}/; fi - artifacts: - expire_in: 1 day - paths: - - ${DIST}/ - tags: - - docker_node - -build:cs9: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cs9-base - script: - - dnf install -y epel-release - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git - - dnf install -y cppunit-devel - - cd packaging/ - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" -D "dist .el9" - - dnf builddep --nogpgcheck -y *.src.rpm - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" -D "dist .el9" *.src.rpm - - cd .. - - mkdir cs-9 - - cp packaging/RPMS/*.rpm cs-9 - - cp packaging/*src.rpm cs-9 - artifacts: - expire_in: 1 day - paths: - - cs-9/ - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - allow_failure: true - -build:cs8: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cs8-base - script: - - dnf install -y epel-release - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git - - dnf config-manager --set-enabled powertools - - cd packaging - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" - - dnf builddep --nogpgcheck -y *.src.rpm - - dnf -y update libarchive - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir cs-8 - - cp packaging/*.src.rpm cs-8 - - cp packaging/RPMS/* cs-8 - artifacts: - expire_in: 1 day - paths: - - cs-8/ - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -build:cc7: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - head -n -6 /etc/yum.repos.d/epel.repo > /tmp/epel.repo ; mv -f /tmp/epel.repo /etc/yum.repos.d/epel.repo - - yum install --nogpg -y gcc-c++ rpm-build git python-srpm-macros centos-release-scl - - cd packaging/ - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" - - yum-builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir cc-7/ - - cp packaging/*.src.rpm cc-7 - - cp packaging/RPMS/* cc-7 - artifacts: - expire_in: 1 day - paths: - - cc-7/ - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -#build:fedora-36: -# stage: build:rpm -# image: fedora:36 -# script: -# - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git -# - cd packaging/ -# - ./makesrpm.sh --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" -# - dnf builddep --nogpgcheck -y *.src.rpm -# - mkdir RPMS -# - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm -# - cd .. -# - mkdir fc-rawhide -# - cp packaging/*.src.rpm fc-rawhide -# - cp packaging/RPMS/* fc-rawhide -# artifacts: -# expire_in: 1 day -# paths: -# - fc-rawhide/ -# tags: -# - docker_node -# only: -# - master -# - /^stable-.*$/ -# except: -# - tags -# - schedules -# - web - -build:fedora-35: - stage: build:rpm - image: fedora:35 - script: - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git - - cd packaging/ - - ./makesrpm.sh --define "_with_python3 1" --define "_with_ceph11 1" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_ceph11 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir fc-35/ - - cp packaging/*.src.rpm fc-35 - - cp packaging/RPMS/* fc-35 - artifacts: - expire_in: 1 day - paths: - - fc-35/ - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -build:fedora-34: - stage: build:rpm - image: fedora:34 - script: - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git - - cd packaging/ - - ./makesrpm.sh --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir fc-34/ - - cp packaging/*.src.rpm fc-34 - - cp packaging/RPMS/* fc-34 - artifacts: - expire_in: 1 day - paths: - - fc-34/ +default: tags: - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web -build:fedora-36: - stage: build:rpm - image: fedora:36 - script: - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git - - cd packaging/ - - ./makesrpm.sh --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_ceph11 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir fc-36/ - - cp packaging/*.src.rpm fc-36 - - cp packaging/RPMS/* fc-36 - artifacts: - expire_in: 1 day - paths: - - fc-36/ - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - allow_failure: true - -build:deb_ubuntu_bionic: - image: ubuntu:bionic - <<: *deb_ubuntu_build_def - variables: - DIST: bionic - DEBUG: "true" - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -build:deb_ubuntu_focal: - image: ubuntu:focal - <<: *deb_ubuntu_build_def +.deb_build: &deb_build + stage: build variables: - DIST: focal - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -build:deb_ubuntu_jammy: - image: ubuntu:jammy - <<: *deb_ubuntu_build_new_def - variables: - DIST: jammy - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - allow_failure: true - -build:macosx: - stage: build:rpm - script: - - mkdir build - - mkdir -p tarball/xrootd - - cd build - - /usr/local/bin/cmake -D ZLIB_INCLUDE_DIR=/usr/local/Cellar/zlib/1.2.8/include/ -D OPENSSL_INCLUDE_DIR=/usr/local/Cellar/openssl/1.0.2t/include/ -D OPENSSL_SSL_LIBRARY=/usr/local/Cellar/openssl/1.0.2t/lib/libssl.dylib -D OPENSSL_CRYPTO_LIBRARY=/usr/local/Cellar/openssl/1.0.2t/lib/libcrypto.1.0.0.dylib -DCMAKE_INSTALL_PREFIX=../tarball/xrootd .. - - cd src/XrdCl/ - - make -j4 - - make install - - cd ../../../tarball - - tar -zcf xrootd.tar.gz xrootd - - cd .. - - mkdir osx - - cp tarball/xrootd.tar.gz osx - artifacts: - expire_in: 1 day - paths: - - osx/ - tags: - - macosx-shell - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - allow_failure: true - -release:cs8-x86_64: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cs8-base - script: + DEBIAN_FRONTEND: noninteractive + script: + - source /etc/os-release + - apt update -qq + - apt install -y build-essential devscripts equivs git + - VERSION=$(./genversion.sh --sanitize) + - dch --create --package xrootd -v ${VERSION} -M 'XRootD automated build.' + - mk-build-deps --install --remove debian/control <<< y + - debuild --no-tgz-check --no-sign -b + - apt install -y ../*.d*eb + - mkdir -p DEB/${ID}/${VERSION_CODENAME} + - mv ../*.* DEB/${ID}/${VERSION_CODENAME} + - tests/post-install.sh + artifacts: + paths: [ DEB ] + expire_in: 1d + +.rpm_build_yum: &rpm_build_yum + stage: build + script: + - yum install -y centos-release-scl epel-release git + - yum install -y epel-rpm-macros rpmdevtools yum-utils + - yum-builddep -y xrootd.spec + - rpmdev-setuptree + - git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + - rpmbuild -bb --with git xrootd.spec + - yum install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + - tests/post-install.sh + - mkdir -p RPMS + - mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + artifacts: + paths: [ RPMS ] + expire_in: 1d + +.rpm_build_dnf: &rpm_build_dnf + stage: build + script: + - dnf install -y dnf-plugins-core git rpmdevtools + - rpmdev-setuptree + - dnf builddep -y xrootd.spec + - git archive --prefix xrootd/ -o $(rpm -E '%{_sourcedir}')/xrootd.tar.gz HEAD + - rpmbuild -bb --with git xrootd.spec + - dnf install -y $(rpm -E '%{_rpmdir}')/*/*.rpm + - tests/post-install.sh + - mkdir -p RPMS + - mv $(rpm -E '%{_rpmdir}')/ RPMS$(rpm -E '%{dist}' | tr . /) + artifacts: + paths: [ RPMS ] + expire_in: 1d + +Debian 11: + image: debian:11 + <<: *deb_build + +Debian 12: + image: debian:12 + <<: *deb_build + +Ubuntu 22.04: + image: ubuntu:22.04 + <<: *deb_build + +CentOS 7: + image: centos:7 + <<: *rpm_build_yum + +AlmaLinux 8: + image: almalinux:8 + before_script: - dnf install -y epel-release - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git python-macros - dnf config-manager --set-enabled powertools - - dnf install -y cppunit-devel - - dnf -y update libarchive - - mkdir cs-8-x86_64 - - ./gen-tarball.sh $CI_COMMIT_TAG - - mv xrootd-${CI_COMMIT_TAG#"v"}.tar.gz cs-8-x86_64 - - cd packaging/ - - git checkout tags/${CI_COMMIT_TAG} - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" -D "dist .el8" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" -D "dist .el8" *.src.rpm - - cd .. - - cp packaging/RPMS/*.rpm cs-8-x86_64 - - cp packaging/*src.rpm cs-8-x86_64 - artifacts: - expire_in: 1 day - paths: - - cs-8-x86_64/ - tags: - - docker_node - only: - - web - except: - - branches + <<: *rpm_build_dnf -release:rocky8-x86_64: - stage: build:rpm - image: rockylinux:8 - script: +AlmaLinux 9: + image: almalinux:9 + before_script: - dnf install -y epel-release - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git python-macros - - dnf config-manager --set-enabled powertools - - dnf install -y cppunit-devel - - dnf -y update libarchive - - mkdir rocky-8-x86_64 - - ./gen-tarball.sh $CI_COMMIT_TAG - - mv xrootd-${CI_COMMIT_TAG#"v"}.tar.gz cs-8-x86_64 - - cd packaging/ - - git checkout tags/${CI_COMMIT_TAG} - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" -D "dist .el8" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" -D "dist .el8" *.src.rpm - - cd .. - - cp packaging/RPMS/*.rpm rocky-8-x86_64 - - cp packaging/*src.rpm rocky-8-x86_64 - artifacts: - expire_in: 1 day - paths: - - rocky-8-x86_64/ - tags: - - docker_node - only: - - web - except: - - branches - -release:cc7-x86_64: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - head -n -6 /etc/yum.repos.d/epel.repo > /tmp/epel.repo ; mv -f /tmp/epel.repo /etc/yum.repos.d/epel.repo - - yum install --nogpg -y gcc-c++ rpm-build git python-srpm-macros centos-release-scl - - mkdir cc-7-x86_64 - - ./gen-tarball.sh $CI_COMMIT_TAG - - mv xrootd-${CI_COMMIT_TAG#"v"}.tar.gz cc-7-x86_64 - - cd packaging/ - - git checkout tags/${CI_COMMIT_TAG} - - ./makesrpm.sh --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" -D "dist .el7" - - yum-builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_python3 1" --define "_with_tests 1" --define "_without_xrootd_user 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" -D "dist .el7" *.src.rpm - - cd .. - - cp packaging/RPMS/*.rpm cc-7-x86_64 - - cp packaging/*src.rpm cc-7-x86_64 - artifacts: - expire_in: 1 day - paths: - - cc-7-x86_64/ - tags: - - docker_node - only: - - web - except: - - branches + - dnf config-manager --set-enabled crb + <<: *rpm_build_dnf -release:deb_ubuntu_bionic: - image: ubuntu:bionic - <<: *deb_ubuntu_build_def - variables: - DIST: bionic - DEBUG: "true" - only: - - web - except: - - branches - -release:deb_ubuntu_focal: - image: ubuntu:focal - <<: *deb_ubuntu_build_def - variables: - DIST: focal - only: - - web - except: - - branches - -release:deb_ubuntu_jammy: - image: ubuntu:jammy - <<: *deb_ubuntu_build_new_def - variables: - DIST: jammy - only: - - web - except: - - branches - allow_failure: true - - -release:pypi: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y git python3-pip - - cp packaging/wheel/* . - - ./publish.sh - artifacts: - expire_in: 1 day - paths: - - dist/ - tags: - - docker_node - only: - - web - except: - - branches - allow_failure: true - -publish:pypi: - stage: publish - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y sssd-client sudo - - sudo -u stci -H mkdir -p /eos/project/s/storage-ci/www/xrootd/release/pypi-dist - - sudo -u stci -H cp dist/*.tar.gz /eos/project/s/storage-ci/www/xrootd/release/pypi-dist/. - tags: - - docker_node - only: - - web - except: - - branches - allow_failure: true - - -weekly:cs8: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cs8-base - script: - - dnf install -y epel-release - - dnf install --nogpg -y gcc-c++ rpm-build tar dnf-plugins-core git python-macros - - dnf config-manager --set-enabled powertools - - dnf install -y cppunit-devel - - dnf -y update libarchive - - xrootd_version=$(git for-each-ref --sort=taggerdate --format '%(refname)' refs/tags | grep '^refs/tags/v' | grep -v 'rc.*$' | grep -v 'osghotfix' | grep -v 'CERN$' | sed -e '$!d') - - xrootd_version=${xrootd_version:11} - - short_hash=$(git rev-parse --verify HEAD | awk '{print substr($0, 0, 8)}') - - a=( ${xrootd_version//./ } ) - - ((a[2]++)) || true - - experimental_version="${a[0]}.${a[1]}.${a[2]}-0.experimental."${CI_PIPELINE_ID}.$short_hash - - cd packaging/ - - ./makesrpm.sh --version $experimental_version --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" - - dnf builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_tests 1" --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir epel-8/ - - cp packaging/*.src.rpm epel-8 - - cp packaging/RPMS/* epel-8 - artifacts: - expire_in: 1 day - paths: - - epel-8/ - tags: - - docker_node - only: - - schedules - except: - - tags - -weekly:cc7: - stage: build:rpm - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - head -n -6 /etc/yum.repos.d/epel.repo > /tmp/epel.repo ; mv -f /tmp/epel.repo /etc/yum.repos.d/epel.repo - - yum install --nogpg -y gcc-c++ rpm-build git cppunit-devel python-srpm-macros centos-release-scl - - xrootd_version=$(git for-each-ref --sort=taggerdate --format '%(refname)' refs/tags | grep '^refs/tags/v5' | grep -v 'rc.*$' | grep -v 'osghotfix' | grep -v 'CERN$' | sed -e '$!d') - - xrootd_version=${xrootd_version:11} - - echo $xrootd_version - - short_hash=$(git rev-parse --verify HEAD | awk '{print substr($0, 0, 8)}') - - a=( ${xrootd_version//./ } ) - - ((a[2]++)) || true - - echo $CI_PIPELINE_ID - - experimental_version="${a[0]}.${a[1]}.${a[2]}-0.experimental."${CI_PIPELINE_ID}.$short_hash - - echo $experimental_version - - cd packaging/ - - ./makesrpm.sh --version $experimental_version --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" - - yum-builddep --nogpgcheck -y *.src.rpm - - mkdir RPMS - - rpmbuild --rebuild --define "_rpmdir RPMS/" --define "_with_tests 1" --define "_with_python3 1" --define "_with_xrdclhttp 1" --define "_with_scitokens 1" --define "_with_isal 1" --define "_build_name_fmt %%{NAME}-%%{VERSION}-%%{RELEASE}.%%{ARCH}.rpm" *.src.rpm - - cd .. - - mkdir epel-7/ - - cp packaging/*.src.rpm epel-7 - - cp packaging/RPMS/* epel-7 - artifacts: - expire_in: 1 day - paths: - - epel-7/ - tags: - - docker_node - only: - - schedules - - web - except: - - tags - -xrootd_docker_get: - stage: build:dockerimage:prepare - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y git - - git clone https://gitlab.cern.ch/eos/xrootd-docker.git - - if [ ! -d "epel-7" ]; then mkdir epel-7; cp cc-7/* epel-7; fi - artifacts: - expire_in: 1 day - paths: - - xrootd-docker/ - - epel-7/ - tags: - - docker_node - only: - - web - - schedules - except: - - tags - -xrootd_dockerimage: - stage: build:dockerimage - tags: - - docker-image-build - script: - - "" - variables: - TO: gitlab-registry.cern.ch/dss/xrootd - DOCKER_FILE: xrootd-docker/Dockerfile.ci - dependencies: - - xrootd_docker_get - only: - - schedules - - web - except: - - tags - -xrootd_docker_test: - stage: test - script: - - docker pull gitlab-registry.cern.ch/dss/xrootd - - cd xrootd-docker - - yum -y install wget - - sudo ./start.sh -i gitlab-registry.cern.ch/dss/xrootd - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/UtilsTest/" - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/SocketTest/" - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/PollerTest/" - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/PostMasterTest/" - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/FileSystemTest/" -## - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/FileTest/" - - docker exec metaman text-runner /usr/lib64/libXrdClTests.so "All Tests/LocalFileHandlerTest/" - - after_script: - - sudo ./xrootd-docker/clean.sh - tags: - - shell-with-docker - dependencies: - - xrootd_docker_get - only: - - schedules - - web - except: - - tags - allow_failure: true - -pyxrootd_dockerimage: - stage: build:dockerimage - tags: - - docker-image-build - script: - - "" - variables: - TO: gitlab-registry.cern.ch/dss/xrootd:pylatest - DOCKER_FILE: xrootd-docker/Dockerfile-python.ci - dependencies: - - xrootd_docker_get - only: - - schedules - - web - except: - - tags - allow_failure: true - -pyxrootd_docker_test: - stage: test - script: - - docker pull gitlab-registry.cern.ch/dss/xrootd:pylatest - - sudo docker run -dit --privileged -e "container=docker" --name pyxrootd-container -h pyxrootd-container gitlab-registry.cern.ch/dss/xrootd:pylatest /sbin/init - - docker exec pyxrootd-container systemctl start xrootd@standalone - - docker exec pyxrootd-container sh -c "cd xrootd/bindings/python/tests && pytest test_file.py test_filesystem.py test_copy.py test_threads.py test_url.py" - - after_script: - - sudo docker rm -f pyxrootd-container - - sudo docker rmi -f gitlab-registry.cern.ch/dss/xrootd:pylatest - - tags: - - shell-with-docker - dependencies: - - xrootd_docker_get - only: - - schedules - - web - except: - - tags - allow_failure: true - -publish:rhel: - stage: publish - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y sssd-client sudo createrepo - - prefix=/eos/project/s/storage-ci/www/xrootd - - "for platform in cs-8 cc-7 fc-35 fc-34; do - repo=$prefix/${CI_COMMIT_REF_NAME}/$platform/x86_64 - path=$repo/$(date +'%Y%m%d'); - sudo -u stci -H mkdir -p $path; - sudo -u stci -H find ${path} -type f -name '*.rpm' -delete; - sudo -u stci -H cp $platform/* $path; - sudo -u stci -H createrepo --update -q $path; - sudo -u stci -H createrepo --update -q $repo; - done" - tags: - - docker_node - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -publish:debian: - stage: publish - image: ubuntu:bionic - script: - - apt-get update - - apt-get install -y sudo apt-utils sssd gpg - - mkdir /home/stci - - chown -R stci:def-cg /home/stci - - chmod -R 700 /home/stci - - sudo -u stci -H gpg --homedir /home/stci/ --allow-secret-key-import --import /keys/stci-debian-repo.sec - - sudo -u stci -H ./packaging/debian_scripts/publish_debian_cern.sh ${CI_COMMIT_REF_NAME} - tags: - - docker_node - dependencies: - - build:deb_ubuntu_bionic - - build:deb_ubuntu_focal - - build:deb_ubuntu_jammy - only: - - master - - /^stable-.*$/ - except: - - tags - - schedules - - web - -publish:rhel:release: - stage: publish - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y sssd-client sudo createrepo - - prefix=/eos/project/s/storage-ci/www/xrootd - - tarball=cc-7-x86_64/xrootd-*.tar.gz - - "for platform in rocky-8-x86_64 cs-8-x86_64 cc-7-x86_64; do - path=$prefix/release/$platform/$CI_COMMIT_TAG/; - sudo -u stci -H mkdir -p $path/{source,tarball}; - sudo -u stci -H cp $platform/*.rpm $path; - sudo -u stci -H find ${path} -type f -name '*.src.rpm' -delete; - sudo -u stci -H cp $platform/*.src.rpm $path/source; - sudo -u stci -H cp $tarball $path/tarball; - sudo -u stci -H createrepo --update -q $path; - sudo -u stci -H createrepo --update -q $prefix/release/$platform; - done" - tags: - - docker_node - only: - - web - except: - - branches - -publish:debian:release: - stage: publish - image: ubuntu:bionic - script: - - apt-get update - - apt-get install -y sudo apt-utils sssd gpg - - mkdir /home/stci - - chown -R stci:def-cg /home/stci - - chmod -R 700 /home/stci - - sudo -u stci -H gpg --homedir /home/stci/ --allow-secret-key-import --import /keys/stci-debian-repo.sec - - repo=release - - if [[ $CI_COMMIT_TAG == *rc* ]] ; then repo=testing ; fi - - sudo -u stci -H ./packaging/debian_scripts/publish_debian_cern.sh $repo - tags: - - docker_node - dependencies: - - release:deb_ubuntu_bionic - - release:deb_ubuntu_focal - - release:deb_ubuntu_jammy - only: - - web - except: - - branches - -publish:weekly: - stage: publish - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y sssd-client sudo createrepo - - prefix=/eos/project/s/storage-ci/www/xrootd - - "for platform in epel-8 epel-7 epel-6; do - if [ -d $platform ] ; then - path=$prefix/experimental/$platform/x86_64/; - sudo -u stci -H mkdir -p $path; - ls -latr $platform/; - echo $path; - sudo -u stci -H cp $platform/* $path; - sudo -u stci -H createrepo --update -q $path; - fi; - done" - tags: - - docker_node - dependencies: - - weekly:cc7 - - weekly:cs8 - only: - - schedules - - web - except: - - tags - -publish:koji:cs8: - stage: post:publish - image: gitlab-registry.cern.ch/linuxsupport/rpmci/kojicli - script: - - yum install --nogpg -y sssd-client - - kinit stci@CERN.CH -k -t /stci.krb5/stci.keytab - - path=/eos/project/s/storage-ci/www/xrootd/release/cs-8-x86_64/$CI_COMMIT_TAG/source/ - - if [[ $CI_COMMIT_TAG != *rc* ]] ; then koji build eos8 $path/*.src.rpm ; else stat $path/*.src.rpm ; fi - tags: - - docker_node - only: - - web - except: - - branches - when: manual - -publish:koji:cc7: - stage: post:publish - image: gitlab-registry.cern.ch/linuxsupport/rpmci/kojicli - script: - - yum install --nogpg -y sssd-client - - kinit stci@CERN.CH -k -t /stci.krb5/stci.keytab - - path=/eos/project/s/storage-ci/www/xrootd/release/cc-7-x86_64/$CI_COMMIT_TAG/source/ - - if [[ $CI_COMMIT_TAG != *rc* ]] ; then koji build eos7 $path/*.src.rpm ; else stat $path/*.src.rpm ; fi - tags: - - docker_node - only: - - web - except: - - branches - when: manual - -clean:artifacts: - stage: clean - image: gitlab-registry.cern.ch/linuxsupport/cc7-base - script: - - yum install --nogpg -y sssd-client sudo createrepo - - sudo -u stci -H bash -c 'for commit_dir in /eos/project/s/storage-ci/www/xrootd/master/*/*/; do find ${commit_dir} -mindepth 1 -maxdepth 1 -type d -ctime +10 | xargs rm -rf; createrepo --update -q ${commit_dir}; done' - - sudo -u stci -H bash -c 'for commit_dir in /eos/project/s/storage-ci/www/xrootd/stable-*/*/*/; do find ${commit_dir} -type f -name '"'"'*.rpm'"'"' -mtime +30 -delete; createrepo --update -q ${commit_dir}; done' - - sudo -u stci -H bash -c 'for commit_dir in /eos/project/s/storage-ci/www/xrootd/experimental/*/x86_64/; do find ${commit_dir} -type f -name '"'"'*.rpm'"'"' -mtime +30 -delete; createrepo --update -q ${commit_dir}; done' - tags: - - docker_node - allow_failure: true - only: - - schedules - - web - except: - - tags +Fedora 38: + image: fedora:38 + <<: *rpm_build_dnf +Fedora 39: + image: fedora:39 + <<: *rpm_build_dnf diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 6a3084b7891..00000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "src/XrdCeph"] - path = src/XrdCeph - url = https://github.com/xrootd/xrootd-ceph diff --git a/.mailmap b/.mailmap new file mode 100644 index 00000000000..aa20ef11ac5 --- /dev/null +++ b/.mailmap @@ -0,0 +1,79 @@ +Alja Mrak-Tadel Alja MRak-Tadel +Alja Mrak-Tadel alja +Alja Mrak-Tadel alja +Alja Mrak-Tadel alja +Andreas Joachim Peters Andreas Peters +Andreas Joachim Peters Andreas Peters +Andreas Joachim Peters Andreas-Joachim Peters +Andrew Hanushevsky +Artem Harutyunyan +Brian Bockelman Brian P Bockelman +Brian Bockelman Brian P Bockelman +Cedric Caffy ccaffy <85744538+ccaffy@users.noreply.github.com> +Chris Burr Chris Burr +Chris Green +David Smith +David Smith David Smith +Ed J +Edgar Fajardo efajardo +Edgar Fajardo efajardo +Elvin Sindrilaru +Fabrizio Furano Fabrizio Furano +Fabrizio Furano Fabrizio Furano +Fabrizio Furano Fabrizio Furano +Fabrizio Furano Fabrizio Furano +Fabrizio Furano ffurano +Fabrizio Furano furano +Frank Winklmeier fwinkl <> +Fritz Mueller Fritz Mueller +Gerardo Ganis Gerardo GANIS +Gerardo Ganis Gerri Ganis +Gerardo Ganis Gerri Ganis +Gerardo Ganis Gerri Ganis +Gerardo Ganis ganis +Gerardo Ganis ganis +Gerardo Ganis gganis +Jacek Becla +James Walder snafus +Jan Iven +Jozsef Makai +Jozsef Makai Jozsef Makai +Jyothish Thomas Jo-stfc <71326101+Jo-stfc@users.noreply.github.com> +Jyothish Thomas root +Kian-Tat Lim ktlim +Lukasz Janyst Lukasz Janyst +Lukasz Janyst Lukasz Janyst +Lukasz Janyst Lukasz Janyst +Lukasz Janyst Lukasz Janyst +Matevž Tadel Matevz Tadel +Matevž Tadel Matevž Tadel +Michal Simon Michal Simon +Michal Simon Michal Simon +Michal Simon simonmichal +Nikola Hardi +Nikola Hardi +Paul-Niklas Kramp Paul Kramp +Paul-Niklas Kramp niklas +Paul-Niklas Kramp pkramp +Remigius Mommsen mommsen <> +Sebastien Ponce +Thorsten Kollegger TKollegger +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang +Wei Yang Wei Yang + +Unknown bbrqa <> +Unknown otron +Unknown root +Unknown root +Unknown root +Unknown root +Unknown xrootd +Unknown root diff --git a/CMakeLists.txt b/CMakeLists.txt index f338a68e126..c771264ff36 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ #------------------------------------------------------------------------------- # Project description #------------------------------------------------------------------------------- -cmake_minimum_required( VERSION 3.1 ) +cmake_minimum_required(VERSION 3.16...3.25) project( XRootD ) @@ -9,6 +9,8 @@ set( CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/src ${PROJECT_SOURCE_DIR}/cmake ) +include(XRootDVersion) + #------------------------------------------------------------------------------- # A 'plugins' phony target to simplify building build-tree binaries. # Plugins are responsible for adding themselves to this target, where @@ -30,57 +32,23 @@ add_definitions( -DXRDPLUGIN_SOVERSION="${PLUGIN_VERSION}" ) #------------------------------------------------------------------------------- # Generate the version header #------------------------------------------------------------------------------- -if (USER_VERSION) - set(XROOTD_VERSION "${USER_VERSION}") -else () -execute_process( - COMMAND ${CMAKE_SOURCE_DIR}/genversion.sh --print-only ${CMAKE_SOURCE_DIR} - OUTPUT_VARIABLE XROOTD_VERSION - OUTPUT_STRIP_TRAILING_WHITESPACE ) -endif() - -add_custom_target( - XrdVersion.hh - ${CMAKE_SOURCE_DIR}/genversion.sh --version ${XROOTD_VERSION} ${CMAKE_SOURCE_DIR}) - -# sigh, yet another ugly hack :( -macro( add_library _target ) - _add_library( ${_target} ${ARGN} ) - add_dependencies( ${_target} XrdVersion.hh ) -endmacro() - -macro( add_executable _target ) - _add_executable( ${_target} ${ARGN} ) - add_dependencies( ${_target} XrdVersion.hh ) -endmacro() -#------------------------------------------------------------------------------- -# Checkout the vomsxrd submodule -#------------------------------------------------------------------------------- -find_package(Git QUIET) -if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git") - option(GIT_SUBMODULES "Check submodules during build" ON) - if(GIT_SUBMODULES) - message(STATUS "Submodule update") - execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} - RESULT_VARIABLE GIT_SUBMOD_RESULT) - if(NOT GIT_SUBMOD_RESULT EQUAL "0") - message(FATAL_ERROR "git submodule update --init failed with ${GIT_SUBMOD_RESULT}, please checkout submodules") - endif() - endif() -endif() +configure_file(src/XrdVersion.hh.in src/XrdVersion.hh) #------------------------------------------------------------------------------- # Build in subdirectories #------------------------------------------------------------------------------- -add_subdirectory( src ) -add_subdirectory( bindings ) -if( BUILD_TESTS ) - ENABLE_TESTING() - add_subdirectory( tests ) -endif() +include_directories(BEFORE ${CMAKE_SOURCE_DIR}/src ${CMAKE_BINARY_DIR}/src) + +include(CTest) + +add_subdirectory(src) +add_subdirectory(bindings) +add_subdirectory(tests) + +add_subdirectory(docs) +add_subdirectory(utils) include( XRootDSummary ) @@ -89,11 +57,24 @@ include( XRootDSummary ) # Install XRootDConfig.cmake module #------------------------------------------------------------------------------- -configure_file( "cmake/XRootDConfig.cmake.in" "cmake/XRootDConfig.cmake" @ONLY ) +include(CMakePackageConfigHelpers) + +write_basic_package_version_file(cmake/${PROJECT_NAME}ConfigVersion.cmake + VERSION ${XRootD_VERSION} COMPATIBILITY SameMajorVersion) + +configure_package_config_file(cmake/${PROJECT_NAME}Config.cmake.in cmake/${PROJECT_NAME}Config.cmake + INSTALL_PREFIX + ${CMAKE_INSTALL_PREFIX} + INSTALL_DESTINATION + ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME} + PATH_VARS + CMAKE_INSTALL_INCLUDEDIR + CMAKE_INSTALL_LIBDIR + CMAKE_INSTALL_DATADIR +) -install( - FILES ${CMAKE_BINARY_DIR}/cmake/XRootDConfig.cmake - DESTINATION ${CMAKE_INSTALL_DATADIR}/xrootd/cmake ) +install(DIRECTORY ${PROJECT_BINARY_DIR}/cmake/ + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}) #------------------------------------------------------------------------------- # Configure an 'uninstall' target diff --git a/CTestConfig.cmake b/CTestConfig.cmake new file mode 100644 index 00000000000..f2ce8e263fe --- /dev/null +++ b/CTestConfig.cmake @@ -0,0 +1,4 @@ +set(CTEST_PROJECT_NAME "XRootD") +set(CTEST_NIGHTLY_START_TIME "00:00:00 UTC") +set(CTEST_DROP_SITE_CDASH TRUE) +set(CTEST_SUBMIT_URL https://my.cdash.org/submit.php?project=XRootD) diff --git a/Doxyfile b/Doxyfile index ccb72e4b074..a85babb7c04 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,213 +1,2797 @@ -# Doxyfile 1.3.7 +# Doxyfile 1.10.0 + +# 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 (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = xrootd -PROJECT_NUMBER = + +# 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 = XRootD + +# 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 = + +# 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 = docs/images/xrootd-icon.png + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = docs/images/xrootd-icon.png + +# 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 = doxydoc -CREATE_SUBDIRS = NO + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 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. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# 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, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, 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 -USE_WINDOWS_ENCODING = NO + +# 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 -ABBREVIATE_BRIEF = + +# 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 = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = src/ + +# 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 = NO + +# 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 -DETAILS_AT_TOP = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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 -DISTRIBUTE_GROUP_DOC = NO + +# 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 -ALIASES = + +# 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:^^" +# 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:". Note that you cannot 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 = + +# 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 = NO + +# 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++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = icc=C++ + +# 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 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = GITHUB + +# 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = 2 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 0 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + #--------------------------------------------------------------------------- # 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 = YES -EXTRACT_PRIVATE = YES + +# 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 = YES + +# 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 this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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 +# will also hide undocumented C++ concepts if enabled. 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 +# 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 + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + 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_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# 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 = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + SORT_MEMBER_DOCS = YES -SORT_BRIEF_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 = YES + +# 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 = YES + +# 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 -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 -ENABLED_SECTIONS = + +# 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. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + QUIET = NO + +# 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 = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = 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 parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# 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) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# 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). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = src/ -FILE_PATTERNS = *.hh +# 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 = README.md docs src + +# 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. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# 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. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.md, *.cc, *.icc, *.hh, *.py + +# 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 = YES -EXCLUDE = + +# 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 = src/XrdHttp/README-CKSUM.md \ + src/XrdOuc/XrdOucJson.hh \ + src/XrdSciTokens/vendor \ + src/XrdXml/tinyxml + +# 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 -EXCLUDE_PATTERNS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = + +# 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 = */test/* */tests/* + +# 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, +# ANamespace::AClass, ANamespace::*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 -IMAGE_PATH = -INPUT_FILTER = + +# 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 doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# 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 + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO + +# 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, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = YES + +# 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 = YES + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# 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 -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = + +# 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. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + HTML_OUTPUT = html + +# 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 -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES + +# 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 = + +# 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 = + +# 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 = + +# 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). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. 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 tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# 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 color-wheel, 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 = 210 + +# 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 gray-scales 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_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 = YES + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# 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 determines the URL 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. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# 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 +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# 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 -CHM_FILE = -HHC_LOCATION = + +# 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 main .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 + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# 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 (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + DISABLE_INDEX = NO -ENUM_VALUES_PER_LINE = 4 -GENERATE_TREEVIEW = NO -TREEVIEW_WIDTH = 250 + +# 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 (see "Fine-tuning the output"). 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 = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = YES + +# 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 = 1 + +# 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 = 300 + +# 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 + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# 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 + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) 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: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# 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/v2.7-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 +# , /