Skip to content

C API: Add section in Nix manual#10519

Merged
roberth merged 2 commits into
NixOS:masterfrom
tweag:jl/c-api_docs
Apr 17, 2024
Merged

C API: Add section in Nix manual#10519
roberth merged 2 commits into
NixOS:masterfrom
tweag:jl/c-api_docs

Conversation

@jlesquembre

Copy link
Copy Markdown
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.

@jlesquembre jlesquembre requested a review from edolstra as a code owner April 16, 2024 13:51
@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

@roberth roberth left a comment

Copy link
Copy Markdown
Member

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.

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

Copy link
Copy Markdown
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.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
@roberth roberth merged commit 1f1cd97 into NixOS:master Apr 17, 2024
@roberth

roberth commented Apr 17, 2024

Copy link
Copy Markdown
Member

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