From 9f7fe353b613d0e45d7a5cdbd1f13c96c15803dd Mon Sep 17 00:00:00 2001 From: DrRuhe Date: Thu, 8 Sep 2022 11:17:36 +0200 Subject: [PATCH] docs: replace use of `#` by `$ sudo` The hope is that this makes it more obvious that these commands should be run as the root user. --- docs/installation.adoc | 14 +++++++------- docs/manual.xml | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/installation.adoc b/docs/installation.adoc index 49ea358e8..1862f6168 100644 --- a/docs/installation.adoc +++ b/docs/installation.adoc @@ -124,21 +124,21 @@ deployed through NixOps. To make the NixOS module available for use you must `import` it into your system configuration. This is most conveniently done by adding a -Home Manager channel. For example, if you are following Nixpkgs master -or an unstable channel, you can run +Home Manager channel to the root user. For example, if you are +following Nixpkgs master or an unstable channel, you can run [source,console] ---- -# nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager -# nix-channel --update +$ sudo nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager +$ sudo nix-channel --update ---- and if you follow a Nixpkgs version 22.05 channel, you can run [source,console] ---- -# nix-channel --add https://github.com/nix-community/home-manager/archive/release-22.05.tar.gz home-manager -# nix-channel --update +$ sudo nix-channel --add https://github.com/nix-community/home-manager/archive/release-22.05.tar.gz home-manager +$ sudo nix-channel --update ---- It is then possible to add @@ -161,7 +161,7 @@ home-manager.users.eve = { pkgs, ... }: { }; ---- -and after a `nixos-rebuild switch` the user eve's environment should +and after a `sudo nixos-rebuild switch` the user eve's environment should include a basic Bash configuration and the packages atool and httpie. [NOTE] diff --git a/docs/manual.xml b/docs/manual.xml index 375a9694c..b159940c8 100644 --- a/docs/manual.xml +++ b/docs/manual.xml @@ -24,7 +24,7 @@ - Commands prefixed with # have to be run as root, either + Commands prefixed with $ sudo have to be run as root, either requiring to login as root user or temporarily switching to it using sudo for example.