Commit Graph

87 Commits

Author SHA1 Message Date
Nicolas Sebrecht
bbc84ead0f move some documentation to the website
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 15:52:46 +01:00
Nicolas Sebrecht
846ebeb2aa docs: GitAdvanced: write the "sending pull request" section
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-07 20:05:17 +01:00
Nicolas Sebrecht
e303c6c5d0 rework documentation
- Add CONTRIBUTING.rst.
- Improve MAINTAINERS.rst.
- Split long HACKING.rst into:
  * dco.rst
  * GitAdvanced.rst

Update content.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-07 19:26:17 +01:00
Nicolas Sebrecht
2377353cae rfcs: update RFCs and provide better filenames
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-06 21:27:52 +01:00
Nicolas Sebrecht
5ecd557dfb doc: add IMAP RFCs
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-02 10:52:26 +01:00
Nicolas Sebrecht
cd962d40a8 MANUAL: add known issues entry about socktimeout for suspended sessions
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-02-13 17:32:24 +01:00
Nicolas Sebrecht
30499cf680 MANUAL: rename "KNOWN BUGS" TO "KNOWN ISSUES"
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-02-13 17:32:24 +01:00
Abdo Roig-Maranges
5318af606e docs: expand documentation of the gmail labels syncing
- Suggest that this works well together with email indexing.

- Warn about modifying the labelsheader after a sync.

- In the example replace X-Gmail-Keywords by X-Keywords. I think this is
  misleading, since no email client will pick up X-Gmail-Keywords, while
  X-Keywords (the default) is recognized by some.

- add paragraph explaining special gmail labels.

Merge-request-from: Abdó Roig-Maranges
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-02-10 12:35:54 +01:00
Nicolas Sebrecht
5c56d4f8ab docs: CodingGuidelines: remove duplicate content
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-13 18:18:03 +01:00
Wieland Hoffmann
d08f6d15c2 addmessageheader: Add a note about the incorrect rendering of the docstring
The note tells people to look at the source of the method, which
spinx.ext.viewcode conveniently links right next to the methods
signature.

Signed-off-by: Wieland Hoffmann <themineo@gmail.com>
2015-01-12 17:17:42 +01:00
Eygene Ryabinkin
2789ad26bf API documentation: fix typo
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2015-01-12 17:51:27 +03:00
Eygene Ryabinkin
854d0019d9 API documentation: properly auto-document main class
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2015-01-12 17:51:27 +03:00
Eygene Ryabinkin
50b01cd728 Fix API documentation syntax
- Drop unneeded definition for offlineimap.globals module.
 - Avoid hyperlinking the section from itself.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2015-01-12 17:51:27 +03:00
Eygene Ryabinkin
e7fabf9e57 Properly re-raise exception to save original tracebacks
We usually mutate some exceptions to OfflineImapError() and it is
a whole lot better if such exception will show up with the original
traceback, so all valid occurrences of such mutations were transformed
to the 3-tuple form of "raise".  Had also added coding guidelines
document where this re-raise strategy is documented.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2015-01-12 17:51:21 +03:00
Nicolas Sebrecht
bd0461a986 MANUAL: add minor sample on how to retrieve a password with a helper python file
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-10 12:36:18 +01:00
Nicolas Sebrecht
18bf7b7dc9 MANUAL: split long lines
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-10 12:36:18 +01:00
Nicolas Sebrecht
4273c9b305 doc-src: nametrans.rst: fix minor error
- Typo in code was corrected by aeeea5
- Update prose to match code

Submitted-by: sumbach (Github)
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-10 12:36:17 +01:00
Wieland Hoffmann
40226705af MANUAL: dev-doc is no more
The folder has been removed in 74b133c500

Signed-off-by: Wieland Hoffmann <themineo@gmail.com>
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-09 01:10:44 +01:00
Nicolas Sebrecht
532278b4dd docs: remove obsolete comment about SubmittingPatches.rst
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-01-01 22:24:23 +01:00
Sebastian Spaeth
f282f0b0e0 Merge pull request #67 from danmilon/fix-docs-folderfilter-typo
docs: fix folderfilter typo
2014-06-24 18:55:36 +04:00
Eygene Ryabinkin
ee89610f3a Hacking manual: documented how to create tags
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-05-14 18:02:53 +04:00
Abdo Roig-Maranges
6453ab0db7 Bring GMail labels section on the manual up to date
- there is no need to set SQlite backend anymore;
 - explain a bit more that some headers are recognized
   by email clients.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-05-11 22:38:57 +04:00
