Skip to content

Commit

Permalink
Make more visible which fetch approach is best
Browse files Browse the repository at this point in the history
Prepend "bad/better/best" to each paragraph, to make more visible which approach is best

(cherry picked from commit 4e0bb26)
  • Loading branch information
asymmetric authored and Mic92 committed Feb 22, 2017
1 parent 43241e7 commit cac0a75
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/coding-conventions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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";
Expand All @@ -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";
Expand Down

0 comments on commit cac0a75

Please sign in to comment.