view summary.roff @ 190:2443264b1745

Added sloccount graph to the summary.
author markus schnalke <meillo@marmaro.de>
date Wed, 11 Jul 2012 18:35:11 +0200
parents 22feb390ccc4
children 68980dab3236
line wrap: on
line source

.H0 "Summary
.P
This document describes and explains my work on mmh.
I have streamlined the project by removing programs, facilities,
and options that diverted from the main task of mmh, being an MUA.
I have modernized the code base removing obsolete functions and
activating modern features per default.
Furthermore, I have improved the style by refactoring clumpsy code
and by identifying and forcing clear concepts.
All my work was motivated by Antoine de Saint Exupery's well-known
statement:
.[
antoine de saint exupery: Wind, Sand and Stars (1939)
.]
.QS
It seems that perfection is attained not when there is nothing
more to add, but when there is nothing more to remove.
.QE
.LP
Against the common expectations, I hardly added new features.
I regard my achievement in the selection of the relevant set of existing
features, the choice of sensible defaults, and the extensive
focus on structure and concepts.
I believe, the result is a system simpler and clearer for both
developing and using, without lacking important functionality.

.KS
.in 1c
.so input/sloc.grap
.KE


.U2 "Outlook
.P
The work on mmh is not finished.
Several tasks are left to do.
.P
MIME handling is the most complex part of mmh and the one with the
highest potential for improvements.
The changes already accomplished so far build upon the existing structure,
but deeper rework is necessary to integrate MIME handling consistently.
For instance, accessing messages and accessing their MIME parts
should both covered by a single approach.
This requires the sequence notation to provide a way to address
MIME parts directly.
In general, the sequence notation should become more powerful.
For instance, it is currently not possible to access the second last
message in a given sequence.
Furthermore, displaying messages can be improved.
Encrypted messages should be decoded automatically
and digital signatures verified on-the-fly.
In this rework, MH's unique features need to be preserved,
but as well the default behavior should become less surprising.
Still, encoding and decoding is not done everywhere it is necessary.
The problems of not decoded quotations of the original message in replies
and not encoded non-ASCII characters in the message header remain.
.P
Some of mmh's tools were hardly touched, yet.
Among them are
.Pn dist ,
.Pn rcvdist ,
.Pn mark ,
.Pn pick ,
and
.Pn sortm .
They should be refactored as well.
Related to
.Pn sortm
is the threaded message view, which is completely missing, so far.
.Pn pick
could profit from message indexing.
These fields deserve further research.
.P
Nmh's testing framework has not been updated for mmh, yet.
All refactoring had been done without the safety net of a test framework.
Hence, experience warns that there may be subtle bugs in the code base.
.P
The features most often asked for are IMAP and Maildir support.
But, both of them collide with MH in the same fundamental way as
different filesystem approaches collide with Unix.
Nevertheless, an abstraction layer could provide a mapping between such
storage back-ends and the MH storage format.
Or, the mmh tool chest could be reworked to operate on a generic back-end,
making the MH storage format only one of many possible back-ends.
Research in this area is highly appreciated.


.U2 "Relationship to nmh
.P
The mmh project started as an experimental version of nmh because the
nmh community did not welcome my changes in the mainline version.
To not slow down my work by the need to convince the community in
discussions for each step I liked to take,
I started to create an experimental version to convicce by demonstration
of the result.
.\" behind closed doors; talks I've given
My work on mmh was independent of the nmh community. .\" XXX clarify
.\" XXX straight?
This enabled me to follow my vision straightforwardly and thus produce
a result of greater pureness.
.P
Mmh shall be considered as an inspiration for the future development of nmh.
It shall identify weak parts of nmh and suggest possible
improvements by change.
It shall present a lean appearance that is simpler to understand
and work with for developers and users.
By all means, my work on mmh shall improve nmh somehow.
Improving nmh directly in the way I wanted was impossible
due to personal and community-related circumstances.
The mmh project is my way to offer my gifts though.
.\" XXX zweimal ``my way''
.P
.\" XXX
During my work on mmh, the community of nmh suddenly became very active.
In parallel to my work on mmh, they have worked on nmh. \" XXX rewrite
There was no collaberation in our work, except that I have pulled some
changes from nmh to mmh.
Our work was motivated partly by similar and partly by different aims.
Although some changes are common among both projects,
fundamental differences exist.
My experimental version thus more and more felt like being a fork.
I am still undecided how I like to treat it.
.P
I am strongly convinced that the decisions taken for the
development of mmh were good ones regarding my goals,
and I like to push the project farther in this direction.


.ig
.U2 "Weaknesses of My Work
.P
not targeting on the right problems (maildir, imap)

.P
refactoring requires testing, automated testing

.P
communication with nmh.
worked behind closed doors, but no:
talks I've given

.P
focus on myself.
But: If good for me then also good for others.
..