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.

Sign up for GitHub

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

Jump to bottom

C API: Add libflake-c (backport #11940) #11949

Closed
wants to merge 6 commits into from
Closed

C API: Add libflake-c (backport #11940) #11949

wants to merge 6 commits into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Nov 25, 2024

Motivation

Nix 2.24's C API is currently incapable of providing flake functionality, because libflake wasn't wrapped before #9063

This PR provides a very basic libflake that restores builtins.getFlake. (a feature compensating for a regression)

Context

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

This is an automatic backport of pull request #11940 done by [Mergify](https://mergify.com).

@roberth @mergify
libexpr-c: Add nix_eval_state_builder
ba06199 
(cherry picked from commit 82a23d9)
@roberth @mergify
Doc nix_get_path_string
0b25d1a 
(cherry picked from commit 1bd7517)
@roberth @mergify
refactor: Extract unsafe_new_with_self
66176cf 
(cherry picked from commit f06f611)
@roberth @mergify
Add nix-flake-c, nix_flake_init_global, nix_flake_settings_new
b72982d 
(cherry picked from commit 4eecf3c)

# Conflicts:
#	packaging/components.nix
#	packaging/everything.nix
#	tests/unit/libflake/nix_api_flake.cc
@roberth @mergify
test: Change FAIL to throw
e7104b1 
[FAIL()] is a macro with `return`, making it unsuitable for helpers.

This uses std::runtime_error, because gtest does not seem to provide an
exception type of its own for this purpose. [AssertionException] is for
a different use case.

[FAIL()]: https://google.github.io/googletest/reference/assertions.html#FAIL
[AssertionException]: https://github.com/google/googletest/blob/35d0c365609296fa4730d62057c487e3cfa030ff/docs/reference/testing.md#assertionexception-assertionexception

(cherry picked from commit d004c52)

# Conflicts:
#	src/libutil-test-support/tests/gtest-with-params.hh
@roberth @mergify
.github/ci: Set max-jobs to 1, to reduce peak memory usage
246ce32 
(cherry picked from commit 6db6b26)
@mergify mergify bot requested a review from edolstra as a code owner November 25, 2024 09:02
@mergify Mergify
Copy link
Contributor Author

mergify bot commented Nov 25, 2024

Cherry-pick of 4eecf3c has failed:

On branch mergify/bp/2.24-maintenance/pr-11940
Your branch is ahead of 'origin/2.24-maintenance' by 3 commits.
  (use "git push" to publish your local commits)

You are currently cherry-picking commit 4eecf3c20.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   meson.build
	modified:   src/external-api-docs/doxygen.cfg.in
	modified:   src/external-api-docs/package.nix
	new file:   src/libflake-c/.version
	new file:   src/libflake-c/build-utils-meson
	new file:   src/libflake-c/meson.build
	new file:   src/libflake-c/nix_api_flake.cc
	new file:   src/libflake-c/nix_api_flake.h
	new file:   src/libflake-c/nix_api_flake_internal.hh
	new file:   src/libflake-c/package.nix
	modified:   tests/unit/libflake/meson.build
	modified:   tests/unit/libflake/package.nix

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   packaging/components.nix
	deleted by us:   packaging/everything.nix
	added by them:   tests/unit/libflake/nix_api_flake.cc

Cherry-pick of d004c52 has failed:

On branch mergify/bp/2.24-maintenance/pr-11940
Your branch is ahead of 'origin/2.24-maintenance' by 4 commits.
  (use "git push" to publish your local commits)

You are currently cherry-picking commit d004c524b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   tests/unit/libutil-support/tests/nix_api_util.hh

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   src/libutil-test-support/tests/gtest-with-params.hh

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@github-actions github-actions bot added with-tests Issues related to testing. PRs with tests have some priority c api Nix as a C library with a stable interface labels Nov 25, 2024
@edolstra
Copy link
Member

Generally we don't backport features (only bug fixes), especially when they're big (this is a 23-file diff).

@edolstra edolstra closed this Nov 25, 2024
@edolstra edolstra mentioned this pull request Nov 26, 2024
Closed
@roberth
Copy link
Member

roberth commented Nov 26, 2024

Without this, flakes can't be used through the C API. This is a fix for a regression in the shape of a feature; not just a new feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edolstra edolstra Awaiting requested review from edolstra edolstra is a code owner

Assignees
No one assigned
Labels
c api Nix as a C library with a stable interface conflicts merge-queue with-tests Issues related to testing. PRs with tests have some priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@edolstra @roberth