Mercurial > p > roundup > code

annotate doc/FAQ.txt @ 686:c52122f38c9b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation cleanup, added info for potential (and current) developers
author Richard Jones <richard@users.sourceforge.net>
date Wed, 10 Apr 2002 23:55:36 +0000
parents e429649ed124
children b38f4f95bffd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
1 Roundup FAQ
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
2 ===========
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
4 :Version: $Revision: 1.8 $
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
5
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
6 NOTE: This is just a grabbag, most of this should go into documentation.
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
8 .. contents::
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
9
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
10
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 Changing HTML layout
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
12 --------------------
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
14 Note changes to the files in html take place immediatly without
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
15 restart, even when running roundup-server.
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
16
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
17 Displaying whole messages not only the summary
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
18 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
19
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
20 Modify instance/html/msg.index change::
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
21
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
22 <td><display call="plain('summary')"></td>
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
23
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
24 to::
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
25
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
26 <td><pre><display call="plain('content')"></pre></td>
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
27
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
28 displays the whole message not only the first line and 'pre'
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
29 prevents the browser from reformatting.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
30
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
31 Getting the nosy list picker instead of textfield
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
34 In classic template there is plenty of space below the text field.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
35 So one could modify instance/html/issue.item to use it.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
36
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
37 At the file top set 'border=1' to see cell boundaries, then
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
38 replace::
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
40 <td class="form-text"><display call="field('nosy',size=20)"></td>
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
41
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
42 by::
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
43
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
44 <td rowspan=5 class="form-text"><display call="menu('nosy',height=10)"></td>
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
45
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
46 and remove the last cell in the next four rows, either by deleting a cell
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
47 or by reducing colspan.
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
49 Want to see the issue id (the number) on the issue item display
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
51
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
52 The number is really a central information and not an internal one.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
53
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
54 In file INSTANCE/html/issue.item displays the creator, so one could add
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
55 the number to it.::
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
56
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
57 <td class="form-text"><display call="reldate('creation', pretty=1)">
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
58 (<display call="plain('creator')">)</td>
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
59
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
60 to see::
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
61
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
62 <td class="form-text"><display call="reldate('creation', pretty=1)">
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
63 (issue<display call="plain('id')"> by <display call="plain('creator')">)</td>
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
65 Installation
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
66 ------------
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
67
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
68 Living without a mailserver.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
70
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
71 Remove the nosy reactor, means delete the file
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
72 'INSTANCE/detectors/nosyreactor.py'.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
73
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
75 Rights issues (MISSING)
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
76 ~~~~~~~~~~~~~~~~~~~~~~~
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
77
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
78 Different jobs run under different users.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
79
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
80 * Standalone roundup-server is started by whome ?
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
81
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
82 * Running cgi under apache.
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
83
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
84 * roundup-mailgw called via .forward from MTA, or running a cron job
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
85 fetching via pop.
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
86
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
87 see Troubleshooting_.
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
88
589
28debb477133 spelling, formatting...
Richard Jones <richard@users.sourceforge.net>
parents: 583
diff changeset
89
610
8ba4f914de83 reformatted for stx processing.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 596
diff changeset
90 Troubleshooting
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
91 ---------------
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
93 AttributeError: '_roundup_instance_1' module has no attribute 'open'
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
95
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
96 For example submitting issues via roundup-mailgw breaks similar to this::
551
fa23796baf7b moving FAQ.txt to doc directory
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
98 Command died with status 1:
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
99 "/usr/local/bin/python /usr/local/bin/roundup-mailgw /home/roundup".
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
100 Command output: Traceback (most recent call last):
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
101 File "/usr/local/bin/roundup-mailgw", line 178, in ?
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
102 sys.exit(main(sys.argv))
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
103 File "/usr/local/bin/roundup-mailgw", line 153, in main
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
104 db = instance.open('admin')
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
105 AttributeError: '_roundup_instance_1' module has no attribute 'open'
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
106
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
107 Happens if the user which accesses the instance has no read right
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
108 on 'INSTANCE/dbinit.py' or 'pyc'.
583
dbcd04d4dd92 another sample in FAQ.txt.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 551
diff changeset
109
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
110 If the user has no rights on the 'INSTANCE/db' the mailgw finishes,
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
111 but is, of course, unable to add the message. A notification to
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
112 the roundup-admin is sent, with a longer trace ending in::
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
113
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
114 File "/opt/python/lib/python2.2/dbhash.py", line 16, in open
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
115 return bsddb.hashopen(file, flag, mode)
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
116 error: (13, 'Keine Berechtigung')
611
74a7d06449bf more detail on failing open.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 610
diff changeset
117
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
118 Replace 'Keine Berechtigung' by 'Not permitted' or ...
583
dbcd04d4dd92 another sample in FAQ.txt.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 551
diff changeset
119
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
120 An easy way to test whether it's a permissions problem, or some other mail
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
121 server configuration problem is to cat an email-formatted text file
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
122 directly to the roundup-mailgw script as the roundup user.::
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
123
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
124 cat issue.txt | /usr/local/bin/roundup-mailgw /home/roundup
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
125
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
126 If that doesn't raise any errors, the problem is the permissions of the
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents: 611
diff changeset
127 MTA.
596
1d9b10b0efb9 how to do without a mailserver.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 589
diff changeset
128
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
129 -----------------
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
130
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
131 Back to `Table of Contents`_
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
132
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
133 .. _`Table of Contents`: index.html
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
134
Roundup Issue Tracker: http://roundup-tracker.org/