Mailing List Archive: exim: dev

Exim documentation

Index | Next | Previous | View Threaded

john.horne at plymouth

Aug 29, 2009, 3:58 PM

Post #1 of 9 (1872 views)
Permalink

Exim documentation

Hello,

Any of you with the O'Reilly Exim version 3 book may have read my name
in the Acknowledgments as one of the readers for the book, and Philip
Hazel's comments that I 'proof-read' several versions of the Exim
specification.

I have very much been tied up with other projects since just before
Philip retired, but I am now considering leaving one project. As such, I
am wondering if this project wanted someone to take on some of the
documentation tasks - I'm not sure what though!

If you are happy for me to take a look at the Exim docs, then please let
me know.

One of the problems I had when helping Philip was that I had to note
down, literally on paper, each of the mistakes I found, and then type
them into a message which got sent off to Philip. He then updated the
actual docs. To me this was duplication of work, and I would hope that
it would now be possible to update the docs directly (something similar
to using CVS to update source code?).

I have no idea how the docs are handled (i.e. what software is used,
etc), and it may well be that I need to dig through some of Philips last
emails to see what happened.

As an introductory gift(!), this lists 'Welcome' message has a mistake
in it :-) It states:

Welcome to the Exim-dev [at] exim mailing list! Please note it is
*always* inappropriate for for list postings to be sent to both
exim-users and exim-dev.

Note the 'for for' :-)

John.

--
---------------------------------------------------------------
John Horne, University of Plymouth, UK Tel: +44 (0)1752 587287
E-mail: John.Horne [at] plymouth Fax: +44 (0)1752 587001

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

eximusers at downhill

Aug 30, 2009, 12:17 AM

Post #2 of 9 (1783 views)
Permalink

Re: Exim documentation [In reply to]

Hello John,

I am not involved in the actual writing of code for exim, I am just
following the list since I am part of the team packaging it for Debian
Linux. I thank you for the offer anyway, writing good technical
documentation is a difficult task.

The project is rather quiet currently, last commit to CVS happened in
July. I guess things will speed up after the summer hiatus.

I think I can answer some of your questions:

On 2009-08-30 John Horne <john.horne [at] plymouth> wrote:
[...]
> One of the problems I had when helping Philip was that I had to note
> down, literally on paper, each of the mistakes I found, and then type
> them into a message which got sent off to Philip. He then updated the
> actual docs. To me this was duplication of work, and I would hope that
> it would now be possible to update the docs directly (something similar
> to using CVS to update source code?).

exim's source code and docs is kept in CVS nowadays, see
http://wiki.exim.org/EximDevelopment for the details.

> I have no idea how the docs are handled (i.e. what software is used,
> etc), and it may well be that I need to dig through some of Philips last
> emails to see what happened.
[...]

The main documentation (spec and filter) lives in
exim-doc/doc-docbook/ and is built from xfpt files.
doc-docbook/HowItWorks.txt explains how to get from xfpt to txt, html,
etc. http://freshmeat.net/projects/xfpt

cu andreas
--
`What a good friend you are to him, Dr. Maturin. His other friends are
so grateful to you.'
`I sew his ears on from time to time, sure'

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

tlyons at ivenue

Aug 31, 2009, 8:44 AM

Post #3 of 9 (1764 views)
Permalink

Re: Exim documentation [In reply to]

On Sun, Aug 30, 2009 at 12:17 AM, Andreas
Metzler<eximusers [at] downhill> wrote:
> exim's source code and docs is kept in CVS nowadays, see
> http://wiki.exim.org/EximDevelopment for the details.

Any chance it will ever go to something distributed such as git or
bazaar (or I guess mercurial)? One import from cvs to one of those
and everybody then has instant history access from a local checkout.
Or is there just no interest in that?

--
Regards... Todd

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

johannes at sipsolutions

Aug 31, 2009, 9:01 AM

Post #4 of 9 (1755 views)
Permalink

Re: Exim documentation [In reply to]

On Mon, 2009-08-31 at 08:44 -0700, Todd Lyons wrote:

> Any chance it will ever go to something distributed such as git or
> bazaar (or I guess mercurial)? One import from cvs to one of those
> and everybody then has instant history access from a local checkout.
> Or is there just no interest in that?

There are copies at
http://git.infradead.org/exim-doc.git
and
http://git.infradead.org/exim-src.git

which sync from CVS automatically (afaik).

johannes

Attachments:

signature.asc (0.78 KB)

tlyons at ivenue

Sep 1, 2009, 3:02 PM

Post #5 of 9 (1772 views)
Permalink

Re: Exim documentation [In reply to]

On Mon, Aug 31, 2009 at 9:01 AM, Johannes Berg<johannes [at] sipsolutions> wrote:
>> Any chance it will ever go to something distributed such as git or
> There are copies at
> http://git.infradead.org/exim-doc.git
> http://git.infradead.org/exim-src.git
> which sync from CVS automatically (afaik).

Many many thanks!

--
Regards... Todd

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

asdf at vienna

Sep 1, 2009, 11:46 PM

Post #6 of 9 (1738 views)
Permalink

Re: Exim documentation [In reply to]

Am Mittwoch, 2. September 2009 00:02 schrieb Todd Lyons:
>On Mon, Aug 31, 2009 at 9:01 AM, Johannes Berg<johannes [at] sipsolutions>
wrote:
>>> Any chance it will ever go to something distributed such as git or
>>
>> There are copies at
>> http://git.infradead.org/exim-doc.git
>> http://git.infradead.org/exim-src.git
>> which sync from CVS automatically (afaik).
>
>Many many thanks!

Great! Thank you!

--
Bei Erhalt einer verschlüsselten Nachricht fordern sie bitte
den öffentlichen Schlüssel an und ebenfalls den zum Prüfen
der Signatur, der kann sicher zugesandt werden.

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

john.horne at plymouth

Sep 6, 2009, 2:33 PM

Post #7 of 9 (1674 views)
Permalink

Re: Exim documentation [In reply to]

On Mon, 2009-08-31 at 18:01 +0200, Johannes Berg wrote:
> On Mon, 2009-08-31 at 08:44 -0700, Todd Lyons wrote:
>
> > Any chance it will ever go to something distributed such as git or
> > bazaar (or I guess mercurial)? One import from cvs to one of those
> > and everybody then has instant history access from a local checkout.
> > Or is there just no interest in that?
>
> There are copies at
> http://git.infradead.org/exim-doc.git
> and
> http://git.infradead.org/exim-src.git
>
Is there some sort of problem accessing these? I get these errors:

====================================================
{local}63: git clone http://git.infradead.org/exim-doc.git
Initialized empty Git repository in /home/john/exim-git/exim-doc/.git/
error: inflate: data stream error (incorrect header check)
error: File 0000000000000000000000000000000000000000
(http://git.infradead.org/exim-doc.git/objects/00/00000000000000000000000000000000000000) corrupt
Getting pack list for http://git.infradead.org/exim-doc.git
Getting alternates list for http://git.infradead.org/exim-doc.git
Also look at <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"
lang="
Also look at <base href="http://git.infradead.
Also look at <a title="git homepage" href="http://git.or.cz/"><img
src="/gitweb-data/git-logo.png" width="72" height="27" alt="git"
class="logo"/></a><a href="/">git://git.infradead.org</a> / <a
href="/exim-doc.git">exim-doc.git</a> / s
Getting pack list for <html xmlns="http://www.w3.org/1999/xhtml"
xml:lang="en-US" lang="
error: Couldn't resolve host '<html xmlns="http:'
Getting pack list for <base href="http://git.infradead.
error: Couldn't resolve host '<base href="http:'
Getting pack list for <a title="git homepage"
href="http://git.or.cz/"><img src="/gitweb-data/git-logo.png" width="72"
height="27" alt="git" class="logo"/></a><a
href="/">git://git.infradead.org</a> / <a
href="/exim-doc.git">exim-doc.git</a> / s
error: Couldn't resolve host '<a title="git homepage" href="http:'
error: Unable to find 0000000000000000000000000000000000000000 under
http://git.infradead.org/exim-doc.git
Cannot obtain needed object 0000000000000000000000000000000000000000
fatal: Fetch failed.
====================================================

The exim-src repository gives pretty much the same errors.

John.

--
John Horne, University of Plymouth, UK
Tel: +44 (0)1752 587287 Fax: +44 (0)1752 587001

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

johannes at sipsolutions

Sep 6, 2009, 11:30 PM

Post #8 of 9 (1686 views)
Permalink

Re: Exim documentation [In reply to]

On Sun, 2009-09-06 at 22:33 +0100, John Horne wrote:

> > There are copies at
> > http://git.infradead.org/exim-doc.git
> > and
> > http://git.infradead.org/exim-src.git
> >
> Is there some sort of problem accessing these? I get these errors:

Sorry. Just click those links, they'll take you to gitweb, which also
has the checkout links -- those being

git clone git://git.infradead.org/exim-{src,doc}.git

johannes

Attachments:

signature.asc (0.78 KB)

john.horne at plymouth

Sep 7, 2009, 3:44 PM

Post #9 of 9 (1651 views)
Permalink

Re: Exim documentation [In reply to]

On Mon, 2009-09-07 at 08:30 +0200, Johannes Berg wrote:
> On Sun, 2009-09-06 at 22:33 +0100, John Horne wrote:
>
> > > There are copies at
> > > http://git.infradead.org/exim-doc.git
> > > and
> > > http://git.infradead.org/exim-src.git
> > >
> > Is there some sort of problem accessing these? I get these errors:
>
> Sorry. Just click those links, they'll take you to gitweb, which also
> has the checkout links -- those being
>
> git clone git://git.infradead.org/exim-{src,doc}.git
>
Ah! Many thanks. I should have spotted that myself. It was late
though... :-)

John.

--
John Horne, University of Plymouth, UK
Tel: +44 (0)1752 587287 Fax: +44 (0)1752 587001

--
## List details at http://lists.exim.org/mailman/listinfo/exim-dev Exim details at http://www.exim.org/ ##

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads