[Nix Docs] Remind user to restart terminal
ClosedPublic
Actions

Authored by • jon on Nov 28 2022, 9:56 AM.

Details

Reviewers

ashoat
varun

Commits

rCOMM651894b3d645: [Nix Docs] Remind user to restart terminal

Summary

Make it clear in documentation that the terminal should be restarted
or a new terminal should be opened to apply nix changes. This is needed so that
the nix changes can be sourced and applied to the new session.

The install script from nix also emits this advice. However, that output gets pushed
up severely by all of the output we emit when adding defaults to /etc/nix.conf

Although it's possible to source a file, the file location seems to be
dependent on how nix was installed.

https://linear.app/comm/issue/ENG-2358

Test Plan

N/A

Diff Detail

Repository

rCOMM Comm

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

• jon created this revision.Nov 28 2022, 9:56 AM

Herald added subscribers: atul, tomek. · View Herald TranscriptNov 28 2022, 9:56 AM

Harbormaster completed remote builds in B13796: Diff 18887.Nov 28 2022, 10:09 AM

• jon requested review of this revision.Nov 28 2022, 10:09 AM

ashoat requested changes to this revision.Nov 28 2022, 12:09 PM

ashoat added inline comments.

docs/nix_dev_env.md
44 ↗	(On Diff #18887)	This language seems to apply that the user needs to do something after opening the new terminal in order to "apply changes". It's always best to look for previous examples whenever changing the docs... in this case, try searching for "Now either close and reopen your terminal window or re-source your shell configuration file in order to" (It's long enough that I would put that line outside of the code block here)