summary refs log tree commit diff
path: root/doc/coding-conventions.xml
diff options
context:
space:
mode:
authorLorenzo Manacorda <lorenzo@mailbox.org>2017-01-30 11:28:52 +0100
committerGitHub <noreply@github.com>2017-01-30 11:28:52 +0100
commit4e0bb261d0f9cde1075cffb98dc14f63ee44ea91 (patch)
treea1ad77fa972663f27b51daa66f01dc5c1295e52f /doc/coding-conventions.xml
parent92a3ecf4a30d6f82e7ca6d97ff9feb7ef67bc1b2 (diff)
downloadnixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar.gz
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar.bz2
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar.lz
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar.xz
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.tar.zst
nixlib-4e0bb261d0f9cde1075cffb98dc14f63ee44ea91.zip
Make more visible which fetch approach is best
Prepend "bad/better/best" to each paragraph, to make more visible which approach is best
Diffstat (limited to 'doc/coding-conventions.xml')
-rw-r--r--doc/coding-conventions.xml6
1 files 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";