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

extract reference documentation on remote builds #9526

Merged

Conversation

fricklerhandwerk
Copy link
Contributor

Motivation

#9202 (comment)

Context

This is a large diff, but in essence it does this:

  • move all reference documentation to the builders configuration setting
  • reword documentation on machine specification, add examples
  • disable showing the default value, as it rendered as @/dummy/machines, which is wrong
  • highlight the examples
  • link to the configuration docs for distributed builds

This work is sponsored by Antithesis

Priorities

Add 👍 to pull requests you find important.

Copy link
Member

@Janik-Haag Janik-Haag left a comment

Choose a reason for hiding this comment

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

Is there a way of rendering these changes locally, reading the diff github produces is a bit hard, I would gladly help reviewing this.

doc/manual/src/advanced-topics/distributed-builds.md Outdated Show resolved Hide resolved
@fricklerhandwerk
Copy link
Contributor Author

No, unfortunately still, you have to go through the whole build process locally to produce a rendering. Run make manual-html when following build instructions. It requires building all of Nix, so it will take a while.

- move all reference documentation to the `builders` configuration setting
- reword documentation on machine specification, add examples
- disable showing the default value, as it rendered as `@/dummy/machines`, which is wrong
- highlight the examples
- link to the configuration docs for distributed builds
- builder -> build machine
@fricklerhandwerk
Copy link
Contributor Author

fricklerhandwerk commented Jan 27, 2024

The speed factor changed from int to float in #9841, and this is not accounted for here because I'm not sure this is a good idea #9841 (comment). I suggest merging as is and resolving that before the next release.

@fricklerhandwerk fricklerhandwerk merged commit fd82ba0 into NixOS:master Feb 13, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants