[Reportbug-commits] r548 - in (trunk trunk/README.developers)

[bignose-guest at users.alioth.debian.org]

    Date: Sunday, June 22, 2008 @ 05:13:23
  Author: bignose-guest
Revision: 548

Document the source tree layout.

Modified:
  trunk/	(properties)
  trunk/README.developers


Property changes on: trunk
___________________________________________________________________
Name: bzr:revision-info
   - timestamp: 2008-06-20 19:43:49.430999994 +1000
committer: Ben Finney <ben+debian at benfinney.id.au>
properties: 
	branch-nick: reportbug.trunk

   + timestamp: 2008-06-22 15:13:01.459000111 +1000
committer: Ben Finney <ben+debian at benfinney.id.au>
properties: 
	branch-nick: reportbug.trunk

Name: bzr:revision-id:v3-trunk0
   - 5 ben at benfinney.id.au-20080504081108-ykaq013niveq5do4
6 ben at benfinney.id.au-20080504094936-i9nzchzppijemjel
7 ben at benfinney.id.au-20080504095004-vo7hae1dlvslyd3n
8 ben at benfinney.id.au-20080504095020-oednextpvn7t5rlu
9 ben at benfinney.id.au-20080504125948-1d4g9xepct6kvi0z
10 ben at benfinney.id.au-20080505220724-b7ukefql4qvpx1xw
11 ben at benfinney.id.au-20080507013031-erl1rubn3zy43kh1
12 ben at benfinney.id.au-20080507013710-oajkqze1er4rinls
13 ben at benfinney.id.au-20080507013915-1d5jewvzy941j453
14 ben at benfinney.id.au-20080507020935-m09yffl1on5ozaq0
20 ben at benfinney.id.au-20080509011507-nlyos9rk6v98z7gr
21 ben at benfinney.id.au-20080512042402-45bz136iaqqkso1m
22 ben at benfinney.id.au-20080512092913-hiqsjx1c4zne12ww
23 ben at benfinney.id.au-20080512134453-rk2z4cd96cj878gs
24 ben at benfinney.id.au-20080513090758-hjyz92rywt82hqiq
25 ben at benfinney.id.au-20080513123205-1owd1pz25e4hzo6l
26 ben at benfinney.id.au-20080513123517-khu4vub7y2zj5p8p
27 ben at benfinney.id.au-20080513134345-8973ffg30e04g3tu
28 ben at benfinney.id.au-20080514005413-5k4l7lw8e5vaq7e1
29 ben at benfinney.id.au-20080514005730-7glxrw4uzpkubnla
31 ben at benfinney.id.au-20080514131718-ntlmu9p75d47deip
32 ben at benfinney.id.au-20080514132358-uauqumygnnej6pjf
33 ben at benfinney.id.au-20080514132753-gav8kbe3dspapd7u
34 ben at benfinney.id.au-20080514133059-cy6u29i5moykrtnh
35 ben at benfinney.id.au-20080514133553-5widku0hx6nsff9d
36 ben at benfinney.id.au-20080514134337-n4oqeqmxoziqien1
37 ben at benfinney.id.au-20080515235707-onlz56zkx3x12i5r
38 ben at benfinney.id.au-20080516000116-t4vrd4o9i80bd0z5
42 ben at benfinney.id.au-20080519091300-2tkjv4jw6qrb86kh
43 ben at benfinney.id.au-20080520220815-s25jq1htw43z0p03
44 ben at benfinney.id.au-20080520221009-b9oy325k68s6qvo0
45 ben at benfinney.id.au-20080520221158-polu6p88z9o4vek2
46 ben at benfinney.id.au-20080520221519-1tml0hwsd1qku2sy
69 ben+debian at benfinney.id.au-20080612074858-jnkcbbl4pbjgdm4l
70 ben+debian at benfinney.id.au-20080615010748-jkvfjh5v343fic43
71 ben+debian at benfinney.id.au-20080615013432-5cib04snx3kw7ld8
72 ben+debian at benfinney.id.au-20080615015457-typdye8lub7o60ni
73 ben+debian at benfinney.id.au-20080615034123-yafapmxdntwsx23x
74 ben+debian at benfinney.id.au-20080615055311-2ebau3j0zqvny5r3
75 ben+debian at benfinney.id.au-20080615061738-eksd4xtmwy99wgwf
76 ben+debian at benfinney.id.au-20080615062842-aijpcia9hafw110x
77 ben+debian at benfinney.id.au-20080615070648-ijuzhq58m935y3cm
78 ben+debian at benfinney.id.au-20080615072705-2bxpn1lnrif25k5x
79 ben+debian at benfinney.id.au-20080615074730-2v9j4ozqbl02rhrj
80 ben+debian at benfinney.id.au-20080615074918-d7rq1dv6o8y47p7s
81 ben+debian at benfinney.id.au-20080615084002-d1q4qte57n0v9rpp
82 ben+debian at benfinney.id.au-20080615092649-6wxbxyzovkill4dk
83 ben+debian at benfinney.id.au-20080615095735-29ebi4gg9jjqq40q
84 ben+debian at benfinney.id.au-20080615113512-zh2drdguy0hb5ae3
86 ben+debian at benfinney.id.au-20080617141735-u2dsp144palhzcd7
88 ben+debian at benfinney.id.au-20080620094349-f0n3abicwbafev2p

   + 5 ben at benfinney.id.au-20080504081108-ykaq013niveq5do4
