← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Jelmer Vernooij
  • Date: 2010-04-30 11:35:43 UTC
  • mfrom: (5195 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100430113543-tiqqhmqa3d8no4iu
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/HACKING.txt
1020
1020
finish the progress task when it exits, because it may otherwise be a long
1021
1021
time until the finally block runs.
1022
1022
 
 
1023
 
 
1024
Message guidelines
 
1025
------------------
 
1026
 
 
1027
When filenames or similar variables are presented inline within a message,
 
1028
they should be enclosed in double quotes (ascii 0x22, not chiral unicode
 
1029
quotes)::
 
1030
 
 
1031
  bzr: ERROR: No such file "asdf"
 
1032
 
 
1033
When we print just a list of filenames there should not be any quoting:
 
1034
see `bug 544297`_.
 
1035
 
 
1036
.. _bug 544297: https://bugs.launchpad.net/bugs/544297
 
1037
 
1023
1038
https://wiki.ubuntu.com/UnitsPolicy provides a good explanation about
1024
1039
which unit should be used when. Roughly speaking, IEC standard applies
1025
 
for base-2 units and SI standard applies for base-10 units::
1026
 
* for network bandwidth an disk sizes, use base-10 (Mbits/s, kB/s, GB),
1027
 
* for RAM sizes, use base-2 (GiB, TiB).
 
1040
for base-2 units and SI standard applies for base-10 units:
 
1041
 
 
1042
* for network bandwidth and disk sizes, use base-10 (Mbits/s, kB/s, GB)
 
1043
 
 
1044
* for RAM sizes, use base-2 (GiB, TiB)
 
1045
 
1028
1046
 
1029
1047
 
1030
1048
Displaying help
1035
1053
and on other help topics.  (See ``help_topics.py``.)
1036
1054
 
1037
1055
As for python docstrings, the first paragraph should be a single-sentence
1038
 
synopsis of the command.
 
1056
synopsis of the command. These are user-visible and should be prefixed with
 
1057
``__doc__ =`` so help works under ``python -OO`` with docstrings stripped.
1039
1058
 
1040
1059
The help for options should be one or more proper sentences, starting with
1041
1060
a capital letter and finishing with a full stop (period).