← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/HACKING.txt

  • Committer: Robert Collins
  • Date: 2010-02-28 10:08:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5062.
  • Revision ID: robertc@robertcollins.net-20100228100829-nroa3qp8zi8jwxke
* bzr now has a ``.testr.conf`` file in its source tree configured
  appropriately for running tests with Testrepository
  (``https://launchpad.net/testrepository``). (Robert Collins)

* Documentation about testing with ``subunit`` has been tweaked.
  (Robert Collins)

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
 
 
1038
1023
https://wiki.ubuntu.com/UnitsPolicy provides a good explanation about
1039
1024
which unit should be used when. Roughly speaking, IEC standard applies
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
 
 
 
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).
1046
1028
 
1047
1029
 
1048
1030
Displaying help
1053
1035
and on other help topics.  (See ``help_topics.py``.)
1054
1036
 
1055
1037
As for python docstrings, the first paragraph should be a single-sentence
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.
 
1038
synopsis of the command.
1058
1039
 
1059
1040
The help for options should be one or more proper sentences, starting with
1060
1041
a capital letter and finishing with a full stop (period).