6 ben at benfinney.id.au-20080504094936-i9nzchzppijemjel
7 ben at benfinney.id.au-20080504095004-vo7hae1dlvslyd3n
8 ben at benfinney.id.au-20080504095020-oednextpvn7t5rlu
9 ben at benfinney.id.au-20080504125948-1d4g9xepct6kvi0z
10 ben at benfinney.id.au-20080505220724-b7ukefql4qvpx1xw
11 ben at benfinney.id.au-20080507013031-erl1rubn3zy43kh1
12 ben at benfinney.id.au-20080507013710-oajkqze1er4rinls
13 ben at benfinney.id.au-20080507013915-1d5jewvzy941j453
14 ben at benfinney.id.au-20080507020935-m09yffl1on5ozaq0
20 ben at benfinney.id.au-20080509011507-nlyos9rk6v98z7gr
21 ben at benfinney.id.au-20080512042402-45bz136iaqqkso1m
22 ben at benfinney.id.au-20080512092913-hiqsjx1c4zne12ww
23 ben at benfinney.id.au-20080512134453-rk2z4cd96cj878gs
24 ben at benfinney.id.au-20080513090758-hjyz92rywt82hqiq
25 ben at benfinney.id.au-20080513123205-1owd1pz25e4hzo6l
26 ben at benfinney.id.au-20080513123517-khu4vub7y2zj5p8p
27 ben at benfinney.id.au-20080513134345-8973ffg30e04g3tu
28 ben at benfinney.id.au-20080514005413-5k4l7lw8e5vaq7e1
29 ben at benfinney.id.au-20080514005730-7glxrw4uzpkubnla
31 ben at benfinney.id.au-20080514131718-ntlmu9p75d47deip
32 ben at benfinney.id.au-20080514132358-uauqumygnnej6pjf
33 ben at benfinney.id.au-20080514132753-gav8kbe3dspapd7u
34 ben at benfinney.id.au-20080514133059-cy6u29i5moykrtnh
35 ben at benfinney.id.au-20080514133553-5widku0hx6nsff9d
36 ben at benfinney.id.au-20080514134337-n4oqeqmxoziqien1
37 ben at benfinney.id.au-20080515235707-onlz56zkx3x12i5r
38 ben at benfinney.id.au-20080516000116-t4vrd4o9i80bd0z5
42 ben at benfinney.id.au-20080519091300-2tkjv4jw6qrb86kh
43 ben at benfinney.id.au-20080520220815-s25jq1htw43z0p03
44 ben at benfinney.id.au-20080520221009-b9oy325k68s6qvo0
45 ben at benfinney.id.au-20080520221158-polu6p88z9o4vek2
46 ben at benfinney.id.au-20080520221519-1tml0hwsd1qku2sy
69 ben+debian at benfinney.id.au-20080612074858-jnkcbbl4pbjgdm4l
70 ben+debian at benfinney.id.au-20080615010748-jkvfjh5v343fic43
71 ben+debian at benfinney.id.au-20080615013432-5cib04snx3kw7ld8
72 ben+debian at benfinney.id.au-20080615015457-typdye8lub7o60ni
73 ben+debian at benfinney.id.au-20080615034123-yafapmxdntwsx23x
74 ben+debian at benfinney.id.au-20080615055311-2ebau3j0zqvny5r3
75 ben+debian at benfinney.id.au-20080615061738-eksd4xtmwy99wgwf
76 ben+debian at benfinney.id.au-20080615062842-aijpcia9hafw110x
77 ben+debian at benfinney.id.au-20080615070648-ijuzhq58m935y3cm
78 ben+debian at benfinney.id.au-20080615072705-2bxpn1lnrif25k5x
79 ben+debian at benfinney.id.au-20080615074730-2v9j4ozqbl02rhrj
80 ben+debian at benfinney.id.au-20080615074918-d7rq1dv6o8y47p7s
81 ben+debian at benfinney.id.au-20080615084002-d1q4qte57n0v9rpp
82 ben+debian at benfinney.id.au-20080615092649-6wxbxyzovkill4dk
83 ben+debian at benfinney.id.au-20080615095735-29ebi4gg9jjqq40q
84 ben+debian at benfinney.id.au-20080615113512-zh2drdguy0hb5ae3
86 ben+debian at benfinney.id.au-20080617141735-u2dsp144palhzcd7
88 ben+debian at benfinney.id.au-20080620094349-f0n3abicwbafev2p
89 ben+debian at benfinney.id.au-20080622051301-9cden8n8w1syews1


Modified: trunk/README.developers
===================================================================
--- trunk/README.developers	2008-06-20 09:44:09 UTC (rev 547)
+++ trunk/README.developers	2008-06-22 05:13:23 UTC (rev 548)
@@ -107,6 +107,39 @@
 written using /bin/bash as their interpreter; for other shells or
 languages, you will need to write your own input parsing functions.
 
+Source layout
+=============
+
+The source tree for ``reportbug`` is organised this way:
+
+* Top level
+
+  * Programs (e.g. ``reportbug``, ``querybts``, etc.).
+
+  * Python library modules, used by the programs.
+
+  * Manual pages.
+
+* Debian packaging
+
+  * ``debian/`` contains the control files used to build the Debian
+    source and binary packages.
+
+* `Unit testing framework`_
+
+  * ``test/`` contains the unit test suite. Unit test modules are
+    discovered and run using the ``nosetests`` program, and are named
+    as ``test_*.py``.
+
+* ?? TODO: describe the purpose
+
+  * ``checks/`` contains ???
+
+* Internationalisation and localisation
+
+  * ``po4a/`` contains configuration and data for localisation of
+    source files using the ``po4a`` tool.
+
 Unit testing framework
 ======================