From 4e0bb261d0f9cde1075cffb98dc14f63ee44ea91 Mon Sep 17 00:00:00 2001 From: Lorenzo Manacorda <lorenzo@mailbox.org> Date: Mon, 30 Jan 2017 11:28:52 +0100 Subject: [PATCH] Make more visible which fetch approach is best Prepend "bad/better/best" to each paragraph, to make more visible which approach is best --- doc/coding-conventions.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml index 4348dc8bf720..f89437af445c 100644 --- a/doc/coding-conventions.xml +++ b/doc/coding-conventions.xml @@ -623,7 +623,7 @@ evaluate correctly.</para> from bad to good: <itemizedlist> <listitem> - <para>Uses <literal>git://</literal> which won't be proxied. + <para>Bad: Uses <literal>git://</literal> which won't be proxied. <programlisting> src = fetchgit { url = "git://github.com/NixOS/nix.git"; @@ -634,7 +634,7 @@ src = fetchgit { </para> </listitem> <listitem> - <para>This is ok, but an archive fetch will still be faster. + <para>Better: This is ok, but an archive fetch will still be faster. <programlisting> src = fetchgit { url = "https://github.com/NixOS/nix.git"; @@ -645,7 +645,7 @@ src = fetchgit { </para> </listitem> <listitem> - <para>Fetches a snapshot archive and you get the rev you want. + <para>Best: Fetches a snapshot archive and you get the rev you want. <programlisting> src = fetchFromGitHub { owner = "NixOS";