summary refs log tree commit diff
path: root/doc/coding-conventions.xml
diff options
context:
space:
mode:
authorArseniy Seroka <jagajaga@users.noreply.github.com>2015-05-21 19:57:53 +0300
committerArseniy Seroka <jagajaga@users.noreply.github.com>2015-05-21 19:57:53 +0300
commit4e838ed30352bca8708db14e25808da022e51e1f (patch)
treecf21d5dc3f36a1d29d25f63ac84007bace19ad5b /doc/coding-conventions.xml
parentf3867899ee48b679f9a1d43fccef1679039b7644 (diff)
parent83434becf0f9aec303cc8947d87a25040af2ff9d (diff)
downloadnixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar.gz
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar.bz2
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar.lz
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar.xz
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.tar.zst
nixlib-4e838ed30352bca8708db14e25808da022e51e1f.zip
Merge pull request #6539 from jagajaga/documentation
add information about git-based pkgs
Diffstat (limited to 'doc/coding-conventions.xml')
-rw-r--r--doc/coding-conventions.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/coding-conventions.xml b/doc/coding-conventions.xml
index e1853d47ce05..68b075959c9c 100644
--- a/doc/coding-conventions.xml
+++ b/doc/coding-conventions.xml
@@ -256,6 +256,12 @@ bound to the variable name <varname>e2fsprogs</varname> in
   a package named <literal>hello-svn</literal> by
   <command>nix-env</command>.</para></listitem>
 
+  <listitem><para>If package is fetched from git's commit then
+  the version part of the name <emphasis>must</emphasis> be the date of that 
+  (fetched) commit. The date must be in <literal>"YYYY-MM-DD"</literal> format.
+  Also add <literal>"git"</literal> to the name - e.g.,
+  <literal>"pkgname-git-2014-09-23"</literal>.</para></listitem>
+
   <listitem><para>Dashes in the package name should be preserved
   in new variable names, rather than converted to underscores
   (which was convention up to around 2013 and most names