From 12e7698a651b45e9c9a98b8a67ba6472f22d713d Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Mon, 22 Mar 2021 21:15:11 +0100 Subject: [PATCH 1/2] nixos/doc/manual/Makefile: Do not format Formatting has been neglected. Running `make` would format dozens of files, which is a great way of scaring away newcomers and those with less git experience. It would also annoy the heck out of regular contributors. The purpose of formatting is to avoid a small annoyance, so it should not become a big annoyance that makes people give up on their work. --- nixos/doc/manual/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nixos/doc/manual/Makefile b/nixos/doc/manual/Makefile index b86a76005753..b2b6481b20c7 100644 --- a/nixos/doc/manual/Makefile +++ b/nixos/doc/manual/Makefile @@ -1,5 +1,5 @@ .PHONY: all -all: manual-combined.xml format +all: manual-combined.xml .PHONY: debug debug: generated manual-combined.xml From 2f7be87a8abd8d1617087457a7bef53829072aad Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Mon, 22 Mar 2021 21:11:19 +0100 Subject: [PATCH 2/2] nixos/doc: Update Writing Documentation to use nix-shell --- nixos/doc/manual/development/writing-documentation.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index 32e00544ceff..89fab6665616 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -25,7 +25,8 @@ $ cd /path/to/nixpkgs/nixos/doc/manual -$ make +$ nix-shell +nix-shell$ make