-
Notifications
You must be signed in to change notification settings - Fork 4
/
development.html
82 lines (71 loc) · 4.58 KB
/
development.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>OfflineIMAP home</title>
<!--[if lt IE 9]>
// teach older IEs to render those elements at all (http://diveintohtml5.org/semantics.html#unknown-elements)
<script>
var e = ("abbr,article,aside,audio,canvas,datalist,details," +
"figure,footer,header,hgroup,mark,menu,meter,nav,output," +
"progress,section,time,video").split(',');
for (var i = 0; i < e.length; i++) {
document.createElement(e[i]);
}
</script>
<![endif]-->
<link href='http://fonts.googleapis.com/css?family=Walter+Turncoat' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
<header>
<img id="logo" src="img/logo.png">
<hgroup>
<h1><a href="http://offlineimap.org">OfflineImap</a></h1>
<h2>Syncing IMAP accounts since 2002</h2>
</hgroup>
<nav>
<a class="reference" href="index.html">Home</a>
<a class="reference" href="index.html#ref-download" >Download</a>
<a class="reference" href="index.html#ref-quick-start" >Quick Start</a>
<a class="reference" href="index.html#ref-documentation" >Documentation</a>
<a class="reference" href="development.html" >Development</a>
<a class="reference" href="index.html#ref-links">Links</a>
</nav>
</header>
<section id="content">
<header><h1><a id="ref-development" ></a>Development</h1></header>
<article>
<header><h2><a id="ref-mailing-list" ></a>Mailing list</h2></header>
<p>The user discussion, development and all exciting stuff take place on the
<a
href="http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project">mailing
list</a>. It's email address is <a
href='mailto:o%66flin%65imap-pr%6Fj%65ct@lists.aliot%68.de%62ian.%6F%72%67'>offlineimap-project@lists.alioth.debian.org</a>.</p>
<p>You do <em>NOT</em> need to be subscribed to send emails to this list. Also,
you're expected to: <ol>
<li>keep everyone on the CC list;</li>
<li>use the plain TEXT format for your mail (no HTML).</li>
</ol>
</p>
</article>
<article>
<header><h2><a id="source-code"></a>Get the Source code</h2><header>
<p>Our git repository home page can be found on its <a href="https://github.com/spaetz/offlineimap">github home</a>. Grab the current code with a <tt>git clone git://github.com/spaetz/offlineimap.git</tt>.</p>
There are several branches. <emph>Master<emph> represents the current stable branch or what will be the next stable release. <emph>Next<emph> is where development happens. This is what will be merged into Master for the next major release. Finally <emph>PU<emph> is a feature branch which hosts crazy features that might or might not make it into some release. This branch could easily be reset at any point in time.
</article>
<article>
<header><h1><a id="ref-reporting-bugs">Reporting bugs and issues</a></h1></header>
<p>Unfortunately no program is bug free. This is true for all imap servers, and even for OfflineImap. If something goes wrong and you want to report a bug, this is what you should do:</p>
<ol><li>If you are using a stable version that came with your distribution, we would appreciate testing to make sure the bug hasn't been fixed already.</li>
<li>Starting with version 6.5.0, offlineimap includes an <b>--info</b> switch that will output all kinds of useful information. Do that and capture the information as it will be useful for debugging.</li>
<li>Take a debug log of the run that exposes the issue at hand and that does as little as possible otherwise (e.g. by using -f INBOX to only sync the INBOX if that is where your error occurs). You can create a debug log file by using:
<tt>-d imap -d debug.log</tt> (or -d imap,maildir) if you suspect the problem is with how maildirs are handled.</li>
<li>This produces a potentially very large log file, <b>including all your IMAP communication. That means that your username and your password will likely be included in the clear in that debug log!</b> Make sure you clean the file from it before sending it in.</li>
<li>Do make the file available (if big) or mail it directly to either the <a class="reference" href="http://lists.alioth.debian.org/mailman/listinfo/offlineimap-project">mailing list</a>, or -- if your mails contain sensitive information that you don't want to be publically archived -- make them available to a developer of your choice.</li>
</ol>
<p><b>AGAIN: Take note that the debug.log will contain passwords and email contents though. So either remove those or make the log available to one of the developers in private if that concerns you.</b></p>
</article>
</section>
</body>
</html>