Eygene Ryabinkin
5150de5514 Add support for XDG Base Directory Specification
$XDG_CONFIG_HOME/offlineimap/config will now be tried before
the canonical ~/.offlineimaprc.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-05-07 00:40:59 +04:00
Nathan Guerin
9eba0e5eb7 User manual: fix typo, "rebuild" -> "rebuilt"
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-05-07 00:07:18 +04:00
Abdó Roig-Maranges
0e4afa9132 Make GmailFolder sync GMail labels
When synclabels config flag is set to "yes" for the GMail repo,
offlineimap fetches the message labels along with the messages, and
embeds them into the body under the header X-Keywords (or whatever
'labelsheader' was set to), as a comma separated list.

It also adds an extra pass to savemessageto, that performs label
synchronization on existing messages from GMail to local, the same way
it is done with flags.

We also introduce GmailMaildir repository that adds functionality to
change message labels.  It keeps track of messages modification time,
so one can quickly detect when the labels may have changed.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-05-06 23:36:06 +04:00
Eygene Ryabinkin
6cbd2498ae Refactoring: make functions to be private if we can
Make external API of class/module to be smaller, explicitely mark
all internal functions.  Also annotate methods that are implemented
as the part of the parent class interface.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2014-04-30 19:35:56 +04:00
Nicolas Sebrecht
e3fbe0232b docs: add "development state" section and update some links
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2013-12-14 15:02:41 +01:00
Eygene Ryabinkin
41cb0f577f Prune trailing whitespaces from code and documentation
They are redundant in all pruned cases and sometimes even create some
problems, e.g., when one tries to jump through paragraphs in vi.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2013-07-21 23:00:23 +04:00
Eygene Ryabinkin
f4140cbbed Create global instance of command-line options
This eases testing of option values inside the code.  This instance
is implemented as the read-only copy of the obtained 'options' object,
so callers won't be able to modify its contents.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2013-02-11 23:34:18 +04:00
Eygene Ryabinkin
de84c3941c Implement stack trace dump for all running threads on SIGQUIT
This is handy when we're debugging the thread locks: we can try to
understand which thread does what and how it was called.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2013-02-02 16:25:37 +04:00
Dmitrijs Ledkovs
83e8fca2e0 Make SIGHUP singal handler equivalent to SIGTERM and SIGINT.
offlineimap has several frontends that encourage running it from a
terminal under an X session. When X session closes for a system
shutdown, the terminals exit, after sending SIGHUP to their children.

Previously SIGHUP was treated to be equivalent to SIGUSR1, i.e. wake
up and sync all accounts. This causes delays during shutdown.

According to Wikipedia [0], SIGHUP has been repurposed from a
historical meaning to one of:
 * re-read configuration files, or reinitialize (e.g. Apache, sendmail)
 * controlling pseudo or virtual terminal has been closed

I believe second meaning is more appropriate for offlineimap, and
hence this patch makes SIGHUP to be handled in the same way SIGTERM
and SIGINT are handled.

[0] http://en.wikipedia.org/wiki/SIGHUP

Debian-Bug: http://bugs.debian.org/670120
Reported-By: Steve Langasek <steve.langasek@canonical.com>
Signed-off-by: Dmitrijs Ledkovs <xnox@debian.org>
Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
2013-01-26 23:05:46 +04:00
Nicolas Sebrecht
44d2199a00 docs: update links to the newly created github organization
Acually, these are the minimal expected changes.
More might be done and/or discussed.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2012-08-20 14:45:43 +02:00
Nicolas Sebrecht
799905325c docs: split long lines (up to 80 characters)
Not everybody has a wide screen.

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2012-07-30 18:41:17 +02:00
Sebastian Spaeth
0752c123f5 Implement the "createfolders" setting for repositories
By default OfflineImap propagates new folders in both
directions. Sometimes this is not what you want. E.g. you might want
new folders on your IMAP server to propagate to your local MailDir,
but not the other way around. The 'readonly' setting on a repository
will not help here, as it prevents any change from occuring on that
repository. This is what the `createfolders` setting is for. By
default it is `True`, meaning that new folders can be created on this
repository. To prevent folders from ever being created on a
repository, set this to `False`. If you set this to False on the
REMOTE repository, you will not have to create the `Reverse
nametrans`_ rules on the LOCAL repository.

