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

C API: Add section in Nix manual #10519

Merged
merged 2 commits into from
Apr 17, 2024
Merged

C API: Add section in Nix manual #10519

merged 2 commits into from
Apr 17, 2024

Conversation

jlesquembre
Copy link
Member

Motivation

Add section in the Nix manual about the C API.

Related to #10500

Context

Stabilize the C interface introduced in #8699

Milestone: https://github.com/NixOS/nix/milestone/52

Priorities and Process

Add 👍 to pull requests you find important.

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

@edolstra edolstra requested a review from roberth April 17, 2024 10:18
@roberth roberth added documentation c api Nix as a C library with a stable interface labels Apr 17, 2024
Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

Small fix, but otherwise LGTM.

doc/manual/src/contributing/documentation.md Outdated Show resolved Hide resolved
Comment on lines +212 to +213
[C API documentation] is available online.
You can also build and view it yourself:
Copy link
Member

Choose a reason for hiding this comment

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

Would be good to also have this info in a more visible place, but that's not required for this PR necessarily.

@roberth roberth merged commit 1f1cd97 into NixOS:master Apr 17, 2024
8 of 9 checks passed
@roberth
Copy link
Member

roberth commented Apr 17, 2024

Thanks!

@jlesquembre jlesquembre deleted the jl/c-api_docs branch April 17, 2024 13:26
@roberth roberth added this to the Stable C API milestone Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c api Nix as a C library with a stable interface documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants