From: aba Date: Sun, 12 Nov 2006 08:46:40 +0000 (+0000) Subject: not more than 20 lines for debconf X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=commitdiff_plain;h=4ea94d210240f45987db32eea1533bda8bc0a88b not more than 20 lines for debconf git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@3952 313b444b-1b9f-4f58-a734-7bb04f332e8d --- diff --git a/debian/changelog b/debian/changelog index 35972ef..4e2e0d2 100644 --- a/debian/changelog +++ b/debian/changelog @@ -23,6 +23,9 @@ developers-reference (3.3.8) unstable; urgency=low Thanks, Thijs Kinkhorst, Colin Tuckley, Russ Allbery. Closes: #368046, #378929, #361744 * add CVE Ids to your changelog. Closes: #376961 + * add reasoning why debconf questions shouldn't be longer than + 20 lines. Thanks, Thijs Kinkhorst, Christian Perrier, Russ Allbery. + Closes: #382477 -- Andreas Barth Sat, 11 Nov 2006 10:55:44 -0700 diff --git a/developers-reference.sgml b/developers-reference.sgml index ba27836..e55644d 100644 --- a/developers-reference.sgml +++ b/developers-reference.sgml @@ -7,7 +7,7 @@ %dynamicdata; - + @@ -4409,9 +4409,10 @@ The extended description should use complete sentences. Paragraphs should be kept short for improved readability. Do not mix two ideas in the same paragraph but rather use another paragraph.

-Don't be too verbose. Some debconf interfaces cannot deal very well -with descriptions of more than about 20 lines, so try to keep it below -this limit. +Don't be too verbose. User tend to ignore too long screens. +20 lines are by experience a border you shouldn't cross, +because that means that in the classical dialog interface, +people will need to scroll, and lot of people just don't do that.

For specific rules depending on templates type (string, boolean, etc.), please read below.