← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/deadly-sins.txt

  • Committer: Vincent Ladeuil
  • Date: 2009-12-14 15:51:36 UTC
  • mto: (4894.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4895.
  • Revision ID: v.ladeuil+lp@free.fr-20091214155136-rf4nkqvxda9oiw4u
Cleanup tests and tweak the text displayed.

* bzrlib/tests/blackbox/test_update.py:
Fix imports and replace the assertContainsRe with assertEqualDiff
to make the test clearer, more robust and easier to debug.

* bzrlib/tests/commands/test_update.py: 
Fix imports.

* bzrlib/tests/blackbox/test_filtered_view_ops.py: 
Fix imports and strange accesses to base class methods.
(TestViewTreeOperations.test_view_on_update): Avoid os.chdir()
call, simplify string matching assertions.

* bzrlib/builtins.py:
(cmd_update.run): Fix spurious space, get rid of the final '/' for
the base path, don't add a final period (it's a legal char in a
path and would be annoying for people that like to copy/paste).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/deadly-sins.txt
1
 
**************************
2
 
Deadly sins in tool design
3
 
**************************
4
 
 
5
 
http://gcc.gnu.org/wiki/DeadlySins
6
 
 
7
 
They don't directly apply, but many do correspond.
8
 
 
9
 
  The "Deadly Sins" from P. J. Brown's *Writing Interactive Compilers and Interpreters*, Wiley 1979. We've committed them all at least once in GCC.
10
 
 
11
 
  The deadly sins are:
12
 
 
13
 
  1. to code before you think.
14
 
 
15
 
  2. to assume the user has all the knowledge the compiler writer has.
16
 
 
17
 
  3. to not write proper documentation.
18
 
 
19
 
  4. to ignore language standards.
20
 
 
21
 
  5. to treat error diagnosis as an afterthought.
22
 
 
23
 
  6. to equate the unlikely with the impossible.
24
 
 
25
 
  7. to make the encoding of the compiler dependent on its data formats.
26
 
 
27
 
  8. to use numbers for objects that are not numbers.
28
 
 
29
 
  9. to pretend you are catering to everyone at the same time.
30
 
 
31
 
  10. to have no strategy for processing break-ins.
32
 
 
33
 
      (A break-in is when you interrupt an interactive compiler, and
34
 
      then possibly continue it later. This is meaningful in an
35
 
      environment in which the compiler is run dynamically, such as
36
 
      many LISP and some BASIC environments. It is not meaningful for
37
 
      typical uses of C/C++ (although there was at least one
38
 
      interactive C environment, from Sabre).)
39
 
 
40
 
      (Perhaps this corresponds to handling user interrupts during
41
 
      operation -- they should not leave anything in an inconsistent
42
 
      state.)
43
 
 
44
 
  11. to rate the beauty of mathematics above the usability of your
45
 
      compiler.
46
 
 
47
 
  12. to let any error go undetected.
48
 
 
49
 
  13. to leave users to find the errors in your compiler.
50