diff options
| author | Peter Pentchev <roam@debian.org> | 2021-12-27 22:39:51 +0200 |
|---|---|---|
| committer | Peter Pentchev <roam@debian.org> | 2021-12-27 22:39:51 +0200 |
| commit | 6b4388a0009a8e90d20004bb13fc28ddc4616924 (patch) | |
| tree | 82edb80ea6cce063526928025b7119bdfb017fc5 | |
| parent | 82d725e23f474ec7bb76e5d242d75b4b53b7159a (diff) | |
| parent | 8eff6ed99f5fd0ba844cb8513963435caab5fd3c (diff) | |
Merge createrepo-c-0.17.2 into the Debian branch.
33 files changed, 2020 insertions, 2274 deletions
diff --git a/.github/workflows/ci-python.yml b/.github/workflows/ci-python.yml new file mode 100644 index 0000000..b3b39a1 --- /dev/null +++ b/.github/workflows/ci-python.yml @@ -0,0 +1,24 @@ +--- +name: Python CI +on: pull_request + +jobs: + python-build: + name: Python Build + runs-on: ubuntu-latest + container: fedora:latest + steps: + - uses: actions/checkout@v2 + + - name: Install dependencies + run: | + sudo dnf -y install dnf-plugins-core + sudo dnf -y builddep createrepo_c.spec + pip install --upgrade pip + pip install pytest + + - name: Compile and Install + run: pip install . + + - name: Test + run: pytest --verbose --color=yes tests/python/tests/ diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..57dd2ac --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,57 @@ +--- +name: DNF CI +on: pull_request_target + +jobs: + copr-build: + name: Copr Build + runs-on: ubuntu-latest + container: + image: ghcr.io/rpm-software-management/dnf-ci-host + outputs: + package-urls: ${{steps.copr-build.outputs.package-urls}} + steps: + - name: Check out ci-dnf-stack + uses: actions/checkout@v2 + with: + repository: rpm-software-management/ci-dnf-stack + + - name: Setup CI + id: setup-ci + uses: ./.github/actions/setup-ci + with: + copr-user: ${{secrets.COPR_USER}} + copr-api-token: ${{secrets.COPR_API_TOKEN}} + + - name: Check out sources + uses: actions/checkout@v2 + with: + path: gits/${{github.event.repository.name}} + ref: ${{github.event.pull_request.head.sha}} # check out the PR HEAD + fetch-depth: 0 + + - name: Run Copr Build + id: copr-build + uses: ./.github/actions/copr-build + with: + copr-user: ${{steps.setup-ci.outputs.copr-user}} + overlay: createrepo_c-ci + + integration-tests: + name: Integration Tests + needs: copr-build + runs-on: ubuntu-latest + container: + image: ghcr.io/rpm-software-management/dnf-ci-host + options: --privileged + steps: + - name: Check out ci-dnf-stack + uses: actions/checkout@v2 + with: + repository: rpm-software-management/ci-dnf-stack + + - name: Run Integration Tests + uses: ./.github/actions/integration-tests + with: + suite: createrepo_c + package-urls: ${{needs.copr-build.outputs.package-urls}} diff --git a/.github/workflows/release-python.yml b/.github/workflows/release-python.yml new file mode 100644 index 0000000..1cea6c3 --- /dev/null +++ b/.github/workflows/release-python.yml @@ -0,0 +1,36 @@ +--- +name: Python Release + +on: + release: + types: [created] + +jobs: + release: + name: PyPI Release + runs-on: ubuntu-latest + container: fedora:latest + steps: + - uses: actions/checkout@v2 + + - name: Install dependencies + run: | + sudo dnf -y install dnf-plugins-core + sudo dnf -y builddep createrepo_c.spec + pip install --upgrade pip + pip install twine pytest scikit-build + + - name: Build Python sdist + run: python3 setup.py sdist + + - name: Install and Test Python source package + run: | + pip install dist/*.tar.gz + pytest --verbose --color=yes tests/python/tests/ + + - name: Publish packages to PyPI + env: + TWINE_USERNAME: __TOKEN__ + TWINE_PASSWORD: ${{secrets.PYPI_API_TOKEN}} + run: | + twine upload dist/*.tar.gz diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..007c512 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,11 @@ +graft src* +graft doc* +graft test* +include VERSION.cmake +include CMakeLists.txt +include pyproject.toml +include setup.py +include requirements-dev.txt +include AUTHORS +include COPYING +include README.md @@ -132,7 +132,7 @@ Modify createrepo_c.spec and run: utils/make_rpm.sh -Note: [Current .spec for Fedora rawhide](http://pkgs.fedoraproject.org/cgit/createrepo_c.git/plain/createrepo_c.spec) +Note: [Current .spec for Fedora rawhide](https://src.fedoraproject.org/rpms/createrepo_c/blob/master/f/createrepo_c.spec) ## Testing @@ -146,7 +146,7 @@ Note: For a verbose output of testing use: ``make ARGS="-V" test`` ### Run only C unittests (from your checkout dir): - build/tests/run_gtester.sh + build/tests/run_tests.sh Note: The C tests have to be built by ``make tests``)! diff --git a/VERSION.cmake b/VERSION.cmake index ab50643..0c790cd 100644 --- a/VERSION.cmake +++ b/VERSION.cmake @@ -1,3 +1,3 @@ SET(CR_MAJOR "0") SET(CR_MINOR "17") -SET(CR_PATCH "1") +SET(CR_PATCH "2") diff --git a/acceptance_tests/run_nosetests.sh b/acceptance_tests/run_nosetests.sh deleted file mode 100755 index 9ed7002..0000000 --- a/acceptance_tests/run_nosetests.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -CURDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -BUILDDIR="$( cd "$CURDIR/../build" && pwd )" - -# All use cases -PATH="$BUILDDIR/src/:/home/tmlcoch/git/yum-metadata-diff/:$PATH" LD_LIBRARY_PATH=$BUILDDIR/src/ PYTHONPATH=$BUILDDIR/src/python/ nosetests -s -v ./tests/ --processes 4 --process-timeout=300 - -# Single module: -#PATH="$BUILDDIR/src/:/home/tmlcoch/git/repodiff/:$PATH" LD_LIBRARY_PATH=$BUILDDIR/src/ PYTHONPATH=$BUILDDIR/src/python/ nosetests -s -v --processes 4 --process-timeout=300 tests/test_sqliterepo.py - -# Single test: -# PATH="$BUILDDIR/src/:/home/tmlcoch/git/repodiff/:$PATH" LD_LIBRARY_PATH=$BUILDDIR/src/ PYTHONPATH=$BUILDDIR/src/python/ nosetests -s -v --processes 4 --process-timeout=300 tests/test_createrepo.py:TestCaseCreaterepo_emptyrepo.test_01_createrepo diff --git a/acceptance_tests/testdata/packages/Archer-3.4.5-6.x86_64.rpm b/acceptance_tests/testdata/packages/Archer-3.4.5-6.x86_64.rpm Binary files differdeleted file mode 100644 index 6067c88..0000000 --- a/acceptance_tests/testdata/packages/Archer-3.4.5-6.x86_64.rpm +++ /dev/null diff --git a/acceptance_tests/testdata/packages/fake_bash-1.1.1-1.x86_64.rpm b/acceptance_tests/testdata/packages/fake_bash-1.1.1-1.x86_64.rpm Binary files differdeleted file mode 100644 index ddab045..0000000 --- a/acceptance_tests/testdata/packages/fake_bash-1.1.1-1.x86_64.rpm +++ /dev/null diff --git a/acceptance_tests/testdata/packages/super_kernel-6.0.1-2.x86_64.rpm b/acceptance_tests/testdata/packages/super_kernel-6.0.1-2.x86_64.rpm Binary files differdeleted file mode 100644 index b606e16..0000000 --- a/acceptance_tests/testdata/packages/super_kernel-6.0.1-2.x86_64.rpm +++ /dev/null diff --git a/acceptance_tests/tests/__init__.py b/acceptance_tests/tests/__init__.py deleted file mode 100644 index e69de29..0000000 --- a/acceptance_tests/tests/__init__.py +++ /dev/null diff --git a/acceptance_tests/tests/base.py b/acceptance_tests/tests/base.py deleted file mode 100644 index 4e534cf..0000000 --- a/acceptance_tests/tests/base.py +++ /dev/null @@ -1,389 +0,0 @@ -import os -import re -import time -import shutil -import pprint -import gzip -import filecmp -import os.path -import tempfile -import unittest -import threading -import subprocess - -from .fixtures import PACKAGESDIR - -OUTPUTDIR = None -OUTPUTDIR_LOCK = threading.Lock() - -def get_outputdir(): - global OUTPUTDIR - if OUTPUTDIR: - return OUTPUTDIR - OUTPUTDIR_LOCK.acquire() - if not OUTPUTDIR: - prefix = time.strftime("./testresults_%Y%m%d_%H%M%S_") - OUTPUTDIR = tempfile.mkdtemp(prefix=prefix, dir="./") - OUTPUTDIR_LOCK.release() - return OUTPUTDIR - - -class _Result(object): - def __str__(self): - return pprint.pformat(self.__dict__) - - -class CrResult(_Result): - def __init__(self): - self.rc = None # Return code - self.out = None # stdout + stderr - self.dir = None # Directory that was processed - self.prog = None # Program name - self.cmd = None # Complete command - self.outdir = None # Output directory - self.logfile = None # Log file where the out was logged - - -class RepoDiffResult(_Result): - def __init__(self): - self.rc = None - self.out = None - self.repo1 = None - self.repo2 = None - self.cmd = None # Complete command - self.logfile = None # Log file where the out was logged - - -class RepoSanityCheckResult(_Result): - def __init__(self): - self.rc = None - self.out = None - self.repo = None - self.cmd = None - self.logfile = None - - -class BaseTestCase(unittest.TestCase): - - def __init__(self, *args, **kwargs): - self.outdir = get_outputdir() - self.tcdir = os.path.join(self.outdir, self.__class__.__name__) - if not os.path.exists(self.tcdir): - os.mkdir(self.tcdir) - if self.__class__.__doc__: - description_fn = os.path.join(self.tcdir, "description") - open(description_fn, "w").write(self.__class__.__doc__+'\n') - unittest.TestCase.__init__(self, *args, **kwargs) - - self.tdir = None # Test dir for the current test - self.indir = None # Input dir for the current test - self._currentResult = None # Result of the current test - - # Prevent use of a first line from test docstring as its name in output - self.shortDescription_orig = self.shortDescription - self.shortDescription = self._shortDescription - self.main_cwd = os.getcwd() - - def _shortDescription(self): - return ".".join(self.id().split('.')[-2:]) - - def run(self, result=None): - # Hacky - self._currentResult = result # remember result for use in tearDown - unittest.TestCase.run(self, result) - - def setUp(self): - os.chdir(self.main_cwd) # In case of TimedOutException in Nose test... the tearDown is not called :-/ - caller = self.id().split(".", 3)[-1] - self.tdir = os.path.abspath(os.path.join(self.tcdir, caller)) - os.mkdir(self.tdir) - self.indir = os.path.join(self.tdir, "input") - os.mkdir(self.indir) - description = self.shortDescription_orig() - if description: - fn = os.path.join(self.tdir, "description") - open(fn, "w").write(description+'\n') - #self.log = # TODO - os.chdir(self.tdir) - self.setup() - - def setup(self): - pass - - def tearDown(self): - if self.tdir and self._currentResult: - if not len(self._currentResult.errors) + len(self._currentResult.failures): - self.set_success() - self.teardown() - os.chdir(self.main_cwd) - - def teardown(self): - pass - - def runcmd(self, cmd, logfile=None, workdir=None, stdin_data=None): - """Stolen from the kobo library. - Author of the original function is dmach@redhat.com""" - - # TODO: Add time how long the command takes - - if type(cmd) in (list, tuple): - import pipes - cmd = " ".join(pipes.quote(i) for i in cmd) - - if logfile is not None: - already_exists = False - if os.path.exists(logfile): - already_exists = True - logfile = open(logfile, "a") - if already_exists: - logfile.write("\n{0}\n Another run\n{0}\n".format('='*79)) - logfile.write("cd %s\n" % os.getcwd()) - for var in ("PATH", "PYTHONPATH", "LD_LIBRARY_PATH"): - logfile.write('export %s="%s"\n' % (var, os.environ.get(var,""))) - logfile.write("\n") - logfile.write(cmd+"\n") - logfile.write("\n+%s+\n\n" % ('-'*77)) - - stdin = None - if stdin_data is not None: - stdin = subprocess.PIPE - - proc = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, - stderr=subprocess.STDOUT, cwd=workdir) - - if stdin_data is not None: - class StdinThread(threading.Thread): - def run(self): - proc.stdin.write(stdin_data) - proc.stdin.close() - stdin_thread = StdinThread() - stdin_thread.daemon = True - stdin_thread.start() - - output = "" - while True: - lines = proc.stdout.readline().decode('utf-8') - if lines == "": - break - if logfile: - logfile.write(lines) - output += lines - proc.wait() - - if logfile: - logfile.write("\n+%s+\n\n" % ('-'*77)) - logfile.write("RC: %s (%s)\n" % (proc.returncode, "Success" if not proc.returncode else "Failure")) - logfile.close() - - if stdin_data is not None: - stdin_thread.join() - - return proc.returncode, output - - def set_success(self): - """Create a SUCCESS file in directory of the current test""" - fn = os.path.join(self.tdir, "SUCCESS") - open(fn, "w") - - def copy_pkg(self, name, dst): - """Copy package from testdata into specified destination""" - src = os.path.join(PACKAGESDIR, name) - shutil.copy(src, dst) - return os.path.join(dst, name) - - def indir_addpkg(self, name): - """Add package into input dir for the current test""" - src = os.path.join(PACKAGESDIR, name) - return self.copy_pkg(src, self.indir) - - def indir_makedirs(self, path): - """Make a directory in input dir of the current test""" - path = path.lstrip('/') - final_path = os.path.join(self.indir, path) - os.makedirs(final_path) - return final_path - - def indir_mkfile(self, name, content=""): - """Create a file in input dir of the current test""" - fn = os.path.join(self.indir, name) - with open(fn, "w") as f: - f.write(content) - return fn - - def tdir_makedirs(self, path): - """Make a directory in test dir of the current test""" - path = path.lstrip('/') - final_path = os.path.join(self.tdir, path) - os.makedirs(final_path) - return final_path - - def run_prog(self, prog, dir, args=None, outdir=None): - res = CrResult() - res.dir = dir - res.prog = prog - res.outdir = outdir - res.logfile = os.path.join(self.tdir, "out_%s" % res.prog) - res.cmd = "%(prog)s --verbose %(args)s %(dir)s" % { - "prog": res.prog, - "dir": res.dir, - "args": args or "", - } - res.rc, res.out = self.runcmd(res.cmd, logfile=res.logfile) - return res - - def run_cr(self, dir, args=None, c=False, outdir=None): - """Run createrepo and return CrResult object with results - - :returns: Result of the createrepo run - :rtype: CrResult - """ - prog = "createrepo_c" if c else "createrepo" - - if not outdir: - outdir = os.path.join(self.tdir, prog) - else: - outdir = os.path.join(self.tdir, outdir) - if not os.path.exists(outdir): - os.mkdir(outdir) - - args = " -o %s %s" % (outdir, args if args else "") - - res = self.run_prog(prog, dir, args, outdir) - return res - - def run_sqlr(self, dir, args=None): - """""" - res = self.run_prog("sqliterepo_c", dir, args) - return res - - def compare_repos(self, repo1, repo2): - """Compare two repos - - :returns: Difference between two repositories - :rtype: RepoDiffResult - """ - res = RepoDiffResult() - res.repo1 = os.path.join(repo1, "repodata") - res.repo2 = os.path.join(repo2, "repodata") - res.logfile = os.path.join(self.tdir, "out_cmp") - res.cmd = "yum-metadata-diff --verbose --compare %s %s" % (res.repo1, res.repo2) - res.rc, res.out = self.runcmd(res.cmd, logfile=res.logfile) - return res - - def check_repo_sanity(self, repo): - """Check if a repository is sane - - :returns: Result of the sanity check - :rtype: RepoSanityCheckResult - """ - res = RepoSanityCheckResult() - res.repo = os.path.join(repo, "repodata") - res.logfile = os.path.join(self.tdir, "out_sanity") - res.cmd = "yum-metadata-diff --verbose --check %s" % res.repo - res.rc, res.out = self.runcmd(res.cmd, logfile=res.logfile) - return res - - def assert_run_cr(self, *args, **kwargs): - """Run createrepo and assert that it finished with return code 0 - - :returns: Result of the createrepo run - :rtype: CrResult - """ - res = self.run_cr(*args, **kwargs) - self.assertFalse(res.rc) - return res - - def assert_run_sqlr(self, *args, **kwargs): - """Run sqliterepo and assert that it finished with return code 0 - - :returns: Result of the sqliterepo run - :rtype: CrResult - """ - res = self.run_sqlr(*args, **kwargs) - self.assertFalse(res.rc) - return res - - def assert_same_results(self, indir, args=None): - """Run both createrepo and createrepo_c and assert that results are same - - :returns: (result of comparison, createrepo result, createrepo_c result) - :rtype: (RepoDiffResult, CrResult, CrResult) - """ - crres = self.run_cr(indir, args) - crcres = self.run_cr(indir, args, c=True) - self.assertFalse(crres.rc) # Error while running createrepo - self.assertFalse(crcres.rc) # Error while running createrepo_c - cmpres = self.compare_repos(crres.outdir, crcres.outdir) - self.assertFalse(cmpres.rc) # Repos are not same - return (cmpres, crres, crcres) - - def assert_repo_sanity(self, repo): - """Run repo sanity check and assert it's sane - - :returns: Result of the sanity check - :rtype: RepoSanityCheckResult - """ - res = self.check_repo_sanity(repo) - self.assertFalse(res.rc) - return res - - def assert_repo_files(self, repo, file_patterns, additional_files_allowed=True): - """Assert that files (defined by re) are in the repo - """ - compiled_patterns = map(re.compile, file_patterns) - fns = os.listdir(os.path.join(repo, "repodata/")) - used_patterns = [] - for pattern in compiled_patterns: - for fn in fns[:]: - if pattern.match(fn): - fns.remove(fn) - used_patterns.append(pattern) - - if not additional_files_allowed: - self.assertEqual(fns, []) # Unexpected additional files - - unused_paterns = [x.pattern for x in (set(compiled_patterns) - set(used_patterns))] - self.assertEqual(unused_paterns, []) # Some patterns weren't used - - def assert_same_dir_content(self, a, b): - """Assert identical content of two directories - (Not recursive yet) - """ - # TODO: Recursive - self.assertTrue(os.path.isdir(a)) - self.assertTrue(os.path.isdir(b)) - - _, logfn = tempfile.mkstemp(prefix="out_dircmp_%s_" % long(time.time()), dir=self.tdir) - logfile = open(logfn, "w") - logfile.write("A: %s\n" % a) - logfile.write("B: %s\n" % b) - logfile.write("\n") - - dircmpobj = filecmp.dircmp(a, b) - if dircmpobj.left_only or dircmpobj.right_only or dircmpobj.diff_files: - logfile.write("A only:\n%s\n\n" % dircmpobj.left_only) - logfile.write("B only:\n%s\n\n" % dircmpobj.right_only) - logfile.write("Diff files:\n%s\n\n" % dircmpobj.diff_files) - logfile.close() - self.assertTrue(False) - logfile.write("OK\n") - logfile.close() - - def assert_file_contains_line(self, path_to_file, line): - contents = "" - found = False - - if path_to_file.endswith(".gz"): - with gzip.open(path_to_file, 'rb') as f: - for l in f.readlines(): - if (l.strip() == line.strip()): - found = True - self.assertTrue(found, "Line: " + line + " not found in file: " + path_to_file) - return - - with open(path_to_file) as f: - for l in f.readlines(): - if (l.strip() == line.strip()): - found = True - - self.assertTrue(found, "Line: " + line + " not found in file: " + path_to_file) diff --git a/acceptance_tests/tests/fixtures.py b/acceptance_tests/tests/fixtures.py deleted file mode 100644 index c114bcc..0000000 --- a/acceptance_tests/tests/fixtures.py +++ /dev/null @@ -1,10 +0,0 @@ -import os.path - -TESTDATADIR = os.path.normpath(os.path.join(__file__, "../../testdata")) -PACKAGESDIR=os.path.join(TESTDATADIR, "packages") - -PACKAGES = [ - "Archer-3.4.5-6.x86_64.rpm", - "fake_bash-1.1.1-1.x86_64.rpm", - "super_kernel-6.0.1-2.x86_64.rpm", -]
\ No newline at end of file diff --git a/acceptance_tests/tests/test_createrepo.py b/acceptance_tests/tests/test_createrepo.py deleted file mode 100644 index f03d0b2..0000000 --- a/acceptance_tests/tests/test_createrepo.py +++ /dev/null @@ -1,347 +0,0 @@ -import os -import os.path -import glob - -from .fixtures import PACKAGES -from .base import BaseTestCase - - -class TestCaseCreaterepo_badparams(BaseTestCase): - """Use case with bad commandline arguments""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - - def test_01_createrepo_noinputdir(self): - """No directory to index was specified""" - res = self.run_cr("", c=True) - self.assertTrue(res.rc) - - def test_02_createrepo_badinputdir(self): - """Directory specified to index doesn't exist""" - res = self.run_cr("somenonexistingdirectorytoindex/", c=True) - self.assertTrue(res.rc) - - def test_03_createrepo_unknownparam(self): - """Unknown param is specified""" - res = self.run_cr(self.indir, "--someunknownparam", c=True) - self.assertTrue(res.rc) - - def test_04_createrepo_badchecksumtype(self): - """Unknown checksum type is specified""" - res = self.run_cr(self.indir, "--checksum foobarunknownchecksum", c=True) - self.assertTrue(res.rc) - - def test_05_createrepo_badcompressiontype(self): - """Unknown compressin type is specified""" - res = self.run_cr(self.indir, "--compress-type foobarunknowncompression", c=True) - self.assertTrue(res.rc) - - def test_06_createrepo_badgroupfile(self): - """Bad groupfile file specified""" - res = self.run_cr(self.indir, "--groupfile badgroupfile", c=True) - self.assertTrue(res.rc) - - def test_07_createrepo_badpkglist(self): - """Bad pkglist file specified""" - res = self.run_cr(self.indir, "--pkglist badpkglist", c=True) - self.assertTrue(res.rc) - - def test_08_createrepo_retainoldmdbyagetogetherwithretainoldmd(self): - """Both --retain-old-md-by-age and --retain-old-md are specified""" - res = self.run_cr(self.indir, "--retain-old-md-by-age 1 --retain-old-md", c=True) - self.assertTrue(res.rc) - - def test_09_createrepo_retainoldmdbyagewithbadage(self): - """Both --retain-old-md-by-age and --retain-old-md are specified""" - res = self.run_cr(self.indir, "--retain-old-md-by-age 55Z", c=True) - self.assertTrue(res.rc) - - -class TestCaseCreaterepo_emptyrepo(BaseTestCase): - """Empty input repository""" - - def setup(self): - self.fn_comps = self.indir_mkfile("comps.xml", '<?xml version="1.0"?><comps/>') - - def test_01_createrepo(self): - """Repo from empty directory""" - res = self.assert_run_cr(self.indir, c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{64}-primary.xml.gz$", - "[a-z0-9]{64}-filelists.xml.gz$", - "[a-z0-9]{64}-other.xml.gz$", - "[a-z0-9]{64}-primary.sqlite.bz2$", - "[a-z0-9]{64}-filelists.sqlite.bz2$", - "[a-z0-9]{64}-other.sqlite.bz2$", - ], - additional_files_allowed=False) - - def test_02_createrepo_database(self): - """--database""" - res = self.assert_run_cr(self.indir, "--database", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.gz$", - "[a-z0-9]+-filelists.xml.gz$", - "[a-z0-9]+-other.xml.gz$", - "[a-z0-9]+-primary.sqlite.bz2$", - "[a-z0-9]+-filelists.sqlite.bz2$", - "[a-z0-9]+-other.sqlite.bz2$", - ], - additional_files_allowed=False) - - def test_03_createrepo_nodatabase(self): - """--database""" - res = self.assert_run_cr(self.indir, "--no-database", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.gz$", - "[a-z0-9]+-filelists.xml.gz$", - "[a-z0-9]+-other.xml.gz$", - ], - additional_files_allowed=False) - - def test_04_createrepo_groupfile(self): - """--groupfile""" - res = self.assert_run_cr(self.indir, "--groupfile %s" % self.fn_comps, c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.gz$", - "[a-z0-9]+-filelists.xml.gz$", - "[a-z0-9]+-other.xml.gz$", - "[a-z0-9]+-primary.sqlite.bz2$", - "[a-z0-9]+-filelists.sqlite.bz2$", - "[a-z0-9]+-other.sqlite.bz2$", - "[a-z0-9]+-comps.xml$", - "[a-z0-9]+-comps.xml.gz$", - ], - additional_files_allowed=False) - - def test_05_createrepo_checksum(self): - """--checksum sha and --groupfile""" - res = self.assert_run_cr(self.indir, - "--checksum %(checksum)s --groupfile %(groupfile)s" % { - 'checksum': "sha1", - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{40}-primary.xml.gz$", - "[a-z0-9]{40}-filelists.xml.gz$", - "[a-z0-9]{40}-other.xml.gz$", - "[a-z0-9]{40}-primary.sqlite.bz2$", - "[a-z0-9]{40}-filelists.sqlite.bz2$", - "[a-z0-9]{40}-other.sqlite.bz2$", - "[a-z0-9]{40}-comps.xml$", - "[a-z0-9]{40}-comps.xml.gz$", - ], - additional_files_allowed=False) - - def test_06_createrepo_simplemdfilenames(self): - """--simple-md-filenames and --groupfile""" - res = self.assert_run_cr(self.indir, - "--simple-md-filenames --groupfile %(groupfile)s" % { - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "primary.xml.gz$", - "filelists.xml.gz$", - "other.xml.gz$", - "primary.sqlite.bz2$", - "filelists.sqlite.bz2$", - "other.sqlite.bz2$", - "comps.xml$", - "comps.xml.gz$", - ], - additional_files_allowed=False) - - def test_07_createrepo_xz(self): - """--xz and --groupfile""" - res = self.assert_run_cr(self.indir, - "--xz --groupfile %(groupfile)s" % { - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{64}-primary.xml.gz$", - "[a-z0-9]{64}-filelists.xml.gz$", - "[a-z0-9]{64}-other.xml.gz$", - "[a-z0-9]{64}-primary.sqlite.xz$", - "[a-z0-9]{64}-filelists.sqlite.xz$", - "[a-z0-9]{64}-other.sqlite.xz$", - "[a-z0-9]{64}-comps.xml$", - "[a-z0-9]{64}-comps.xml.xz$", - ], - additional_files_allowed=False) - - def test_08_createrepo_compresstype_bz2(self): - """--compress-type bz2""" - res = self.assert_run_cr(self.indir, "--compress-type bz2", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{64}-primary.xml.gz$", - "[a-z0-9]{64}-filelists.xml.gz$", - "[a-z0-9]{64}-other.xml.gz$", - "[a-z0-9]{64}-primary.sqlite.bz2$", - "[a-z0-9]{64}-filelists.sqlite.bz2$", - "[a-z0-9]{64}-other.sqlite.bz2$", - ], - additional_files_allowed=False) - - def test_09_createrepo_compresstype_gz(self): - """--compress-type bz2""" - res = self.assert_run_cr(self.indir, "--compress-type gz", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{64}-primary.xml.gz$", - "[a-z0-9]{64}-filelists.xml.gz$", - "[a-z0-9]{64}-other.xml.gz$", - "[a-z0-9]{64}-primary.sqlite.gz$", - "[a-z0-9]{64}-filelists.sqlite.gz$", - "[a-z0-9]{64}-other.sqlite.gz$", - ], - additional_files_allowed=False) - - def test_10_createrepo_compresstype_xz(self): - """--compress-type bz2""" - res = self.assert_run_cr(self.indir, "--compress-type xz", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{64}-primary.xml.gz$", - "[a-z0-9]{64}-filelists.xml.gz$", - "[a-z0-9]{64}-other.xml.gz$", - "[a-z0-9]{64}-primary.sqlite.xz$", - "[a-z0-9]{64}-filelists.sqlite.xz$", - "[a-z0-9]{64}-other.sqlite.xz$", - ], - additional_files_allowed=False) - - def test_11_createrepo_repomd_checksum(self): - """--checksum sha and --groupfile""" - res = self.assert_run_cr(self.indir, - "--repomd-checksum %(checksum)s --groupfile %(groupfile)s" % { - 'checksum': "sha1", - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{40}-primary.xml.gz$", - "[a-z0-9]{40}-filelists.xml.gz$", - "[a-z0-9]{40}-other.xml.gz$", - "[a-z0-9]{40}-primary.sqlite.bz2$", - "[a-z0-9]{40}-filelists.sqlite.bz2$", - "[a-z0-9]{40}-other.sqlite.bz2$", - "[a-z0-9]{40}-comps.xml$", - "[a-z0-9]{40}-comps.xml.gz$", - ], - additional_files_allowed=False) - - def test_12_createrepo_repomd_checksum(self): - """--checksum sha and --groupfile""" - res = self.assert_run_cr(self.indir, - "--checksum md5 --repomd-checksum %(checksum)s --groupfile %(groupfile)s" % { - 'checksum': "sha1", - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]{40}-primary.xml.gz$", - "[a-z0-9]{40}-filelists.xml.gz$", - "[a-z0-9]{40}-other.xml.gz$", - "[a-z0-9]{40}-primary.sqlite.bz2$", - "[a-z0-9]{40}-filelists.sqlite.bz2$", - "[a-z0-9]{40}-other.sqlite.bz2$", - "[a-z0-9]{40}-comps.xml$", - "[a-z0-9]{40}-comps.xml.gz$", - ], - additional_files_allowed=False) - - def test_13_createrepo_general_compress_type(self): - """--checksum sha and --groupfile""" - res = self.assert_run_cr(self.indir, - "--general-compress-type %(compress_type)s --groupfile %(groupfile)s" % { - 'compress_type': "xz", - 'groupfile': self.fn_comps }, - c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.xz$", - "[a-z0-9]+-filelists.xml.xz$", - "[a-z0-9]+-other.xml.xz$", - "[a-z0-9]+-primary.sqlite.xz$", - "[a-z0-9]+-filelists.sqlite.xz$", - "[a-z0-9]+-other.sqlite.xz$", - "[a-z0-9]+-comps.xml$", - "[a-z0-9]+-comps.xml.xz$", - ], - additional_files_allowed=False) - -class TestCaseCreaterepo_packagedirstructure(BaseTestCase): - """Use case with various directory structure of packages""" - def test_01_createrepo_check_directories_recursively(self): - self.indir_makedirs("a") - self.indir_makedirs("a/b") - self.indir_makedirs("a/b/c") - self.copy_pkg(PACKAGES[0], self.indir + "/a") - self.copy_pkg(PACKAGES[1], self.indir + "/a/b") - self.copy_pkg(PACKAGES[2], self.indir + "/a/b/c") - - res = self.assert_run_cr(self.indir, "", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.gz$", - "[a-z0-9]+-filelists.xml.gz$", - "[a-z0-9]+-other.xml.gz$", - "[a-z0-9]+-primary.sqlite.bz2$", - "[a-z0-9]+-filelists.sqlite.bz2$", - "[a-z0-9]+-other.sqlite.bz2$", - ], - additional_files_allowed=False) - - primary_path = glob.glob(os.path.join(res.outdir, "repodata/*-primary.xml.gz"))[0] - self.assert_file_contains_line(primary_path, "<name>Archer</name>") - self.assert_file_contains_line(primary_path, "<name>super_kernel</name>") - self.assert_file_contains_line(primary_path, "<name>fake_bash</name>") - - def test_02_createrepo_check_directories_recursively_with_rpm_suffix(self): - self.indir_makedirs("a") - self.indir_makedirs('a/b.rpm') - self.indir_makedirs("a/b.rpm/c") - self.copy_pkg(PACKAGES[0], self.indir + "/a") - self.copy_pkg(PACKAGES[1], self.indir + "/a/b.rpm") - self.copy_pkg(PACKAGES[2], self.indir + "/a/b.rpm/c") - - res = self.assert_run_cr(self.indir, "", c=True) - self.assert_repo_sanity(res.outdir) - self.assert_repo_files(res.outdir, - ["repomd.xml$", - "[a-z0-9]+-primary.xml.gz$", - "[a-z0-9]+-filelists.xml.gz$", - "[a-z0-9]+-other.xml.gz$", - "[a-z0-9]+-primary.sqlite.bz2$", - "[a-z0-9]+-filelists.sqlite.bz2$", - "[a-z0-9]+-other.sqlite.bz2$", - ], - additional_files_allowed=False) - - primary_path = glob.glob(os.path.join(res.outdir, "repodata/*-primary.xml.gz"))[0] - self.assert_file_contains_line(primary_path, "<name>Archer</name>") - self.assert_file_contains_line(primary_path, "<name>super_kernel</name>") - self.assert_file_contains_line(primary_path, "<name>fake_bash</name>") diff --git a/acceptance_tests/tests/test_createrepo_comparative.py b/acceptance_tests/tests/test_createrepo_comparative.py deleted file mode 100644 index 20a4b9e..0000000 --- a/acceptance_tests/tests/test_createrepo_comparative.py +++ /dev/null @@ -1,210 +0,0 @@ -import os -import os.path - -from .fixtures import PACKAGES -from .base import BaseTestCase - - -class TestCaseCreaterepoComparative_emptyrepo(BaseTestCase): - """Empty input repository""" - - def test_01_createrepo(self): - """Repo from empty directory""" - self.assert_same_results(self.indir) - - def test_02_createrepo_relativepath(self): - """Repo from empty directory - specified by relative path""" - self.assert_same_results(os.path.relpath(self.indir)) - - def test_03_createrepo_distrotag(self): - """--distro""" - self.assert_same_results(self.indir, "--distro DISTRO-TAG") - - def test_04_createrepo_distrotag(self): - """--distro""" - self.assert_same_results(self.indir, "--distro CPEID,Footag") - - def test_05_createrepo_distrotag(self): - """--distro""" - self.assert_same_results(self.indir, "--distro cpeid,tag_a --distro tag_b") - - def test_06_createrepo_contenttag(self): - """--content""" - self.assert_same_results(self.indir, "--content contenttag_a") - - def test_07_createrepo_contenttag(self): - """--content""" - self.assert_same_results(self.indir, "--content contenttag_a --content contettag_b") - - def test_08_createrepo_repotag(self): - """--repo""" - self.assert_same_results(self.indir, "--repo repotag_a") - - def test_09_createrepo_repotag(self): - """--repo""" - self.assert_same_results(self.indir, "--repo repotag_a --repo repotag_b") - - def test_10_createrepo_nodatabase(self): - """--no-database""" - self.assert_same_results(self.indir, "--no-database") - - def test_11_createrepo_uniquemdfilenames(self): - """--unique-md-filenames""" - self.assert_same_results(self.indir, "--unique-md-filenames") - - def test_12_createrepo_simplemdfilenames(self): - """--simple-md-filenames""" - self.assert_same_results(self.indir, "--simple-md-filenames") - - def test_13_createrepo_revision(self): - """--revision""" - self.assert_same_results(self.indir, "--revision XYZ") - - def test_14_createrepo_skipsymlinks(self): - """--skip-symlinks""" - self.assert_same_results(self.indir, "--skip-symlinks") - - -class TestCaseCreaterepoComparative_regularrepo(BaseTestCase): - """Repo with 3 packages""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_addpkg(PACKAGES[1]) - self.indir_addpkg(PACKAGES[2]) - - def test_01_createrepo(self): - """Regular createrepo""" - self.assert_same_results(self.indir) - - def test_02_createrepo_relativepath(self): - """Regular createrepo""" - self.assert_same_results(os.path.relpath(self.indir)) - - def test_03_createrepo_excludes(self): - """--excludes * param""" - self.assert_same_results(self.indir, "--excludes '*'") - - def test_04_createrepo_excludes(self): - """--excludes""" - self.assert_same_results(self.indir, "--excludes 'Archer-3.4.5-6.x86_64.rpm'") - - def test_05_createrepo_excludes(self): - """--excludes""" - self.assert_same_results(self.indir, "--excludes 'Archer-*.rpm'") - - def test_06_createrepo_skipsymlinks(self): - """--skip-symlinks""" - self.assert_same_results(self.indir, "--skip-symlinks") - - def test_07_createrepo_pkglist(self): - """--pkglist""" - fn_pkglist = self.indir_mkfile("pkglist", "%s\n" % PACKAGES[0]) - self.assert_same_results(self.indir, "--pkglist %s" % fn_pkglist) - - def test_08_createrepo_pkglist(self): - """--pkglist""" - fn_pkglist = self.indir_mkfile("pkglist", "%s\n%s\n" % (PACKAGES[0], PACKAGES[1])) - self.assert_same_results(self.indir, "--pkglist %s" % fn_pkglist) - - def test_09_createrepo_pkglist(self): - """--pkglist""" - fn_pkglist = self.indir_mkfile("pkglist", "%s\n\n%s\n\nfoobar.rpm\n\n" % (PACKAGES[0], PACKAGES[1])) - self.assert_same_results(self.indir, "--pkglist %s" % fn_pkglist) - -class TestCaseCreaterepoComparative_regularrepowithsubdirs(BaseTestCase): - """Repo with 3 packages, each in its own subdir""" - - def setup(self): - subdir_a = self.indir_makedirs("a") - self.copy_pkg(PACKAGES[0], subdir_a) - subdir_b = self.indir_makedirs("b") - self.copy_pkg(PACKAGES[1], subdir_b) - subdir_c = self.indir_makedirs("c") - self.copy_pkg(PACKAGES[2], subdir_c) - - def test_01_createrepo(self): - """Regular createrepo""" - self.assert_same_results(self.indir) - - def test_02_createrepo_skipsymlinks(self): - """--skip-symlinks""" - self.assert_same_results(self.indir, "--skip-symlinks") - - def test_03_createrepo_excludes(self): - """--excludes""" - self.assert_same_results(self.indir, "--excludes 'Archer-3.4.5-6.x86_64.rpm'") - - def test_04_createrepo_excludes(self): - """--excludes""" - self.assert_same_results(self.indir, "--excludes 'Archer-*.rpm'") - - -class TestCaseCreaterepoComparative_repowithsymlinks(BaseTestCase): - """Repo with 2 packages and 1 symlink to a package""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_addpkg(PACKAGES[1]) - pkg_in_tdir = self.copy_pkg(PACKAGES[2], self.tdir) - os.symlink(pkg_in_tdir, os.path.join(self.indir, os.path.basename(pkg_in_tdir))) - - def test_01_createrepo(self): - """Regular createrepo""" - self.assert_same_results(self.indir) - - def test_02_createrepo_skipsymlinks(self): - """--skip-symlinks""" - self.assert_same_results(self.indir, "--skip-symlinks") - - -class TestCaseCreaterepoComparative_repowithbadpackages(BaseTestCase): - """Repo with 1 regular package and few broken packages""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_makedirs("adirthatlookslike.rpm") - self.indir_mkfile("emptyfilethatlookslike.rpm") - self.indir_mkfile("afilethatlookslike.rpm", content="foobar") - - def test_01_createrepo(self): - """Regular createrepo""" - self.assert_same_results(self.indir) - - -class TestCaseCreaterepoComparative_cachedir(BaseTestCase): - """Repo with 3 packages and cachedir used""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_addpkg(PACKAGES[1]) - self.indir_addpkg(PACKAGES[2]) - - def test_01_createrepo_owncachedir(self): - """Each createrepo has its own cachedir""" - # Gen cache - self.assert_same_results(self.indir, "--cachedir cache") - # Run again and use the cache - _, crres, crcres = self.assert_same_results(self.indir, "--cachedir cache") - - # Compare files in the cache files (they should be identical) - cr_cache = os.path.join(crres.outdir, "cache") - crc_cache = os.path.join(crcres.outdir, "cache") - self.assert_same_dir_content(cr_cache, crc_cache) - - def test_02_createrepo_sharedcachedir(self): - """Use cache mutually""" - cache_cr = os.path.abspath(os.path.join(self.indir, "cache_cr")) - cache_crc = os.path.abspath(os.path.join(self.indir, "cache_crc")) - - # Gen cache by the cr then use it by cr_c - self.assert_run_cr(self.indir, "--cachedir %s" % cache_cr) - self.assert_run_cr(self.indir, "--cachedir %s" % cache_cr, c=True) - - # Gen cache by the cr then use it by cr_c - self.assert_run_cr(self.indir, "--cachedir %s" % cache_crc, c=True) - self.assert_run_cr(self.indir, "--cachedir %s" % cache_crc) - - # Compare files in the cache files (they should be identical) - self.assert_same_dir_content(cache_cr, cache_crc) - diff --git a/acceptance_tests/tests/test_createrepo_update_comparative.py b/acceptance_tests/tests/test_createrepo_update_comparative.py deleted file mode 100644 index 098d8d4..0000000 --- a/acceptance_tests/tests/test_createrepo_update_comparative.py +++ /dev/null @@ -1,87 +0,0 @@ -import os -import os.path - -from .fixtures import PACKAGES -from .base import BaseTestCase - - -class TestCaseCreaterepoUpdateComparative_emptyrepo(BaseTestCase): - """Empty input repository""" - - def test_01_createrepoupdate(self): - """Repo from empty directory""" - self.assert_same_results(self.indir) - self.assert_same_results(self.indir, "--update") - - def test_02_createrepoupdate_double(self): - """Repo from empty directory""" - self.assert_same_results(self.indir) - self.assert_same_results(self.indir, "--update") - self.assert_same_results(self.indir, "--update") - - def test_03_createrepoupdate_relativepath(self): - """Repo from empty directory - specified by relative path""" - self.assert_same_results(os.path.relpath(self.indir)) - self.assert_same_results(os.path.relpath(self.indir), "--update") - - def test_04_createrepoupdate_simplemdfilenames(self): - """Repo from empty directory - specified by relative path""" - self.assert_same_results(os.path.relpath(self.indir)) - self.assert_same_results(os.path.relpath(self.indir), "--update --simple-md-filenames") - - -class TestCaseCreaterepoUpdateComparative_regularrepo(BaseTestCase): - """Repo with 3 packages""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_addpkg(PACKAGES[1]) - self.indir_addpkg(PACKAGES[2]) - - def test_01_createrepoupdate(self): - """Repo from empty directory""" - self.assert_same_results(self.indir) - self.assert_same_results(self.indir, "--update") - - def test_02_createrepoupdate_double(self): - """Repo from empty directory""" - self.assert_same_results(self.indir) - self.assert_same_results(self.indir, "--update") - self.assert_same_results(self.indir, "--update") - - def test_03_createrepoupdate_relativepath(self): - """Repo from empty directory - specified by relative path""" - self.assert_same_results(os.path.relpath(self.indir)) - self.assert_same_results(os.path.relpath(self.indir), "--update") - - def test_04_createrepoupdate_simplemdfilenames(self): - """Repo from empty directory - specified by relative path""" - self.assert_same_results(os.path.relpath(self.indir)) - self.assert_same_results(os.path.relpath(self.indir), "--update --simple-md-filenames") - - -class TestCaseCreaterepoUpdateComparative_regularrepoandupdaterepo(BaseTestCase): - """Repo with 3 packages and repo that will be used as --update-md-path""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - self.indir_addpkg(PACKAGES[1]) - self.indir_addpkg(PACKAGES[2]) - res = self.assert_run_cr(self.indir) - self.update_md_path = os.path.join(self.tdir, "update_md_path") - os.rename(res.outdir, self.update_md_path) - os.rename(res.logfile, os.path.join(self.tdir, "out_createrepo-update_md_path")) - - def test_01_createrepoupdate_updatemdpath(self): - """Repo from empty directory""" - self.assert_same_results(self.indir, "--update --update-md-path %s" % self.update_md_path) - - def test_02_createrepoupdate_updatemdpathandupdate(self): - """Repo from empty directory""" - self.assert_same_results(self.indir, "--update --update-md-path %s" % self.update_md_path) - self.assert_same_results(self.indir, "--update") - - def test_03_createrepoupdate_updatemdpathdouble(self): - """Repo from empty directory""" - self.assert_same_results(self.indir, "--update --update-md-path %s" % self.update_md_path) - self.assert_same_results(self.indir, "--update --update-md-path %s" % self.update_md_path) diff --git a/acceptance_tests/tests/test_sqliterepo.py b/acceptance_tests/tests/test_sqliterepo.py deleted file mode 100644 index c3ba3d9..0000000 --- a/acceptance_tests/tests/test_sqliterepo.py +++ /dev/null @@ -1,146 +0,0 @@ -import os -import time -import os.path - -from .fixtures import PACKAGES -from .base import BaseTestCase - -BASE_XML_PATTERNS_SIMPLE = ["repomd\.xml", "primary\.xml\..+", "filelists\.xml\..+", "other\.xml\..+"] -BASE_XML_PATTERNS_UNIQUE = ["repomd\.xml", ".*-primary\.xml\..+", ".*-filelists\.xml\..+", ".*-other\.xml\..+"] - -DBS_PATTERNS = [".*primary\.sqlite\..+", ".*filelists\.sqlite\..+", ".*other\.sqlite\..+"] -DBS_PATTERNS_SIMPLE = ["primary\.sqlite\..+", "filelists\.sqlite\..+", "other\.sqlite\..+"] -DBS_PATTERNS_UNIQUE = [".*-primary\.sqlite\..+", ".*-filelists\.sqlite\..+", ".*-other\.sqlite\..+"] - -DBS_PATTERNS_UNIQUE_MD5 = ["[0-9a-z]{32}-primary\.sqlite\..+", ".*-filelists\.sqlite\..+", ".*-other\.sqlite\..+"] - -DBS_PATTERNS_SIMPLE_GZ = ["primary\.sqlite\.gz", "filelists\.sqlite\.gz", "other\.sqlite\.gz"] -DBS_PATTERNS_SIMPLE_BZ2 = ["primary\.sqlite\.bz2", "filelists\.sqlite\.bz2", "other\.sqlite\.bz2"] -DBS_PATTERNS_SIMPLE_XZ = ["primary\.sqlite\.xz", "filelists\.sqlite\.xz", "other\.sqlite\.xz"] - - -class TestCaseSqliterepo_badparams(BaseTestCase): - """Use case with bad commandline arguments""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - - -class TestCaseSqliterepo(BaseTestCase): - """Base use cases""" - - def setup(self): - self.indir_addpkg(PACKAGES[0]) - - def test_01_sqliterepo(self): - """Sqlitedbs already exists, sqliterepo without --force should fail""" - cr_res = self.run_cr(self.indir, c=True) - sq_res = self.run_sqlr(cr_res.outdir) - self.assertTrue(sq_res.rc) - self.assertTrue("already has sqlitedb present" in sq_res.out) - - def test_02_sqliterepo(self): - """Sqlitedbs should be created""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--no-database", c=True, outdir=outdir) - self.assert_run_sqlr(outdir) - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS, additional_files_allowed=True) - - def test_03_sqliterepo(self): - """Sqlitedbs with simple md filenames should be created""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--no-database --simple-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir) - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS_SIMPLE, additional_files_allowed=True) - - def test_04_sqliterepo(self): - """Sqlitedbs with unique md filenames should be created""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--no-database --unique-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir) - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS_UNIQUE, additional_files_allowed=True) - - def test_05_sqliterepo(self): - """--xz is used (old bz2 DBs should be removed)""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir, args="--force --xz") - - # Check that DBs really exists - self.assert_repo_files(outdir, - DBS_PATTERNS_SIMPLE_XZ+BASE_XML_PATTERNS_SIMPLE, - additional_files_allowed=False) - - def test_06_sqliterepo(self): - """DBs already exists but --force is used sqlitedbs should be created""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - old_primary_ts = os.path.getmtime(os.path.join(outdir, "repodata", "primary.sqlite.bz2")) - - self.assert_run_sqlr(outdir, args="--force") - new_primary_ts = os.path.getmtime(os.path.join(outdir, "repodata", "primary.sqlite.bz2")) - - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS, additional_files_allowed=True) - - # Check that DBs are newer than the old ones - self.assertTrue(old_primary_ts < new_primary_ts) - - def test_07_sqliterepo(self): - """--force and --keep-old and --xz are used (old bz2 DBs should be keeped)""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir, args="--force --keep-old --xz") - - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS_SIMPLE_BZ2, additional_files_allowed=True) - self.assert_repo_files(outdir, DBS_PATTERNS_SIMPLE_XZ, additional_files_allowed=True) - - def test_08_sqliterepo(self): - """--local-sqlite is used and old DBs exists (--force is also used)""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - old_primary_ts = os.path.getmtime(os.path.join(outdir, "repodata", "primary.sqlite.bz2")) - - self.assert_run_sqlr(outdir, args="--local-sqlite --force") - new_primary_ts = os.path.getmtime(os.path.join(outdir, "repodata", "primary.sqlite.bz2")) - - # Check that DBs really exists - expected_files = DBS_PATTERNS_SIMPLE_BZ2 + BASE_XML_PATTERNS_SIMPLE - self.assert_repo_files(outdir, expected_files, additional_files_allowed=False) - - # Check that DBs are newer than the old ones - self.assertTrue(old_primary_ts < new_primary_ts) - - def test_09_sqliterepo(self): - """--local-sqlite is used with --xz and --force and --keep-old""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir, args="--local-sqlite --force --keep-old --xz") - - # Check that DBs really exists - self.assert_repo_files(outdir, DBS_PATTERNS_SIMPLE_BZ2, additional_files_allowed=True) - self.assert_repo_files(outdir, DBS_PATTERNS_SIMPLE_XZ, additional_files_allowed=True) - - def test_10_sqliterepo(self): - """--compress-type used""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --simple-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir, args="--compress-type gz --force") - - # Check that DBs really exists - expected_files = DBS_PATTERNS_SIMPLE_GZ + BASE_XML_PATTERNS_SIMPLE - self.assert_repo_files(outdir, expected_files, additional_files_allowed=False) - - def test_11_sqliterepo(self): - """--checksum used""" - outdir = self.tdir_makedirs("repository") - self.assert_run_cr(self.indir, args="--database --unique-md-filenames", c=True, outdir=outdir) - self.assert_run_sqlr(outdir, args="--checksum md5 --force") - - # Check that DBs really exists - expected_files = DBS_PATTERNS_UNIQUE_MD5 + BASE_XML_PATTERNS_UNIQUE - self.assert_repo_files(outdir, expected_files, additional_files_allowed=False)
\ No newline at end of file diff --git a/createrepo_c.spec b/createrepo_c.spec index 8688e3e..a0ed90c 100644 --- a/createrepo_c.spec +++ b/createrepo_c.spec @@ -24,7 +24,7 @@ Summary: Creates a common metadata repository Name: createrepo_c -Version: 0.17.1 +Version: 0.17.2 Release: 1%{?dist} License: GPLv2+ URL: https://github.com/rpm-software-management/createrepo_c @@ -41,6 +41,7 @@ BuildRequires: libxml2-devel BuildRequires: openssl-devel BuildRequires: rpm-devel >= 4.8.0-28 BuildRequires: sqlite-devel +BuildRequires: xz BuildRequires: xz-devel BuildRequires: zlib-devel %if %{with zchunk} diff --git a/doc/Doxyfile.in.in b/doc/Doxyfile.in.in index 35a5e75..6f54533 100644 --- a/doc/Doxyfile.in.in +++ b/doc/Doxyfile.in.in @@ -1,104 +1,130 @@ -# Doxyfile 1.8.1.1 +# Doxyfile 1.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# 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 (" "). +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all +# 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 -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# 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 sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# 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 = "createrepo_c library" -# 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. +# 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 = @VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# 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 = "C library for metadata manipulation" -# With the PROJECT_LOGO tag one can specify an logo or 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. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# 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. +# 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 = -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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 OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) 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 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# 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 = "The $name class" \ "The $name widget" \ @@ -113,8 +139,9 @@ ABBREVIATE_BRIEF = "The $name class" \ the # 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 +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -122,578 +149,762 @@ ALWAYS_DETAILED_SEC = NO # 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 then 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. +# 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 = YES -# If the FULL_PATH_NAMES tag is set to YES then 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. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# 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 if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# 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 -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# 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 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 comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# 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 behaviour. -# 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 behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# 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 -# 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. +# 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. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. - -TCL_SUBST = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# 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 only. Doxygen will then generate output that is more tailored for -# 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. +# 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++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, 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 = -# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all -# comments according to the Markdown format, which allows for more readable -# documentation. See http://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. +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip 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. +# 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 (the default) -# will make doxygen 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. +# 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 +# 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 -# Set the SUBGROUPING tag to YES (the default) 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. +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# 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 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 (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# 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 +# 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 SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - -# Similar to the SYMBOL_CACHE_SIZE 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 appear 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. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number 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 efficively 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 = 1 + #--------------------------------------------------------------------------- # 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 and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# 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_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# 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 = NO -# 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. +# 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. When 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 (the default) only methods in the interface are included. +# 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 namespaces are hidden. +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) 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. +# 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 (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# 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 (the default) these blocks will be appended to the -# function's detailed documentation block. +# 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 (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to 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 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. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# 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 = YES -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# 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. +# 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 (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# 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 (the default) 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. +# 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 -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# 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 default), the class list will be sorted only by class name, -# not including the namespace part. +# 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. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# 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 GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of 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 initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# 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 +# 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 is 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 is 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. See the manual for examples. +# 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. +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://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. +# 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 -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# 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 by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# 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 WARN_IF_UNDOCUMENTED 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. +# 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 WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The 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 (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# 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) +# 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. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be 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. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. INPUT = @CMAKE_SOURCE_DIR@/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, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# 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, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.h -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# # Note that relative paths are relative to the directory from which doxygen is # run. @@ -703,14 +914,16 @@ EXCLUDE = src/createrepo_c.c \ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# 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 = *_wrap.* \ cmd_parser.* \ @@ -721,755 +934,1225 @@ EXCLUDE_PATTERNS = *_wrap.* \ # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# 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 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. -# Possible values are YES and NO. If left blank NO is used. +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# 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 <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> 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. +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# 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 be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# 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 option only has effect when -# FILTER_SOURCE_FILES is enabled. +# 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 = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to 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 and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# 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 function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# 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. +# 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 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 http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# 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 to YES (the default) 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. +# 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 +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# 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. +# 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 = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate 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. If left blank `html' will be used as the default path. +# 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). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# 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 personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# 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 the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# 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). 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. +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://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. -# The allowed range is 0 to 359. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of -# entries shown in the various tree structured indices initially; the user -# can expand and collapse entries dynamically later on. Doxygen will expand -# the tree to such a level that at most the specified number of entries are -# visible (unless a fully collapsed tree already exceeds this amount). -# So setting the number of entries 1 will produce a full collapsed tree by -# default. 0 is a special value representing an infinite number of entries -# and will result in a full expanded tree by default. +# 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, 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 http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# 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 -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# 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 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" -# When GENERATE_DOCSET tag is set to YES, 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. +# 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 -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# 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 GENERATE_PUBLISHER_NAME tag identifies the documentation 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, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, 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 +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, 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 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 = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The 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 -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# 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 = -# If the GENERATE_HTMLHELP tag is set to YES, 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. +# 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 contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# 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. +# 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 -# http://doc.trolltech.com/qthelpproject.html#namespace +# 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 -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# 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 QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# 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_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> -# Qt Help Project / Custom Filters</a>. +# 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. -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> -# Qt Help Project / Filter Attributes</a>. +# 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 = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# 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, which together with the HTML files, 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. +# 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. +# 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 -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) 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. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When 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. +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# 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. +# 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 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered 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 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 -# 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 http://www.mathjax.org before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = -# 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. +# 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 <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvantages are that it is more difficult to setup -# and does not have live searching capabilities. +# implemented using a web server instead of a web client using JavaScript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. SERVER_BASED_SEARCH = NO +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: +# https://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + #--------------------------------------------------------------------------- -# configuration options related to the LaTeX output +# Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. +# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. +# invoked. +# +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. PAPER_TYPE = a4 -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for -# the generated latex document. The footer should contain everything after -# the last chapter. If it is left blank doxygen will generate a -# standard footer. Notice: only use this tag if you know what you are doing! +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. 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). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HIDE_INDICES = NO -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the -# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See -# http://en.wikipedia.org/wiki/BibTeX for more info. +# bibliography, e.g. plainnat, or ieeetr. See +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- -# configuration options related to the RTF output +# Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. +# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. RTF_HYPERLINKS = NO -# Load style sheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + #--------------------------------------------------------------------------- -# configuration options related to the man page output +# Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. MAN_LINKS = NO #--------------------------------------------------------------------------- -# configuration options related to the XML output +# Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. +# The XML_OUTPUT tag is used to specify where the XML pages 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: xml. +# This tag requires that the tag GENERATE_XML is set to YES. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. -XML_SCHEMA = +XML_NS_MEMB_FILE_SCOPE = NO -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- -XML_DTD = +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. +GENERATE_DOCBOOK = NO -XML_PROGRAMLISTING = YES +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO #--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output +# Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. +# The default value is: NO. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- -# configuration options related to the Perl module output +# Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. PERLMOD_MAKEVAR_PREFIX = @@ -1477,329 +2160,456 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# pointed to by INCLUDE_PATH will be searched when a #include is found. +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition that -# overrules the definition found in the source code. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all references to function-like macros -# that are alone on a line, have an all uppercase name, and do not end with a -# semicolon, because these will confuse the parser if not removed. +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration options related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. For each -# tag file the location of the external documentation should be added. The -# format of a tag file without this location is as follows: -# +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: -# # TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths -# or URLs. Note that each tag file must have a unique name (where the name does -# NOT include the path). If a tag file is not located in the directory in which -# doxygen is run, you must also specify the path to the tagfile here. +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. -PERL_PATH = /usr/bin/perl +EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option also works with HAVE_DOT disabled, but it is recommended to -# install and use dot, since it yields more powerful graphs. +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCGEN_PATH = +DIA_PATH = -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. HAVE_DOT = NO -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_NUM_THREADS = 0 -# By default doxygen will use the Helvetica font for all dot files that -# doxygen generates. When you want a differently looking font you can specify -# the font name using DOT_FONTNAME. You need to make sure dot is able to find -# the font, which can be done by putting it in a standard location or by setting -# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the -# directory containing the font. +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTNAME = Helvetica -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTSIZE = 10 -# By default doxygen will tell dot to use the Helvetica font. -# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to -# set the path where dot can find it. +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. UML_LOOK = NO -# If the UML_LOOK tag is enabled, the fields and methods are shown inside -# the class node. If there are many fields or methods and many nodes the -# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS -# threshold limits the number of items for each type to make the size more -# managable. Set this to 0 for no limit. Note that the threshold may be -# exceeded by 50% before the limit is enforced. +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will generate a graphical hierarchy of all classes instead of a textual one. +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are svg, png, jpg, or gif. -# If left blank png will be used. If you choose svg you need to set -# HTML_FILE_EXTENSION to xhtml in order to make the SVG files -# visible in IE 9+ (other browsers do not have this requirement). +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. -# Note that this requires a modern browser other than Internet Explorer. -# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you -# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files -# visible. Older versions of IE do not have SVG support. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. INTERACTIVE_SVG = NO -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. DOTFILE_DIRS = # The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the -# \mscfile command). +# contain msc files that are included in the documentation (see the \mscfile +# command). MSCFILE_DIRS = -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_GRAPH_MAX_NODES = 50 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate +# files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc and +# plantuml temporary files. +# The default value is: YES. DOT_CLEANUP = YES diff --git a/src/helpers.c b/src/helpers.c index 5dc98a6..3bb9624 100644 --- a/src/helpers.c +++ b/src/helpers.c @@ -78,9 +78,9 @@ cr_stat_and_insert(const gchar *dirname, const gchar *filename, GSList **list) * to the new repo. (except the repomd.xml) */ static gboolean -cr_repodata_blacklist_classic(const char *repodata_path, +cr_repodata_excludelist_classic(const char *repodata_path, int retain, - GSList **blacklist, + GSList **excludelist, GError **err) { /* This piece of code implement the retain_old functionality in @@ -114,13 +114,13 @@ cr_repodata_blacklist_classic(const char *repodata_path, const gchar *filename; GError *tmp_err = NULL; - assert(blacklist); + assert(excludelist); assert(!err || *err == NULL); - *blacklist = NULL; + *excludelist = NULL; if (retain == -1) { - // -1 means retain all - nothing to be blacklisted + // -1 means retain all - nothing to be excluded return TRUE; } else if (retain < 0) { // other negative values are error @@ -171,11 +171,11 @@ cr_repodata_blacklist_classic(const char *repodata_path, g_dir_close(dirp); dirp = NULL; - // Append files to the blacklist + // Append files to the excludelist for (int x = 0; x < num_of_lists; x++) { for (GSList *el = g_slist_nth(*(lists[x]), retain); el; el = g_slist_next(el)) { OldFile *of = (OldFile *) el->data; - *blacklist = g_slist_prepend(*blacklist, + *excludelist = g_slist_prepend(*excludelist, g_path_get_basename(of->path)); } // Free the list @@ -187,26 +187,26 @@ cr_repodata_blacklist_classic(const char *repodata_path, /* List files that should be removed from the repo or not copied * to the new repo. (except the repomd.xml) - * This function blacklist all metadata files listed in repomd.xml - * if retain == 0, otherwise it don't blacklist any file + * This function excludes all metadata files listed in repomd.xml + * if retain == 0, otherwise it don't exclude any file */ static gboolean -cr_repodata_blacklist(const char *repodata_path, +cr_repodata_excludelist(const char *repodata_path, int retain, - GSList **blacklist, + GSList **excludelist, GError **err) { gchar *old_repomd_path = NULL; cr_Repomd *repomd = NULL; GError *tmp_err = NULL; - assert(blacklist); + assert(excludelist); assert(!err || *err == NULL); - *blacklist = NULL; + *excludelist = NULL; if (retain == -1 || retain > 0) { - // retain all - nothing to be blacklisted + // retain all - nothing to be excluded return TRUE; } else if (retain < 0) { // other negative values are error @@ -246,7 +246,7 @@ cr_repodata_blacklist(const char *repodata_path, continue; } - *blacklist = g_slist_prepend(*blacklist, + *excludelist = g_slist_prepend(*excludelist, g_path_get_basename(rec->location_href)); } @@ -255,9 +255,9 @@ cr_repodata_blacklist(const char *repodata_path, } static gboolean -cr_repodata_blacklist_by_age(const char *repodata_path, +cr_repodata_excludelist_by_age(const char *repodata_path, gint64 md_max_age, - GSList **blacklist, + GSList **excludelist, GError **err) { GDir *dirp = NULL; @@ -265,13 +265,13 @@ cr_repodata_blacklist_by_age(const char *repodata_path, time_t current_time; GError *tmp_err = NULL; - assert(blacklist); + assert(excludelist); assert(!err || *err == NULL); - *blacklist = NULL; + *excludelist = NULL; if (md_max_age < 0) { - // A negative value means retain all - nothing to be blacklisted + // A negative value means retain all - nothing to be excluded return TRUE; } @@ -309,8 +309,8 @@ cr_repodata_blacklist_by_age(const char *repodata_path, g_debug("File is too old (%"G_GINT64_FORMAT" > %"G_GINT64_FORMAT") %s", age, md_max_age, filename); - // Add the file to the blacklist - *blacklist = g_slist_prepend(*blacklist, g_strdup(filename)); + // Add the file to the excludelist + *excludelist = g_slist_prepend(*excludelist, g_strdup(filename)); } g_dir_close(dirp); @@ -323,7 +323,7 @@ cr_remove_metadata_classic(const char *repopath, int retain, GError **err) int rc = CRE_OK; gboolean ret = TRUE; gchar *full_repopath = NULL; - GSList *blacklist = NULL; + GSList *excludelist = NULL; GDir *dirp = NULL; const gchar *filename; GError *tmp_err = NULL; @@ -334,12 +334,12 @@ cr_remove_metadata_classic(const char *repopath, int retain, GError **err) full_repopath = g_strconcat(repopath, "/repodata/", NULL); // Get list of files that should be deleted - ret = cr_repodata_blacklist_classic(full_repopath, retain, &blacklist, err); + ret = cr_repodata_excludelist_classic(full_repopath, retain, &excludelist, err); if (!ret) return FALSE; // Always remove repomd.xml - blacklist = g_slist_prepend(blacklist, g_strdup("repomd.xml")); + excludelist = g_slist_prepend(excludelist, g_strdup("repomd.xml")); // Open the repodata/ directory dirp = g_dir_open(full_repopath, 0, &tmp_err); @@ -351,12 +351,12 @@ cr_remove_metadata_classic(const char *repopath, int retain, GError **err) } // Iterate over the files in the repository and remove all files - // that are listed on blacklist + // that are listed on excludelist while ((filename = g_dir_read_name(dirp))) { gchar *full_path; - if (!g_slist_find_custom(blacklist, filename, (GCompareFunc) g_strcmp0)) - // The filename is not blacklisted, skip it + if (!g_slist_find_custom(excludelist, filename, (GCompareFunc) g_strcmp0)) + // The filename is not excluded, skip it continue; full_path = g_strconcat(full_repopath, filename, NULL); @@ -373,7 +373,7 @@ cr_remove_metadata_classic(const char *repopath, int retain, GError **err) cleanup: - cr_slist_free_full(blacklist, g_free); + cr_slist_free_full(excludelist, g_free); g_free(full_repopath); if (dirp) g_dir_close(dirp); @@ -389,7 +389,7 @@ cr_old_metadata_retention(const char *old_repo, GError **err) { gboolean ret = TRUE; - GSList *blacklist = NULL; + GSList *excludelist = NULL; GDir *dirp = NULL; const gchar *filename; GError *tmp_err = NULL; @@ -404,17 +404,17 @@ cr_old_metadata_retention(const char *old_repo, // Get list of file that should be skiped during copying g_debug("Retention type: %d (%"G_GINT64_FORMAT")", type, val); if (type == CR_RETENTION_BYAGE) - ret = cr_repodata_blacklist_by_age(old_repo, val, &blacklist, err); + ret = cr_repodata_excludelist_by_age(old_repo, val, &excludelist, err); else if (type == CR_RETENTION_COMPATIBILITY) - ret = cr_repodata_blacklist_classic(old_repo, (int) val, &blacklist, err); + ret = cr_repodata_excludelist_classic(old_repo, (int) val, &excludelist, err); else // CR_RETENTION_DEFAULT - ret = cr_repodata_blacklist(old_repo, (int) val, &blacklist, err); + ret = cr_repodata_excludelist(old_repo, (int) val, &excludelist, err); if (!ret) return FALSE; // Never copy old repomd.xml to the new repository - blacklist = g_slist_prepend(blacklist, g_strdup("repomd.xml")); + excludelist = g_slist_prepend(excludelist, g_strdup("repomd.xml")); // Open directory with old repo dirp = g_dir_open (old_repo, 0, &tmp_err); @@ -429,10 +429,10 @@ cr_old_metadata_retention(const char *old_repo, } // Iterate over the files in the old repository and copy all - // that are not listed on blacklist + // that are not listed on excludelist while ((filename = g_dir_read_name(dirp))) { - if (g_slist_find_custom(blacklist, filename, (GCompareFunc) g_strcmp0)) { - g_debug("Blacklisted: %s", filename); + if (g_slist_find_custom(excludelist, filename, (GCompareFunc) g_strcmp0)) { + g_debug("Excluded: %s", filename); continue; } @@ -470,7 +470,7 @@ cr_old_metadata_retention(const char *old_repo, exit: // Cleanup - cr_slist_free_full(blacklist, g_free); + cr_slist_free_full(excludelist, g_free); if (dirp) g_dir_close(dirp); diff --git a/src/python/sqlite-py.c b/src/python/sqlite-py.c index ffa57d4..8bcb5fa 100644 --- a/src/python/sqlite-py.c +++ b/src/python/sqlite-py.c @@ -115,10 +115,16 @@ static PyObject * sqlite_repr(_SqliteObject *self) { char *type; - if (self->db->type == CR_DB_PRIMARY) type = "PrimaryDb"; - else if (self->db->type == CR_DB_FILELISTS) type = "FilelistsDb"; - else if (self->db->type == CR_DB_OTHER) type = "OtherDb"; - else type = "UnknownDb"; + + if (self->db) { + if (self->db->type == CR_DB_PRIMARY) type = "PrimaryDb"; + else if (self->db->type == CR_DB_FILELISTS) type = "FilelistsDb"; + else if (self->db->type == CR_DB_OTHER) type = "OtherDb"; + else type = "UnknownDb"; + } else { + type = "Closed"; + } + return PyUnicode_FromFormat("<createrepo_c.Sqlite %s object>", type); } diff --git a/src/python/xml_file-py.c b/src/python/xml_file-py.c index 26e4615..19496ef 100644 --- a/src/python/xml_file-py.c +++ b/src/python/xml_file-py.c @@ -139,24 +139,24 @@ xmlfile_dealloc(_XmlFileObject *self) static PyObject * xmlfile_repr(_XmlFileObject *self) { - if (check_XmlFileStatus(self)) { - return NULL; - } - char *type; - switch (self->xmlfile->type) { - case CR_XMLFILE_PRIMARY: - type = "Primary"; - break; - case CR_XMLFILE_FILELISTS: - type = "Filelists"; - break; - case CR_XMLFILE_OTHER: - type = "Other"; - break; - default: - type = "Unknown"; + if (self->xmlfile) { + switch (self->xmlfile->type) { + case CR_XMLFILE_PRIMARY: + type = "Primary"; + break; + case CR_XMLFILE_FILELISTS: + type = "Filelists"; + break; + case CR_XMLFILE_OTHER: + type = "Other"; + break; + default: + type = "Unknown"; + } + } else { + type = "Closed"; } return PyUnicode_FromFormat("<createrepo_c.XmlFile %s object>", type); diff --git a/src/xml_parser.h b/src/xml_parser.h index 5adfc50..a31718d 100644 --- a/src/xml_parser.h +++ b/src/xml_parser.h @@ -49,7 +49,7 @@ typedef enum { CR_XML_WARNING_SENTINEL, } cr_XmlParserWarningType; -/** Callback for XML parser wich is called when a new package object parsing +/** Callback for XML parser which is called when a new package object parsing * is started. This function has to set *pkg to package object which will * be populated by parser. The object could be empty, or already partially * filled (by other XML parsers) package object. @@ -72,7 +72,7 @@ typedef int (*cr_XmlParserNewPkgCb)(cr_Package **pkg, void *cbdata, GError **err); -/** Callback for XML parser wich is called when a package element is parsed. +/** Callback for XML parser which is called when a package element is parsed. * @param pkg Currently parsed package. * @param cbdata User data. * @param err GError ** @@ -87,7 +87,7 @@ typedef int (*cr_XmlParserPkgCb)(cr_Package *pkg, * CR_CB_RET_OK then parsing is immediately interrupted. * @param type Type of warning * @param msg Warning msg. The message is destroyed after the call. - * If you want touse the message later, you have to copy it. + * If you want to use the message later, you have to copy it. * @param cbdata User data. * @param err GError ** * @return CR_CB_RET_OK (0) or CR_CB_RET_ERR (1) - stops the parsing diff --git a/src/xml_parser_internal.h b/src/xml_parser_internal.h index 2c8206e..b684594 100644 --- a/src/xml_parser_internal.h +++ b/src/xml_parser_internal.h @@ -75,7 +75,7 @@ typedef struct _cr_ParserData { int docontent; /*!< Store text content of the current element? */ char *content; /*!< Text content of the element */ - int lcontent; /*!< The content lenght */ + int lcontent; /*!< The content length */ int acontent; /*!< Available bytes in the content */ xmlParserCtxtPtr parser; /*!< The parser */ @@ -105,7 +105,7 @@ typedef struct _cr_ParserData { void *pkgcb_data; /*!< User data for the pkgcb. */ cr_XmlParserPkgCb pkgcb; /*!< - Callback called when a signel pkg data are completly parsed. */ + Callback called when a single pkg data is completely parsed. */ void *warningcb_data; /*!< User data fot he warningcb. */ cr_XmlParserWarningCb warningcb; /*!< diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 19e91fa..3936176 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -54,8 +54,8 @@ ADD_EXECUTABLE(test_modifyrepo_shared test_modifyrepo_shared.c) TARGET_LINK_LIBRARIES(test_modifyrepo_shared libcreaterepo_c ${GLIB2_LIBRARIES}) ADD_DEPENDENCIES(tests test_modifyrepo_shared) -CONFIGURE_FILE("run_gtester.sh.in" "${CMAKE_BINARY_DIR}/tests/run_gtester.sh") -ADD_TEST(test_main run_gtester.sh) +CONFIGURE_FILE("run_tests.sh.in" "${CMAKE_BINARY_DIR}/tests/run_tests.sh") +ADD_TEST(test_main run_tests.sh) IF (ENABLE_PYTHON) ADD_SUBDIRECTORY(python) diff --git a/tests/python/tests/test_crfile.py b/tests/python/tests/test_crfile.py index 09db365..ee92516 100644 --- a/tests/python/tests/test_crfile.py +++ b/tests/python/tests/test_crfile.py @@ -65,8 +65,8 @@ class TestCaseCrFile(unittest.TestCase): f.write("foobar") f.close() - content = open(path).read() - self.assertEqual(content, "foobar") + with open(path) as foo: + self.assertEqual(foo.read(), "foobar") def test_crfile_gz_compression(self): path = os.path.join(self.tmpdir, "foo.gz") @@ -77,8 +77,8 @@ class TestCaseCrFile(unittest.TestCase): f.close() import gzip - content = gzip.open(path).read().decode('utf-8') - self.assertEqual(content, "foobar") + with gzip.open(path) as foo_gz: + self.assertEqual(foo_gz.read().decode('utf-8'), "foobar") def test_crfile_bz2_compression(self): path = os.path.join(self.tmpdir, "foo.bz2") @@ -89,8 +89,9 @@ class TestCaseCrFile(unittest.TestCase): f.close() import bz2 - content = bz2.decompress(open(path, 'rb').read()).decode('utf-8') - self.assertEqual(content, "foobar") + with open(path, 'rb') as foo_bz2: + content = bz2.decompress(foo_bz2.read()).decode('utf-8') + self.assertEqual(content, "foobar") def test_crfile_xz_compression(self): path = os.path.join(self.tmpdir, "foo.xz") @@ -101,9 +102,9 @@ class TestCaseCrFile(unittest.TestCase): f.close() import subprocess - p = subprocess.Popen(["unxz", "--stdout", path], stdout=subprocess.PIPE) - content = p.stdout.read().decode('utf-8') - self.assertEqual(content, "foobar") + with subprocess.Popen(["unxz", "--stdout", path], stdout=subprocess.PIPE) as p: + content = p.stdout.read().decode('utf-8') + self.assertEqual(content, "foobar") def test_crfile_zck_compression(self): if cr.HAS_ZCK == 0: @@ -117,6 +118,6 @@ class TestCaseCrFile(unittest.TestCase): f.close() import subprocess - p = subprocess.Popen(["unzck", "--stdout", path], stdout=subprocess.PIPE) - content = p.stdout.read().decode('utf-8') - self.assertEqual(content, "foobar") + with subprocess.Popen(["unzck", "--stdout", path], stdout=subprocess.PIPE) as p: + content = p.stdout.read().decode('utf-8') + self.assertEqual(content, "foobar") diff --git a/tests/python/tests/test_misc.py b/tests/python/tests/test_misc.py index 22388aa..3dd753a 100644 --- a/tests/python/tests/test_misc.py +++ b/tests/python/tests/test_misc.py @@ -13,7 +13,8 @@ class TestCaseMisc(unittest.TestCase): self.nofile = os.path.join(self.tmpdir, "this_file_should_not_exists") self.tmpfile = os.path.join(self.tmpdir, "file") self.content = "some\nfoo\ncontent\n" - open(self.tmpfile, "w").write(self.content) + with open(self.tmpfile, "w") as tmp_file: + tmp_file.write(self.content) def tearDown(self): shutil.rmtree(self.tmpdir) diff --git a/tests/python/tests/test_repomdrecord.py b/tests/python/tests/test_repomdrecord.py index f92c2e2..58f21cc 100644 --- a/tests/python/tests/test_repomdrecord.py +++ b/tests/python/tests/test_repomdrecord.py @@ -162,7 +162,8 @@ class TestCaseRepomdRecord(unittest.TestCase): self.assertEqual(rec.db_ver, 11) def test_repomdrecord_compress_and_fill(self): - open(self.path01, "w").write("foobar\ncontent\nhh\n") + with open(self.path01, "w") as path01_file: + path01_file.write("foobar\ncontent\nhh\n") self.assertTrue(os.path.exists(self.path01)) rec = cr.RepomdRecord("primary", self.path01) diff --git a/tests/python/tests/test_sqlite.py b/tests/python/tests/test_sqlite.py index 045b0fc..5247a3c 100644 --- a/tests/python/tests/test_sqlite.py +++ b/tests/python/tests/test_sqlite.py @@ -56,6 +56,7 @@ class TestCaseSqlite(unittest.TestCase): self.assertRaises(cr.CreaterepoCError, db.add_pkg, pkg) self.assertRaises(cr.CreaterepoCError, db.dbinfo_update, "somechecksum") + self.assertEqual("<createrepo_c.Sqlite Closed object>", db.__str__()) db.close() # No error should be raised del db # No error should be raised diff --git a/tests/python/tests/test_xml_file.py b/tests/python/tests/test_xml_file.py index 0100d1b..fad8764 100644 --- a/tests/python/tests/test_xml_file.py +++ b/tests/python/tests/test_xml_file.py @@ -49,6 +49,7 @@ class TestCaseXmlFile(unittest.TestCase): self.assertRaises(cr.CreaterepoCError, f.set_num_of_pkgs, 1) self.assertRaises(cr.CreaterepoCError, f.add_pkg, pkg) self.assertRaises(cr.CreaterepoCError, f.add_chunk, "<chunk>text</chunk>") + self.assertEqual("<createrepo_c.XmlFile Closed object>", f.__str__()) f.close() # No error should be raised del(f) # No error should be raised @@ -76,7 +77,8 @@ class TestCaseXmlFile(unittest.TestCase): "foobar/foo/xxx/cvydmaticxuiowe") # Already existing file - open(path, "w").write("foobar") + with open(path, "w") as foofile: + foofile.write("foobar") self.assertRaises(IOError, cr.PrimaryXmlFile, path) def test_xmlfile_no_compression(self): @@ -86,8 +88,8 @@ class TestCaseXmlFile(unittest.TestCase): self.assertTrue(os.path.isfile(path)) f.close() - content = open(path).read() - self.assertEqual(content, + with open(path) as primary: + self.assertEqual(primary.read(), """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> </metadata>""") @@ -100,8 +102,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() import gzip - content = gzip.open(path).read().decode('utf-8') - self.assertEqual(content, + with gzip.open(path) as primary: + self.assertEqual(primary.read().decode('utf-8'), """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> </metadata>""") @@ -114,8 +116,9 @@ class TestCaseXmlFile(unittest.TestCase): f.close() import bz2 - content = bz2.decompress(open(path, 'rb').read()).decode('utf-8') - self.assertEqual(content, + with open(path, 'rb') as primary_bz2: + content = bz2.decompress(primary_bz2.read()).decode('utf-8') + self.assertEqual(content, """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> </metadata>""") @@ -128,9 +131,9 @@ class TestCaseXmlFile(unittest.TestCase): f.close() import subprocess - p = subprocess.Popen(["unxz", "--stdout", path], stdout=subprocess.PIPE) - content = p.stdout.read().decode('utf-8') - self.assertEqual(content, + with subprocess.Popen(["unxz", "--stdout", path], stdout=subprocess.PIPE) as p: + content = p.stdout.read().decode('utf-8') + self.assertEqual(content, """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> </metadata>""") @@ -146,9 +149,9 @@ class TestCaseXmlFile(unittest.TestCase): f.close() import subprocess - p = subprocess.Popen(["unzck", "--stdout", path], stdout=subprocess.PIPE) - content = p.stdout.read().decode('utf-8') - self.assertEqual(content, + with subprocess.Popen(["unzck", "--stdout", path], stdout=subprocess.PIPE) as p: + content = p.stdout.read().decode('utf-8') + self.assertEqual(content, """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> </metadata>""") @@ -161,8 +164,8 @@ class TestCaseXmlFile(unittest.TestCase): f.set_num_of_pkgs(22) f.close() - content = open(path).read() - self.assertEqual(content, + with open(path) as primary: + self.assertEqual(primary.read(), """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="22"> </metadata>""") @@ -185,7 +188,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as primary: + self.assertEqual(primary.read(), """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> <package type="rpm"> @@ -256,7 +260,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as filelists: + self.assertEqual(filelists.read(), """<?xml version="1.0" encoding="UTF-8"?> <filelists xmlns="http://linux.duke.edu/metadata/filelists" packages="0"> <package pkgid="4e0b775220c67f0f2c1fd2177e626b9c863a098130224ff09778ede25cea9a9e" name="Archer" arch="x86_64"> @@ -280,7 +285,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as other: + self.assertEqual(other.read(), """<?xml version="1.0" encoding="UTF-8"?> <otherdata xmlns="http://linux.duke.edu/metadata/other" packages="0"> <package pkgid="4e0b775220c67f0f2c1fd2177e626b9c863a098130224ff09778ede25cea9a9e" name="Archer" arch="x86_64"> @@ -307,7 +313,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as primary: + self.assertEqual(primary.read(), """<?xml version="1.0" encoding="UTF-8"?> <metadata xmlns="http://linux.duke.edu/metadata/common" xmlns:rpm="http://linux.duke.edu/metadata/rpm" packages="0"> <chunk>Some XML chunk</chunk> @@ -326,7 +333,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as filelists: + self.assertEqual(filelists.read(), """<?xml version="1.0" encoding="UTF-8"?> <filelists xmlns="http://linux.duke.edu/metadata/filelists" packages="0"> <chunk>Some XML chunk</chunk> @@ -345,7 +353,8 @@ class TestCaseXmlFile(unittest.TestCase): f.close() self.assertTrue(os.path.isfile(path)) - self.assertEqual(open(path).read(), + with open(path) as other: + self.assertEqual(other.read(), """<?xml version="1.0" encoding="UTF-8"?> <otherdata xmlns="http://linux.duke.edu/metadata/other" packages="0"> <chunk>Some XML chunk</chunk> diff --git a/tests/python/tests/test_xml_parser.py b/tests/python/tests/test_xml_parser.py index 8856096..ddc089f 100644 --- a/tests/python/tests/test_xml_parser.py +++ b/tests/python/tests/test_xml_parser.py @@ -101,8 +101,8 @@ class TestCaseXmlParserPrimary(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(PRIMARY_SNIPPET_01).read() - cr.xml_parse_primary_snippet(content, newpkgcb, pkgcb, warningcb, 1) + with open(PRIMARY_SNIPPET_01) as primary_snip: + cr.xml_parse_primary_snippet(primary_snip.read(), newpkgcb, pkgcb, warningcb, 1) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], ['super_kernel']) @@ -175,8 +175,8 @@ class TestCaseXmlParserPrimary(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(PRIMARY_SNIPPET_02).read() - cr.xml_parse_primary_snippet(content, newpkgcb, pkgcb, warningcb, 1) + with open(PRIMARY_SNIPPET_02) as primary_snip: + cr.xml_parse_primary_snippet(primary_snip.read(), newpkgcb, pkgcb, warningcb, 1) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], ['fake_bash', 'super_kernel']) @@ -380,8 +380,8 @@ class TestCaseXmlParserFilelists(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(FILELISTS_SNIPPET_01).read() - cr.xml_parse_filelists_snippet(content, newpkgcb, pkgcb, warningcb) + with open(FILELISTS_SNIPPET_01) as filelists_snip: + cr.xml_parse_filelists_snippet(filelists_snip.read(), newpkgcb, pkgcb, warningcb) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], ['super_kernel']) @@ -468,8 +468,8 @@ class TestCaseXmlParserFilelists(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(FILELISTS_SNIPPET_02).read() - cr.xml_parse_filelists_snippet(content, newpkgcb, pkgcb, warningcb) + with open(FILELISTS_SNIPPET_02) as filelists_snip: + cr.xml_parse_filelists_snippet(filelists_snip.read(), newpkgcb, pkgcb, warningcb) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], ['fake_bash', 'super_kernel']) @@ -684,8 +684,8 @@ class TestCaseXmlParserOther(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(OTHER_SNIPPET_01).read() - cr.xml_parse_other_snippet(content, newpkgcb, pkgcb, warningcb) + with open(OTHER_SNIPPET_01) as other_snip: + cr.xml_parse_other_snippet(other_snip.read(), newpkgcb, pkgcb, warningcb) self.assertEqual(userdata["warnings"], []) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], @@ -750,8 +750,8 @@ class TestCaseXmlParserOther(unittest.TestCase): def warningcb(warn_type, msg): userdata["warnings"].append((warn_type, msg)) - content = open(OTHER_SNIPPET_02).read() - cr.xml_parse_other_snippet(content, newpkgcb, pkgcb, warningcb) + with open(OTHER_SNIPPET_02) as other_snip: + cr.xml_parse_other_snippet(other_snip.read(), newpkgcb, pkgcb, warningcb) self.assertEqual([pkg.name for pkg in userdata["pkgs"]], ['fake_bash', 'super_kernel']) diff --git a/tests/run_gtester.sh.in b/tests/run_tests.sh.in index 7dae2dd..db53cdc 100755 --- a/tests/run_gtester.sh.in +++ b/tests/run_tests.sh.in @@ -9,11 +9,6 @@ RET=0 # object file: No such file or directory" error message. export "LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/src/:" -function runtest { - gtester --verbose --keep-going "$1" - if [ $? -ne 0 ]; then RET=$(($RET+1)) ; fi -} - # Go to source dir (so test would be able to use testdata/ in this dir) cd ${CMAKE_CURRENT_SOURCE_DIR} @@ -21,7 +16,8 @@ cd ${CMAKE_CURRENT_SOURCE_DIR} for i in "$BINDIR"/test_*; do # Run only executable regular files with "test_" prefix if [ -f $i -a -x $i ]; then - runtest "$i" + $i #execute the test + if [ $? -ne 0 ]; then RET=$(($RET+1)) ; fi fi done diff --git a/tests/test_load_metadata.c b/tests/test_load_metadata.c index 45a8b2b..cd5af6c 100644 --- a/tests/test_load_metadata.c +++ b/tests/test_load_metadata.c @@ -29,9 +29,6 @@ #include "createrepo/metadata_internal.h" #define REPO_SIZE_00 0 -static const char *REPO_HASH_KEYS_00[] = {}; -static const char *REPO_NAME_KEYS_00[] = {}; -static const char *REPO_FILENAME_KEYS_00[] = {}; #define REPO_SIZE_01 1 static const char *REPO_HASH_KEYS_01[] = {"152824bff2aa6d54f429d43e87a3ff3a0286505c6d93ec87692b5e3a9e3b97bf"}; @@ -47,9 +44,6 @@ static const char *REPO_FILENAME_KEYS_02[] = {"super_kernel-6.0.1-2.x86_64.rpm", "fake_bash-1.1.1-1.x86_64.rpm"}; #define REPO_SIZE_03 0 -static const char *REPO_HASH_KEYS_03[] = {}; -static const char *REPO_NAME_KEYS_03[] = {}; -static const char *REPO_FILENAME_KEYS_03[] = {}; @@ -97,9 +91,9 @@ void test_helper_check_keys(const char *repopath, cr_HashTableKey key, guint rep static void test_cr_metadata_locate_and_load_xml(void) { - test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_HASH, REPO_SIZE_00, REPO_HASH_KEYS_00); - test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_NAME, REPO_SIZE_00, REPO_NAME_KEYS_00); - test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_FILENAME, REPO_SIZE_00, REPO_FILENAME_KEYS_00); + test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_HASH, REPO_SIZE_00, NULL); + test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_NAME, REPO_SIZE_00, NULL); + test_helper_check_keys(TEST_REPO_00, CR_HT_KEY_FILENAME, REPO_SIZE_00, NULL); test_helper_check_keys(TEST_REPO_01, CR_HT_KEY_HASH, REPO_SIZE_01, REPO_HASH_KEYS_01); test_helper_check_keys(TEST_REPO_01, CR_HT_KEY_NAME, REPO_SIZE_01, REPO_NAME_KEYS_01); @@ -110,9 +104,9 @@ static void test_cr_metadata_locate_and_load_xml(void) test_helper_check_keys(TEST_REPO_02, CR_HT_KEY_FILENAME, REPO_SIZE_02, REPO_FILENAME_KEYS_02); #ifdef WITH_LIBMODULEMD - test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_HASH, REPO_SIZE_03, REPO_HASH_KEYS_03); - test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_NAME, REPO_SIZE_03, REPO_NAME_KEYS_03); - test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_FILENAME, REPO_SIZE_03, REPO_FILENAME_KEYS_03); + test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_HASH, REPO_SIZE_03, NULL); + test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_NAME, REPO_SIZE_03, NULL); + test_helper_check_keys(TEST_REPO_03, CR_HT_KEY_FILENAME, REPO_SIZE_03, NULL); #else /* If we don't have libmodulemd support, this should fail to locate and * return CRE_MODULEMD |