Rev 5123: (mbp) developer docs on ui style in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 5123 [merge]
revision-id: pqm at pqm.ubuntu.com-20100330071430-oa8hvye603284qyg
parent: pqm at pqm.ubuntu.com-20100330051224-a8ubi9w2cd0upyb5
parent: mbp at sourcefrog.net-20100330031712-p1tbvvvw15skbrmq
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Tue 2010-03-30 08:14:30 +0100
message:
  (mbp) developer docs on ui style
modified:
  doc/developers/HACKING.txt     HACKING-20050805200004-2a5dc975d870f78c
=== modified file 'doc/developers/HACKING.txt'
--- a/doc/developers/HACKING.txt	2010-02-10 08:00:58 +0000
+++ b/doc/developers/HACKING.txt	2010-03-30 03:17:12 +0000
@@ -1020,11 +1020,29 @@
 finish the progress task when it exits, because it may otherwise be a long
 time until the finally block runs.
 
+
+Message guidelines
+------------------
+
+When filenames or similar variables are presented inline within a message,
+they should be enclosed in double quotes (ascii 0x22, not chiral unicode
+quotes)::
+
+  bzr: ERROR: No such file "asdf"
+
+When we print just a list of filenames there should not be any quoting:
+see `bug 544297`_.
+
+.. _bug 544297: https://bugs.launchpad.net/bugs/544297
+
 https://wiki.ubuntu.com/UnitsPolicy provides a good explanation about
 which unit should be used when. Roughly speaking, IEC standard applies
-for base-2 units and SI standard applies for base-10 units::
-* for network bandwidth an disk sizes, use base-10 (Mbits/s, kB/s, GB),
-* for RAM sizes, use base-2 (GiB, TiB).
+for base-2 units and SI standard applies for base-10 units:
+
+* for network bandwidth an disk sizes, use base-10 (Mbits/s, kB/s, GB)
+
+* for RAM sizes, use base-2 (GiB, TiB)
+
 
 
 Displaying help