JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

svn path=/nixpkgs/trunk/; revision=14311

Browse Source
This commit is contained in:
Eelco Dolstra 2009-03-03 13:47:46 +00:00
parent fcad0b0a5a
commit 94b0227aad
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/meta.xml
View File

@ -64,10 +64,18 @@ interpretation:</para>
<varlistentry>
<term><varname>description</varname></term>
<listitem><para>A short (one-line) description of the package.
Don’t include a period at the end. This is shown by
<command>nix-env -q --description</command> and also on the
Nixpkgs release pages. Example: <literal>"A program that produces
a familiar, friendly greeting"</literal></para></listitem>
This is shown by <command>nix-env -q --description</command> and
also on the Nixpkgs release pages.</para>
<para>Don’t include a period at the end. Don’t include newline
characters. Capitalise the first character. For brevity, don’t
repeat the name of package — just describe what it does.</para>
<para>Wrong: <literal>"libpng is a library that allows you to decode PNG images."</literal></para>
<para>Right: <literal>"A library for decoding PNG images"</literal></para>
</listitem>
</varlistentry>
<varlistentry>