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

Configuration+Build Changes and More Documentation for Obtaining the Library #1

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

vector-of-bool
Copy link
Collaborator

These changes introduce tweaks to the build process, as well as documentation changes that clarify the behavior regarding dependencies. The following changes are made:

  • Asio, Catch2, and neo-fun are now imported using FetchContent rather than with vcpkg. These components do not require any link-time dependencies in any projects that import amongoc.
  • Added a Fedora build target in the Earthfile. This will temporarily replace the RedHat target that fails.
  • Add Earthly capabilities to build using system packages rather than with vcpkg. This verifies that we can build on up-to-date platforms.
  • Document an issue related to the RedHat devtoolset.
  • Document that we are untested with MSVC and Windows.
  • Add a basic README. More details pending.

Copy link
Collaborator

@kevinAlbs kevinAlbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with adding a missing __install file. Suggested possible steps for a consumer project.

docs/ref/building.rst Outdated Show resolved Hide resolved
docs/ref/building.rst Outdated Show resolved Hide resolved
# Miscellaneous system init
INIT:
FUNCTION
COPY --chmod=755 tools/__install /usr/local/bin/__install
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tools/__install may be missing. Running earthly -a +build-debian/pkg deb-pkg resulted in:

+build-debian *failed* |           COPY tools/__install /usr/local/bin/__install
+build-debian *failed* |       failed: failed to walk /tmp/buildkit-mount4293366862/tools: lstat /tmp/buildkit-mount4293366862/tools: no such file or directory

README.md Outdated Show resolved Hide resolved
By default, the |amongoc| CMake package will attempt to import dependencies
using :cmake:command:`find_dependency <command:find_dependency>`. This import
can be disabled by changing :cmake:variable:`AMONGOC_FIND_DEPENDENCIES`.

**If you build** |amongoc| using vcpkg_ (the default) it is highly recommended
to use vcpkg in your own project to install |amongoc|'s dependencies, as it is
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a sample project with instructions to install amongoc and building a consumer with vcpkg. Example: https://gist.github.com/kevinAlbs/636fb109747ee4faba16def81c578a93 That may help give a fast-path to testing the driver.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look into this in subsequent changes.

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.

2 participants