Also implement a test for this

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-05-08 16:56:45 +02:00
Sebastian Spaeth
a4b4f1ffcb docs: maxage/size skeleton
Add skeleton for maxage/maxsize documentation. Also remove the old
nametrans.rst from the old doc location.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-04-19 17:36:52 +02:00
Sebastian Spaeth
4b323f7532 Merge branch 'next'
Conflicts:
	Changelog.draft.rst
	docs/MANUAL.rst

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-04-02 23:50:58 +02:00
Sebastian Spaeth
8bbdaa8c66 docs: Integrate SubmittingPatches.rst into HACKING.rst
Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 12:03:56 +01:00
Sebastian Spaeth
d4c7a7bf17 Delete UPGRADE.rst
This is the upgrade instruction from before 4.0 and long obsolete.
Delete it.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:21:11 +01:00
Sebastian Spaeth
74b133c500 Revamped documentation structure and some doc fixes
`make` in the `docs` dir or `make doc` in the root dir will now
create the 1) man page and 2) the user documentation using sphinx
(requiring python-doctools, and sphinx).

The resulting user docs are in `docs/html`. You can also
only create the man pages with `make man` in the `docs` dir.

Also fixed all .rst conversion errors as requested by Gentoo downstream.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-24 11:13:27 +01:00
Sebastian Spaeth
aa01fe754a Improve command line option help text
Shuffle around and update command line option descriptions in the
docs.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-17 13:17:05 +01:00
Sebastian Spaeth
f5b82ad76d Improve nametrans user documentation
Fill in more details on nametrans and folder filtering. Also give them a
separate section in our user documentation. Everything will be
immediately online at docs.offlineimap.org.

The main change is to describe the reverse nametrans settings that are
needed since 6.4.0 to support remote folder creation.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-13 16:09:32 +01:00
Sebastian Spaeth
da0ba2e266 Improve nametrans user documentation
Fill in more details on nametrans and folder filtering. Also give them a
separate section in our user documentation. Everything will be
immediately online at docs.offlineimap.org.

The main change is to describe the reverse nametrans settings that are
needed since 6.4.0 to support remote folder creation.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-02-13 16:07:33 +01:00
Daniel Shahaf
bf31accb78 We have a (read-only) commit mailing list
Sebastian Spaeth wrote on Thu, Jan 19, 2012 at 10:28:19 +0100:
> Forgot to Cc the list...
>
> On Wed, 18 Jan 2012 08:17:44 +0200, Daniel Shahaf wrote:
> > Sebastian Spaeth wrote on Wed, Jan 18, 2012 at 01:02:22 +0100:
> >> http://docs.offlineimap.org
> >
> > I've subscribed.  And if you tell me where the sources for docs.o.o are,
> > I'll send a patch for them, too. :-)
>
> They are autogenerated from docs/dev-docs-src, and
> docs/[INSTALL|MANUAL|FAQ].rst respectively. Patches are welcome...
>
> Sebastian

From 84fcb9fa5de9eb2f95d588a7403d9c6d13f0c7f0 Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Thu, 19 Jan 2012 11:53:13 +0200
Subject: [PATCH] Document the commits@ list

Mention the commits@ list in SubmittingPatches.rst.

Mention SubmittingPatches.rst in the API part of the documentation.

Signed-off-by: Daniel Shahaf <d.s@daniel.shahaf.name>
2012-01-20 00:42:58 +01:00
Sebastian Spaeth
c1625aa719 DOCS: Tweak SSL FAQ a bit more
Cleanup the previously added information.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-19 10:15:04 +01:00
Sebastian Spaeth
2c19a63b9d DOCS: Add SSL debugging info to FAQ
Take the debugging instructions by Daniel Shahaf and add them to the
FAQ.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-19 10:08:31 +01:00
Sebastian Spaeth
340c2f9a89 Improve documentation
Improve wording, and integrate the MANUAL and INSTALL and FAQ documents
into our complete user manual that is hosted online.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-17 01:34:56 +01:00
Sebastian Spaeth
f88f8cf984 offlineimap.conf wording tweaks
Clarify and improve wording in minor ways.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-07 18:03:21 +01:00
Nicolas Sebrecht
b85f36e520 doc: add link to the web page of autogenerated API
Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2012-01-07 16:53:49 +01:00
Sebastian Spaeth
5240d3f367 docs/INSTALL: How to uninstall
Add a blurb on how to uninstall system wide installations.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-06 19:51:58 +01:00
Sebastian Spaeth
00c67881a0 docs/MANUAL: How to upgrade to sqlite storage
Add section to the manual describing how to upgrade to the new cache
backend.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-06 19:35:56 +01:00