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

Jump to bottom

doc/stdenv: put note about remote builds with breakpointHook into a <note> #61049

Merged
merged 1 commit into from May 7, 2019
Merged

doc/stdenv: put note about remote builds with breakpointHook into a <note> #61049

merged 1 commit into from May 7, 2019

Conversation

Ma27
Copy link
Member

@Ma27 Ma27 commented May 6, 2019 •
edited

Motivation for this change

With remote builds, the sandbox can't be accessed by cntr as it is on
a different machine. I decided to document this in the manual as it took
me admittedly too much time to figure this out.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

worldofpeace
worldofpeace reviewed May 6, 2019
View reviewed changes
doc/stdenv.xml Outdated Show resolved Hide resolved
@Ma27 Ma27 force-pushed the breakpoint-hook-remote-builds branch from c4371d4 to 23f3b4b Compare May 7, 2019 07:37
@Ma27
Copy link
Member Author

Ma27 commented May 7, 2019

@worldofpeace as this applies to release-19.03 as well I suggest we backport this, so this information is also available on the website's wiki :)

@worldofpeace
Copy link
Contributor

@worldofpeace as this applies to release-19.03 as well I suggest we backport this, so this information is also available on the website's wiki :)

Yeah, I think typically docs changes are good to backport if possible.

@worldofpeace worldofpeace added the 9.needs: port to stable A PR needs a backport to the stable release. label May 7, 2019
worldofpeace
worldofpeace reviewed May 7, 2019
View reviewed changes
doc/stdenv.xml Outdated Show resolved Hide resolved
@Ma27 Ma27 force-pushed the breakpoint-hook-remote-builds branch from 23f3b4b to f415573 Compare May 7, 2019 19:03
@worldofpeace
Copy link
Contributor

worldofpeace commented May 7, 2019 •
edited

I've rendered this and noticed there's a sentence that effectively says this but too subtle


Screenshot from 2019-05-07 15 29 05

I understood this with more clarity with your note


Screenshot from 2019-05-07 15 29 41

Perhaps you can remove the detail about remote builders in that sentence?

@Ma27
Copy link
Member Author

Ma27 commented May 7, 2019

Oh damn it, that also means that I overlooked it when I was reading the docs in the first place 😅

@Ma27 Ma27 force-pushed the breakpoint-hook-remote-builds branch from f415573 to 3ce9a1f Compare May 7, 2019 20:07
@Ma27
doc/stdenv: put note about remote builds with breakpointHook into a <…
0f9653f 
…note>

With remote builds, the sandbox can't be accessed by `cntr` as it is on
a different machine. I decided to put this into an extra `note` block as it took
me admittedly too much time to figure this out.
@Ma27 Ma27 force-pushed the breakpoint-hook-remote-builds branch from 3ce9a1f to 0f9653f Compare May 7, 2019 20:08
@Ma27 Ma27 changed the title doc/stdenv: add note about remote builds and breakpointHook doc/stdenv: put note about remote builds with breakpointHook into a <note> May 7, 2019
@Ma27
Copy link
Member Author

Ma27 commented May 7, 2019

fixed. And also modified the commit message accordingly.

@worldofpeace
Copy link
Contributor

Oh damn it, that also means that I overlooked it when I was reading the docs in the first place sweat_smile

Understandable, I almost missed it also. Plus with this we can tell how it disable it.

worldofpeace
worldofpeace approved these changes May 7, 2019
View reviewed changes
Copy link
Contributor

@worldofpeace worldofpeace left a comment

Choose a reason for hiding this comment

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

LGTM, everything was addressed that could be.

@worldofpeace worldofpeace merged commit 2d0f780 into NixOS:master May 7, 2019
@Ma27 Ma27 deleted the breakpoint-hook-remote-builds branch May 7, 2019 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@worldofpeace worldofpeace worldofpeace approved these changes

Assignees
No one assigned
Labels
8.has: documentation 9.needs: port to stable A PR needs a backport to the stable release. 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Ma27 @worldofpeace