docs/master

changeset 225:d83ab437e3a6

Removed FIXMEs (XXX) in the sources, those that I won't fix.
author markus schnalke <meillo@marmaro.de>
date Sun, 15 Jul 2012 20:00:14 +0200
parents b0e83cfde2bf
children 27c28990b844
files discussion.roff
diffstat 1 files changed, 3 insertions(+), 45 deletions(-) [+]
line diff
     1.1 --- a/discussion.roff	Sun Jul 15 19:46:35 2012 +0200
     1.2 +++ b/discussion.roff	Sun Jul 15 20:00:14 2012 +0200
     1.3 @@ -91,7 +91,6 @@
     1.4  .P
     1.5  Usually, the limiting resource in the community development of
     1.6  free software is man power.
     1.7 -.\" XXX FIXME ref!
     1.8  If the development effort is spread over a large development area,
     1.9  it becomes more difficult to compete with the specialists in the
    1.10  various fields.
    1.11 @@ -190,7 +189,6 @@
    1.12  .P
    1.13  As it had already been possible to use an external MSA and MRA,
    1.14  why should the internal version not be kept for convenience?
    1.15 -.\" XXX commas correct?
    1.16  Transfered to a different area, the question,
    1.17  whether there is sense in having a fall-back pager in all
    1.18  the command line tools for the cases when
    1.19 @@ -255,7 +253,6 @@
    1.20  .LI 3
    1.21  By depending on a program that provides the function.
    1.22  .LP
    1.23 -.\" XXX Rework sentence
    1.24  While implementing the function in the project itself leads to the
    1.25  largest increase in code size and requires the most maintenance
    1.26  and development work,
    1.27 @@ -267,7 +264,6 @@
    1.28  External libraries are more strongly connected than external programs,
    1.29  thus information can be exchanged in a more flexible manner.
    1.30  Adding code to a project increases maintenance work.
    1.31 -.\" XXX ref
    1.32  As implementing complex functions in the project itself adds
    1.33  a lot of code, this should be avoided if possible.
    1.34  Thus, the dependencies only change in their character,
    1.35 @@ -320,7 +316,6 @@
    1.36  A tool like
    1.37  .Pn conflict
    1.38  is surely useful, but it should not be shipped with mmh.
    1.39 -.\" XXX historic reasons?
    1.40  .BU
    1.41  .Pn rcvtty
    1.42  was removed
    1.43 @@ -339,7 +334,6 @@
    1.44  VE
    1.45  .BU
    1.46  .Pn viamail
    1.47 -.\" XXX was macht viamail
    1.48  was removed
    1.49  .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
    1.50  when the new attachment system was activated, because
    1.51 @@ -352,7 +346,6 @@
    1.52  .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
    1.53  .BU
    1.54  .Pn msgchk
    1.55 -.\" XXX was macht msgchk
    1.56  was removed
    1.57  .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
    1.58  because it lost its use case when POP support was removed.
    1.59 @@ -465,7 +458,6 @@
    1.60  .Id mhshow
    1.61  .P
    1.62  Since the very beginning, already in the first concept paper,
    1.63 -.\" XXX ref!!!
    1.64  .Pn show
    1.65  had been MH's message display program.
    1.66  .Pn show
    1.67 @@ -582,7 +574,6 @@
    1.68  .Pn show
    1.69  first (cf. Sec.
    1.70  .Cf mhshow ).
    1.71 -.\" XXX code commits?
    1.72  Once the tools behaved more alike, the replacing appeared to be
    1.73  even more natural.
    1.74  Today, mmh's new
    1.75 @@ -599,24 +590,9 @@
    1.76  hurts in one regard: It had been such a simple program.
    1.77  Its lean elegance is missing from the new
    1.78  .Pn show ,
    1.79 -.\" XXX
    1.80 -however there is no alternative;
    1.81 +but there is no alternative;
    1.82  supporting MIME demands higher essential complexity.
    1.83  
    1.84 -.ig
    1.85 -XXX
    1.86 -Consider including text on scan listings here
    1.87 -
    1.88 -Scan listings shall not contain body content. Hence, removed this feature.
    1.89 -Scan listings shall operator on message headers and non-message information
    1.90 -only. Displaying the beginning of the body complicates everything too much.
    1.91 -That's no surprise, because it's something completely different. If you
    1.92 -want to examine the body, then use show(1)/mhshow(1).
    1.93 -Changed the default scan formats accordingly.
    1.94 -.Ci 70b2643e0da8485174480c644ad9785c84f5bff4
    1.95 -..
    1.96 -
    1.97 -
    1.98  
    1.99  
   1.100  .H2 "Configure Options
   1.101 @@ -680,7 +656,6 @@
   1.102  default SMTP servers could be specified
   1.103  .Ci 128545e06224233b7e91fc4c83f8830252fe16c9 .
   1.104  Both of them became irrelevant when the SMTP transport service was removed.
   1.105 -.\" XXX code ref
   1.106  In mmh, all messages are handed over to
   1.107  .Pn sendmail
   1.108  for transportation.
   1.109 @@ -691,7 +666,6 @@
   1.110  The backup prefix is the string that was prepended to message
   1.111  filenames to tag them as deleted.
   1.112  By default it had been the comma character (`\fL,\fP').
   1.113 -.\" XXX Zeitlich ordnen
   1.114  In July 2000, Kimmo Suominen introduced
   1.115  the configure option
   1.116  .Sw --with-hash-backup
   1.117 @@ -849,7 +823,7 @@
   1.118  .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf .
   1.119  The change removed functionality but that is considered minor to the
   1.120  improvement of dropping the dependency and the complex autoconf code.
   1.121 -.\" XXX argument: slocal ist sowieso nicht teil vom mmh kern
   1.122 +
   1.123  
   1.124  .U3 "MH-E Support
   1.125  .P
   1.126 @@ -952,8 +926,7 @@
   1.127  .Pn spost
   1.128  had not supported it yet.
   1.129  Username extensions can be used in mmh, but less convenient.
   1.130 -.\" XXX covered by next paragraph
   1.131 -.\" XXX format file %(getenv USERNAME_EXTENSION)
   1.132 +.\" XXX In the format file: %(getenv USERNAME_EXTENSION)
   1.133  .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
   1.134  .P
   1.135  The
   1.136 @@ -1009,7 +982,6 @@
   1.137  .P
   1.138  The command line switches of MH tools follow a style similar to
   1.139  the X Window System style.
   1.140 -.\" XXX ref
   1.141  The switches consist of a single dash (`\fL-\fP') followed by a word.
   1.142  For example
   1.143  .Cl -truncate .
   1.144 @@ -1047,7 +1019,6 @@
   1.145  Changing the behavior of programs provides flexibility and customization
   1.146  to users, but at the same time it complicates the code,
   1.147  the documentation, and the usage of the program.
   1.148 -.\" XXX: Ref
   1.149  Therefore, the number of switches should be kept small.
   1.150  A small set of well-chosen switches is best.
   1.151  Usually, the number of switches increases over time.
   1.152 @@ -1641,7 +1612,6 @@
   1.153  .LP
   1.154  I did so already in the months before.
   1.155  I pushed forward.
   1.156 -.\" XXX semicolon ?
   1.157  I simply dropped the cruft.
   1.158  .P
   1.159  The decision to drop a feature was based on literature research and
   1.160 @@ -1654,7 +1624,6 @@
   1.161  I was quick in dropping parts.
   1.162  I rather include falsely dropped parts again, than going at a slower pace.
   1.163  Mmh is experimental work; it requires tough decisions.
   1.164 -.\" XXX ``exp. work'' schon oft gesagt
   1.165  
   1.166  
   1.167  .U3 "Process Forking
   1.168 @@ -1893,7 +1862,6 @@
   1.169  MH's MIME support is a direct implementation of the RFCs.
   1.170  The perception of the topic described in the RFCs is clearly visible
   1.171  in MH's implementation.
   1.172 -.\" XXX rewrite ``no idea''.
   1.173  As a result,
   1.174  MH had all the MIME features but no idea of attachments.
   1.175  But users do not need all the MIME features,
   1.176 @@ -2190,8 +2158,6 @@
   1.177  Instead, information on how to retrieve them is output.
   1.178  Not supporting this rare case saved nearly one thousand lines of code
   1.179  .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32 .
   1.180 -.\" XXX mention somewhere else too: (The profile entry `nmh-access-ftp'
   1.181 -.\"     and sbr/ruserpass.c for reading ~/.netrc are gone now.)
   1.182  The MIME type `application/octet-stream; type=tar' is not special anymore.
   1.183  The automatically extracting of such MIME parts had been the
   1.184  dangerous part of the
   1.185 @@ -2269,11 +2235,6 @@
   1.186  .Pe mhshow-show-*
   1.187  profile entries before, if this is possible and wanted.
   1.188  A common example for this are PDF files.
   1.189 -.ig \"XXX
   1.190 -.Pe mhshow-show-*
   1.191 -profile entries can be used to display MIME parts in a specific way.
   1.192 -to display them in the terminal.
   1.193 -..
   1.194  In mmh, MIME parts are always displayed serially.
   1.195  The request to display the MIME type `multipart/parallel' in parallel
   1.196  is ignored.
   1.197 @@ -3303,7 +3264,6 @@
   1.198  path name.
   1.199  The result is a pointer to static memory.
   1.200  .P
   1.201 -.\" XXX ueberfluessig?
   1.202  The new functions have names that indicate their use.
   1.203  Two of the functions convert relative to absolute path names of the
   1.204  same type.
   1.205 @@ -3600,7 +3560,6 @@
   1.206  if systems do not support these standardized and widespread functions.
   1.207  This compromise is made because mmh focuses on the future.
   1.208  .P
   1.209 -.\" XXX kuerzen und mit dem naechsten Absatz vereinen
   1.210  As I am still in my twenties, have no programming experience from
   1.211  past decades.
   1.212  I have not followed the evolution of C through time.
   1.213 @@ -3866,7 +3825,6 @@
   1.214  21 programs depend on one source file only.
   1.215  (These numbers and the ones in the following text ignore the MH library
   1.216  as well as shell scripts and multiple names for the same program.)
   1.217 -.\" XXX graph
   1.218  .P
   1.219  Splitting the source code of a large program into multiple files can
   1.220  increase the readability of its source code,