docs/master

changeset 179:b59201e345e5

Applied further corrections by Aaron.
author markus schnalke <meillo@marmaro.de>
date Tue, 10 Jul 2012 23:13:45 +0200
parents 520b3c7abba1
children 731e747a805b
files colophon.roff discussion.roff summary.roff
diffstat 3 files changed, 35 insertions(+), 29 deletions(-) [+]
line diff
     1.1 --- a/colophon.roff	Tue Jul 10 22:30:17 2012 +0200
     1.2 +++ b/colophon.roff	Tue Jul 10 23:13:45 2012 +0200
     1.3 @@ -43,6 +43,9 @@
     1.4  Formale Sprache und Komplexit\[adieresis]tstheorie\fP
     1.5  by Hopcroft and Ullman, Addison-Wesley, 1990.
     1.6  .P
     1.7 +For measuring code size, I used David A. Wheeler's
     1.8 +.Pn sloccount .
     1.9 +.P
    1.10  The complete sources of this document, as well as final versions in
    1.11  PDF and Postscript format, are available on my website:
    1.12  .L http://marmaro.de/docs \^.
     2.1 --- a/discussion.roff	Tue Jul 10 22:30:17 2012 +0200
     2.2 +++ b/discussion.roff	Tue Jul 10 23:13:45 2012 +0200
     2.3 @@ -1657,8 +1657,8 @@
     2.4  Hence, others can comprehend my view and argue for undoing the change
     2.5  if I have missed an important aspect.
     2.6  I was quick in dropping parts.
     2.7 -I rather re-included falsely dropped parts than going at a slower pace.
     2.8 -Mmh is experimental work; it required tough decisions.
     2.9 +I rather include falsely dropped parts again, than going at a slower pace.
    2.10 +Mmh is experimental work; it requires tough decisions.
    2.11  .\" XXX ``exp. work'' schon oft gesagt
    2.12  
    2.13  
    2.14 @@ -1970,8 +1970,8 @@
    2.15  The conversion to MIME is invisible to the user.
    2.16  The draft stored in the draft folder is always in source form with
    2.17  attachment headers.
    2.18 -If the MIMEification fails, for instance because the file to attach
    2.19 -is not accessible, the original draft is not changed.
    2.20 +If the MIMEification fails (e.g. because the file to attach
    2.21 +is not accessible) the original draft is not changed.
    2.22  .P
    2.23  The attachment system handles the forwarding of messages, too.
    2.24  If the attachment header value starts with a plus character (`\fL+\fP'),
    2.25 @@ -1992,7 +1992,7 @@
    2.26  .Pe automimeproc
    2.27  profile entry could be specified to have the `mime' command invoked
    2.28  automatically each time.
    2.29 -Unfortunately, this approach conflicted with attachment system
    2.30 +Unfortunately, this approach conflicted with the attachment system
    2.31  because the draft would already be in MIME format at the time
    2.32  when the attachment system wanted to MIMEify it.
    2.33  To use nmh's attachment system, `mime' must not be called at the
    2.34 @@ -2048,7 +2048,7 @@
    2.35  partly intelligent work.
    2.36  Forcing the user to find out the correct MIME type,
    2.37  forces him to do partly mechanical work.
    2.38 -Letting the computer do the work, can lead to bad choices for difficult
    2.39 +Letting the computer do the work can lead to bad choices for difficult
    2.40  content.
    2.41  For mmh, the latter option was chosen.
    2.42  .P
    2.43 @@ -2235,6 +2235,7 @@
    2.44  .Pn show
    2.45  program, because it was not capable to display MIME messages
    2.46  and is no longer part of mmh.
    2.47 +.\" XXX ref to other section
    2.48  Although
    2.49  .Pn mhshow
    2.50  was renamed to
    2.51 @@ -2242,7 +2243,6 @@
    2.52  in mmh, this section uses the name
    2.53  .Pn mhshow ,
    2.54  in order to avoid confusion.
    2.55 -.\" XXX ref to other section
    2.56  .P
    2.57  In mmh, the basic idea is that
    2.58  .Pn mhshow
    2.59 @@ -2286,7 +2286,7 @@
    2.60  .Sw -serialonly
    2.61  switch of
    2.62  .Pn mhshow .
    2.63 -As MIME parts are always processed exclusively , i.e. serially,
    2.64 +As MIME parts are always processed exclusively, i.e. serially,
    2.65  the `%e' escape in
    2.66  .Pe mhshow-show-*
    2.67  profile entries became useless and was thus removed.
    2.68 @@ -2765,7 +2765,7 @@
    2.69  before they truly used the system,
    2.70  although they had been motivated in the beginning.
    2.71  They suffer hard enough to get used to the tool chest approach,
    2.72 -we should spare them further inconveniences.
    2.73 +we developers should spare them further inconveniences.
    2.74  .P
    2.75  Maintaining compatibility for its own sake is bad,
    2.76  because the code base collects more and more compatibility code.
    2.77 @@ -3813,7 +3813,7 @@
    2.78  The source code of the mmh tools is located in the
    2.79  .Fn uip
    2.80  (``user interface programs'') directory.
    2.81 -Each tools has a source file with the same name.
    2.82 +Each tools has a source file with the name of the command.
    2.83  For example,
    2.84  .Pn rmm
    2.85  is built from
    2.86 @@ -3841,7 +3841,7 @@
    2.87  Most of the mmh tools, however, are simple and straight-forward programs.
    2.88  With the exception of the MIME handling tools,
    2.89  .Pn pick
    2.90 -is the largest tools.
    2.91 +is the largest tool.
    2.92  It contains 1\|037 lines of source code (measured with
    2.93  .Pn sloccount ), excluding the MH library.
    2.94  Only the MIME handling tools (\c
    2.95 @@ -3854,9 +3854,9 @@
    2.96  source files seldom leads to better readability.
    2.97  For such tools, splitting makes sense
    2.98  when parts of the code are reused in other programs,
    2.99 -and the reused code fragment is not general enough
   2.100 -for including it in the MH library,
   2.101 -or, if the code has dependencies on a library that only few programs need.
   2.102 +and the reused code fragment is (1) not general enough
   2.103 +for including it in the MH library
   2.104 +or (2) has dependencies on a library that only few programs need.
   2.105  .Fn uip/packsbr.c ,
   2.106  for instance, provides the core program logic for the
   2.107  .Pn packf
   2.108 @@ -4021,7 +4021,7 @@
   2.109  does annotate and send messages.
   2.110  In nmh, there surely exists the tool
   2.111  .Pn send ,
   2.112 -which does (almost) only send messages.
   2.113 +which does mainly send messages.
   2.114  But
   2.115  .Pn comp
   2.116  and
   2.117 @@ -4034,7 +4034,7 @@
   2.118  .Pn whatnow
   2.119  and
   2.120  .Pn viamail ,
   2.121 -they all (!) have the same message sending function included, too.
   2.122 +they all (!) have the same message sending function included, as well.
   2.123  In result,
   2.124  .Pn comp
   2.125  sends messages without using
     3.1 --- a/summary.roff	Tue Jul 10 22:30:17 2012 +0200
     3.2 +++ b/summary.roff	Tue Jul 10 23:13:45 2012 +0200
     3.3 @@ -6,7 +6,7 @@
     3.4  I have modernized the code base removing obsolete functions and
     3.5  activating modern features per default.
     3.6  Further more, I improved the style by refactoring clumpsy code
     3.7 -and by defining or exploiting clear concepts.
     3.8 +and by defining or forcing clear concepts.
     3.9  All my work was motivated by Antoine de Saint Exupery's well-known
    3.10  statement:
    3.11  .[
    3.12 @@ -43,7 +43,7 @@
    3.13  Displaying messages with
    3.14  .Pn show
    3.15  requires further rework.
    3.16 -Encrypted messages, for example, should be decoded automatically
    3.17 +Encrypted messages should, for example, be decoded automatically
    3.18  and digital signatures should be verified on-the-fly.
    3.19  The whole task should be aligned with the common behavior of other
    3.20  mail clients.
    3.21 @@ -64,7 +64,7 @@
    3.22  .Pn sortm .
    3.23  Related to
    3.24  .Pn sortm ,
    3.25 -a threaded message view is completely missing to mmh, yet.
    3.26 +a threaded message view is completely missing in mmh, yet.
    3.27  .Pn pick
    3.28  could be enhanced by message indexing.
    3.29  These fields are worthwhile for research.
    3.30 @@ -93,21 +93,21 @@
    3.31  .P
    3.32  The mmh project started as an experimental version of nmh because the
    3.33  nmh community did not welcome my changes in the mainline version.
    3.34 -To not slow my work down by the need to convince the community in
    3.35 +To not slow down my work by the need to convince the community in
    3.36  discussions for each step I liked to take,
    3.37  I started to create an experimental version to convicce by demonstration
    3.38  of the result.
    3.39  .\" behind closed doors; talks I've given
    3.40 -My worked on mmh was independent of the nmh community.
    3.41 -This enabled me to follow my vision straightly and thus produce
    3.42 +My work on mmh was independent of the nmh community.
    3.43 +This enabled me to follow my vision straight and thus produce
    3.44  a result of greater pureness.
    3.45  .P
    3.46 -Mmh shall be considered an inspiration for the future development of nmh.
    3.47 -It shall show identify weak part of nmh and suggest possible
    3.48 +Mmh shall be considered as an inspiration for the future development of nmh.
    3.49 +It shall identify weak parts of nmh and suggest possible
    3.50  improvements by change.
    3.51  It shall present a lean appearance that is simpler to understand
    3.52  and work with for developers and users.
    3.53 -By all means shall my work on mmh improve nmh in some way.
    3.54 +By all means, my work on mmh shall improve nmh in some way.
    3.55  Improving nmh directly in the way I wanted was impossible for me
    3.56  due to personal and community-related circumstances.
    3.57  The mmh project is my way to offer my gifts though.
    3.58 @@ -120,12 +120,14 @@
    3.59  Although some changes are common among both projects,
    3.60  fundamental differences exist.
    3.61  My experimental version thus more and more felt like being a fork.
    3.62 -I am undecided how I like to have it.
    3.63 -Yet, I am strongly convinced that most of the decisions taken in mmh
    3.64 -were good to achieve my goals and I like to push the project even
    3.65 -farther in this direction.
    3.66 +I am undecided how I like to treat it.
    3.67 +.P
    3.68 +Yet, I am strongly convinced that the decisions taken for the
    3.69 +development of mmh were good ones with regard of my goals,
    3.70 +and I like to push the project farther in this direction.
    3.71  
    3.72  
    3.73 +.ig
    3.74  .U2 "Weaknesses of My Work
    3.75  .P
    3.76  not targeting on the right problems (maildir, imap)
    3.77 @@ -141,3 +143,4 @@
    3.78  .P
    3.79  focus on myself.
    3.80  But: If good for me then also good for others.
    3.81 +..