Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trivial: add .gitignore, compact CMakeLists.txt, forward declare library-dependent type #102

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

kwvg
Copy link
Contributor

@kwvg kwvg commented Jun 22, 2023

Additional Notes

  • contrib: add .gitignore
  • build: resolve cmake warning by specifying minimum version on first line
    • Done to resolve warning
      CMake Warning (dev) at CMakeLists.txt:1 (project):
          cmake_minimum_required() should be called prior to this top-level project()
          call.  Please see the cmake-commands(7) manual for usage documentation of
          both commands.
      This warning is for project developers.  Use -Wno-dev to suppress it.
      
  • build: remove duplicated sources list from CMakeLists
    • CMake was bumped due to the dependency on list transformers, which were employed to always ensure that CMake is supplied the absolute path to source files.
    • That feature was introduced in CMake 3.12
  • refactor: don't expose libxml2 headers, forward declare types instead
    • In preparation for potential refactoring of the codebase into smaller, reusable libraries, headers should abstain from containing dependency-specific definitions, if possible
    • A dependent project shouldn't be concerned with what was used to build the library, assuming ideal circumstances. Keeping in line with that, forward declarations were employed to remove the libxml2 includes from the header.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant