Clarify that bugs cannot contain multi-line descriptions
authorDieter Plaetinck <dieter@plaetinck.be>
Sun, 31 Oct 2010 08:45:45 +0000 (09:45 +0100)
committerChris Ball <cjb@laptop.org>
Sun, 31 Oct 2010 10:31:27 +0000 (06:31 -0400)
doc/tutorial.txt

index 0da1de2462b03e08f73ba69e34b33e1120ab5727..0154f5bed610ae51eea77c2ff438d872f290a19f 100644 (file)
@@ -132,10 +132,11 @@ of the ``--reporter`` option to give them credit::
 See ``be help new`` for more details.
 
 While the bug summary should include the appropriate keywords, it
-should also be brief.  You should probably add a comment immediately
-giving a more elaborate explanation of the problem so that the
-developer understands what you want and when the bug can be considered
-fixed.
+should also be brief.  Unlike other bug trackers, the bug itself cannot
+contain a multi-line description.  So you should probably add a comment
+immediately giving a more elaborate explanation of the problem so that
+the developer understands what you want and when the bug can be
+considered fixed.
 
 Commenting on bugs
 ------------------