[game-data-packager] 01/01: license flag: update documentation

[Alexandre Detiste]

This is an automated email from the git hooks/post-receive script.

detiste-guest pushed a commit to branch master
in repository game-data-packager.

commit b250d73c9eb40209e045705d97fe4e401cc2cd76
Author: Alexandre Detiste <alexandre.detiste at gmail.com>
Date:   Tue Mar 3 12:01:39 2015 +0100

    license flag: update documentation
---
 doc/adding_a_game.mdwn | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/adding_a_game.mdwn b/doc/adding_a_game.mdwn
index b2401de..fc51f0d 100644
--- a/doc/adding_a_game.mdwn
+++ b/doc/adding_a_game.mdwn
@@ -44,6 +44,9 @@ a mapping from unique name to a mapping:
   matches this file's `look_for` names, but which do not match this file
   by size or hashes, do not provoke a warning. Use this for files with
   generic names like `README.TXT`.
+* `license`: boolean, default false: if true, it is listed as a license
+  file in generated copyright file.
+  Per policy, license files should go in $docdir. (see `install_to`).
 * `download`: string or mapping: where to download this file. FIXME: explain
 * `provides`: list of strings: unique names of some known files that can be
   unpacked or extracted from this one
@@ -62,6 +65,8 @@ a mapping from unique name to a mapping:
   being installed under the name of the alternative set.
 * `install_as`: string: when installing this file in a package, use this name
   instead of its own.
+* `install_to`: string: overide location where to install this file,
+  the special value $docdir will be expanded to /usr/share/doc/<package_name/.
 * `look_for`: list of strings: when searching for this file, look for
   these names (case-insensitively). The default is a list containing only
   the unique name.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/game-data-packager.git