docs/master
diff preface.roff @ 230:96778c1afc3e
More cleanups.
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Mon, 16 Jul 2012 00:37:31 +0200 |
parents | 1fa5a74bf138 |
children | e526e3cb85d3 |
line diff
1.1 --- a/preface.roff Mon Jul 16 00:20:31 2012 +0200 1.2 +++ b/preface.roff Mon Jul 16 00:37:31 2012 +0200 1.3 @@ -223,21 +223,20 @@ 1.4 Chapter 3 finishes up by summarizing the achievements and taking 1.5 a look into the future of the mmh project. 1.6 .P 1.7 -.I "Italic font 1.8 -is used to emphasize new terms, and for names of software projects, 1.9 -literature, and man pages. 1.10 -.CW "Constant width font 1.11 -is used to denote names of programs, files, 1.12 -functions, command lines, code excerpts, program input and output. 1.13 +.I "Italic 1.14 +font is used for names of software projects, literature, and man pages, 1.15 +as well as to emphasize new terms. 1.16 +.CW "Constant width 1.17 +font is used to denote names of programs, files, functions, 1.18 +command lines, code excerpts, program input and output, and the like. 1.19 .P 1.20 References to man pages are printed as ``\c 1.21 -.Mp cat (1)''. 1.22 -In this case it is a reference to the man page of 1.23 -.Pn cat , 1.24 -which is in section one of the Unix manual. 1.25 +.Mp cat (1)'', 1.26 +which is a reference to the man page of 1.27 +.Pn cat 1.28 +in section one of the Unix manual. 1.29 \fIRequests for Comments\fP (RFCs), which describe the working 1.30 of the Internet, are referenced as ``RFC\|821''. 1.31 -A list of relevant RFCs is located at the end of the document. 1.32 Literature is cited in brackets, such as 1.33 .[ ``[ 1.34 kernighan pike unix programming env 1.35 @@ -245,8 +244,8 @@ 1.36 Citations of email messages and websites are distinguished by 1.37 ``mail:'' and ``web:'' prefixes. 1.38 All references are collected at the end of the document. 1.39 -The websites of the software projects mentioned are collected 1.40 -in a list in the appendix. 1.41 +Links to the software projects mentioned throughout 1.42 +the text are collected there as well. 1.43 .P 1.44 This document describes practical programming work. 1.45 The code of mmh is managed with the 1.46 @@ -256,19 +255,14 @@ 1.47 In the discussions, references to corresponding code changes are printed 1.48 as ``\c 1.49 .Ci 1a2b3c4 ''. 1.50 -The identifier is the seven-letter-prefix of the changeset hash value, 1.51 +The identifier is the seven-letter-prefix of the changeset's hash value, 1.52 which is considered unique. 1.53 -A change can be looked up in the repository, on the command line with 1.54 -.Cl "git show XXX" , 1.55 -replacing `\f(CWXXX\fP' with the concrete hash value or any unique prefix. 1.56 -In this example: 1.57 -.Cl "git show 1a2b3c4" . 1.58 -At the time of writing, changesets can be looked up online at: 1.59 -.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=XXX" . 1.60 +Any change can be looked up in the repository, using the command line 1.61 +.Cl "git show 1234567" . 1.62 +(`\f(CW1234567\fP' needs to be replaced with the concrete hash value.) 1.63 +At the time of writing, changesets could be looked up online at: 1.64 +.CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=1234567" \|. 1.65 But as we all know, URIs are always at risk to change. 1.66 -.P 1.67 -Whenever lines of code were determined, David A. Wheeler's \fIsloccount\fP 1.68 -was used to measure the amount in a comparable way. 1.69 1.70 1.71 .U2 "Acknowledgments