Skip to content

Document string context#8595

Merged
fricklerhandwerk merged 5 commits intoNixOS:masterfrom
obsidiansystems:addDrvOutputDependencies
May 8, 2024
Merged

Document string context#8595
fricklerhandwerk merged 5 commits intoNixOS:masterfrom
obsidiansystems:addDrvOutputDependencies

Conversation

@Ericson2314
Copy link
Member

@Ericson2314 Ericson2314 commented Jun 27, 2023

Motivation

Now what we have enough primops, we can document how string contexts work.

Context

Progress towards #7910.

Depends on #9168
Depends on #9216

Checklist for maintainers

Maintainers: tick if completed or explain if not relevant

  • agreed on idea
  • agreed on implementation strategy
  • tests, as appropriate
    • functional tests - tests/**.sh
    • unit tests - src/*/tests
    • integration tests - tests/nixos/*
  • documentation in the manual
  • documentation in the internal API docs
  • code and comments are self-explanatory
  • commit message explains why the change was made
  • new feature or incompatible change: updated release notes

Priorities

Add 👍 to pull requests you find important.

@Ericson2314 Ericson2314 requested a review from roberth June 27, 2023 16:18
@github-actions github-actions bot added the tests label Jun 27, 2023
@Ericson2314 Ericson2314 force-pushed the addDrvOutputDependencies branch 2 times, most recently from 1e5d5a7 to 3438db9 Compare June 27, 2023 16:26
@roberth roberth added the language The Nix expression language; parser, interpreter, primops, evaluation, etc label Jul 1, 2023
@Ericson2314 Ericson2314 marked this pull request as ready for review July 9, 2023 18:34
@Ericson2314 Ericson2314 requested a review from edolstra as a code owner July 9, 2023 18:34
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.

  • Check that it's .drv
  • Docs need some work

@github-actions github-actions bot added the with-tests Issues related to testing. PRs with tests have some priority label Jul 14, 2023
@Ericson2314 Ericson2314 force-pushed the addDrvOutputDependencies branch from 38040f8 to 8324fd8 Compare July 17, 2023 13:54
@Ericson2314 Ericson2314 marked this pull request as draft July 17, 2023 13:54
@edolstra
Copy link
Member

edolstra commented Aug 4, 2023

Can you add a description of what the primop does to the PR motivation?

@roberth
Copy link
Member

roberth commented Aug 4, 2023

Can you add a description of what the primop does to the PR motivation?

I've added the three lines at the start.

@Ericson2314
Copy link
Member Author

Triaged in the Nix Team meeting this morning (n.b. I could not make it):

  • Needs to explain what it's about in the PR description
    • @roberth has the context and can do, and now has done so.
  • Also needs to be discussed with the Nixpkgs architecture team to see whether they actually want that

Queued for discussion

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-08-08-nixpkgs-architecture-team-meeting-42/31454/1

@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-08-04-nix-team-meeting-minutes-77/31487/1

@Ericson2314 Ericson2314 force-pushed the addDrvOutputDependencies branch from 8324fd8 to d934667 Compare October 13, 2023 05:06
@Ericson2314 Ericson2314 marked this pull request as ready for review October 13, 2023 05:06
@thufschmitt thufschmitt self-assigned this Oct 13, 2023
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-10-23-nix-team-meeting-minutes-97/34561/1

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

@Ericson2314 do you need help with that? I could quickly take it over if you like, as I have enough context and ideas to finish it. I need a bit more time to ramp up with the your store docs PRs.

@Ericson2314
Copy link
Member Author

Ericson2314 commented Nov 8, 2023

@fricklerhandwerk I think it would be good to do the a deriving path page first, and then you take this over (and some things here can just reference that rather than include redundant material).

@Ericson2314
Copy link
Member Author

Draft because I wanted deriving paths to be documented first

Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

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

I think it's pretty useful the way it is. In fact we could already add the glossary entry on deriving paths independently. If you want I can pick up the string contexts part from there and implement the suggestions myself.

Now what we have enough primops, we can document how string contexts
work.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Felix Uhl <iFreilicht@users.noreply.github.com>
@fricklerhandwerk fricklerhandwerk marked this pull request as ready for review May 8, 2024 20:25
@fricklerhandwerk fricklerhandwerk merged commit b560521 into NixOS:master May 8, 2024
pull bot pushed a commit to auxolotl/nix that referenced this pull request May 9, 2024
* Document string context

Now what we have enough primops, we can document how string contexts
work.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Co-authored-by: Théophane Hufschmitt <7226587+thufschmitt@users.noreply.github.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Felix Uhl <iFreilicht@users.noreply.github.com>
@nixos-discourse
Copy link

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2024-05-08-nix-team-meeting-minutes-144/45349/1

@Ericson2314 Ericson2314 deleted the addDrvOutputDependencies branch April 18, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation language The Nix expression language; parser, interpreter, primops, evaluation, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants