docs/master
changeset 230:96778c1afc3e
More cleanups.
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Mon, 16 Jul 2012 00:37:31 +0200 |
parents | a03308feb1f2 |
children | e526e3cb85d3 |
files | colophon.roff discussion.roff preface.roff |
diffstat | 3 files changed, 22 insertions(+), 25 deletions(-) [+] |
line diff
1.1 --- a/colophon.roff Mon Jul 16 00:20:31 2012 +0200 1.2 +++ b/colophon.roff Mon Jul 16 00:37:31 2012 +0200 1.3 @@ -53,7 +53,7 @@ 1.4 Dimitar Zhekov's \fITerminus\fP font. 1.5 Both are free typefaces. 1.6 .P 1.7 -The layout of the inner pages of this document were modeled after 1.8 +The layout of the inner pages of this document is modeled after 1.9 the German book \fIEinf\[udieresis]hrung in die Automatentheorie, 1.10 Formale Sprache und Komplexit\[adieresis]tstheorie\fP 1.11 by Hopcroft and Ullman, Addison-Wesley, 1990.
2.1 --- a/discussion.roff Mon Jul 16 00:20:31 2012 +0200 2.2 +++ b/discussion.roff Mon Jul 16 00:37:31 2012 +0200 2.3 @@ -10,6 +10,9 @@ 2.4 nmh at the time when the mmh project had started, i.e. fall 2011. 2.5 Recent changes in nmh are rarely part of the discussion. 2.6 .P 2.7 +Whenever lines of code were counted, David A. Wheeler's \fIsloccount\fP 2.8 +was used to measure the amount in a comparable way. 2.9 +.P 2.10 For the reader's convenience, the structure of modern email systems 2.11 is depicted in the following figure. 2.12 It illustrates the path a message takes from sender to recipient.
3.1 --- a/preface.roff Mon Jul 16 00:20:31 2012 +0200 3.2 +++ b/preface.roff Mon Jul 16 00:37:31 2012 +0200 3.3 @@ -223,21 +223,20 @@ 3.4 Chapter 3 finishes up by summarizing the achievements and taking 3.5 a look into the future of the mmh project. 3.6 .P 3.7 -.I "Italic font 3.8 -is used to emphasize new terms, and for names of software projects, 3.9 -literature, and man pages. 3.10 -.CW "Constant width font 3.11 -is used to denote names of programs, files, 3.12 -functions, command lines, code excerpts, program input and output. 3.13 +.I "Italic 3.14 +font is used for names of software projects, literature, and man pages, 3.15 +as well as to emphasize new terms. 3.16 +.CW "Constant width 3.17 +font is used to denote names of programs, files, functions, 3.18 +command lines, code excerpts, program input and output, and the like. 3.19 .P 3.20 References to man pages are printed as ``\c 3.21 -.Mp cat (1)''. 3.22 -In this case it is a reference to the man page of 3.23 -.Pn cat , 3.24 -which is in section one of the Unix manual. 3.25 +.Mp cat (1)'', 3.26 +which is a reference to the man page of 3.27 +.Pn cat 3.28 +in section one of the Unix manual. 3.29 \fIRequests for Comments\fP (RFCs), which describe the working 3.30 of the Internet, are referenced as ``RFC\|821''. 3.31 -A list of relevant RFCs is located at the end of the document. 3.32 Literature is cited in brackets, such as 3.33 .[ ``[ 3.34 kernighan pike unix programming env 3.35 @@ -245,8 +244,8 @@ 3.36 Citations of email messages and websites are distinguished by 3.37 ``mail:'' and ``web:'' prefixes. 3.38 All references are collected at the end of the document. 3.39 -The websites of the software projects mentioned are collected 3.40 -in a list in the appendix. 3.41 +Links to the software projects mentioned throughout 3.42 +the text are collected there as well. 3.43 .P 3.44 This document describes practical programming work. 3.45 The code of mmh is managed with the 3.46 @@ -256,19 +255,14 @@ 3.47 In the discussions, references to corresponding code changes are printed 3.48 as ``\c 3.49 .Ci 1a2b3c4 ''. 3.50 -The identifier is the seven-letter-prefix of the changeset hash value, 3.51 +The identifier is the seven-letter-prefix of the changeset's hash value, 3.52 which is considered unique. 3.53 -A change can be looked up in the repository, on the command line with 3.54 -.Cl "git show XXX" , 3.55 -replacing `\f(CWXXX\fP' with the concrete hash value or any unique prefix. 3.56 -In this example: 3.57 -.Cl "git show 1a2b3c4" . 3.58 -At the time of writing, changesets can be looked up online at: 3.59 -.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=XXX" . 3.60 +Any change can be looked up in the repository, using the command line 3.61 +.Cl "git show 1234567" . 3.62 +(`\f(CW1234567\fP' needs to be replaced with the concrete hash value.) 3.63 +At the time of writing, changesets could be looked up online at: 3.64 +.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=1234567" \|. 3.65 But as we all know, URIs are always at risk to change. 3.66 -.P 3.67 -Whenever lines of code were determined, David A. Wheeler's \fIsloccount\fP 3.68 -was used to measure the amount in a comparable way. 3.69 3.70 3.71 .U2 "Acknowledgments