Mercurial > docs > master

comparison preface.roff @ 230:96778c1afc3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More cleanups.
author markus schnalke <meillo@marmaro.de>
date Mon, 16 Jul 2012 00:37:31 +0200
parents 1fa5a74bf138
children e526e3cb85d3
comparison
equal deleted inserted replaced
229:a03308feb1f2 230:96778c1afc3e
221 Instead, important changes and those standing for a set of similar 221 Instead, important changes and those standing for a set of similar
222 changes are described and discussed. 222 changes are described and discussed.
223 Chapter 3 finishes up by summarizing the achievements and taking 223 Chapter 3 finishes up by summarizing the achievements and taking
224 a look into the future of the mmh project. 224 a look into the future of the mmh project.
225 .P 225 .P
226 .I "Italic font 226 .I "Italic
227 is used to emphasize new terms, and for names of software projects, 227 font is used for names of software projects, literature, and man pages,
228 literature, and man pages. 228 as well as to emphasize new terms.
229 .CW "Constant width font 229 .CW "Constant width
230 is used to denote names of programs, files, 230 font is used to denote names of programs, files, functions,
231 functions, command lines, code excerpts, program input and output. 231 command lines, code excerpts, program input and output, and the like.
232 .P 232 .P
233 References to man pages are printed as ``\c 233 References to man pages are printed as ``\c
234 .Mp cat (1)''. 234 .Mp cat (1)'',
235 In this case it is a reference to the man page of 235 which is a reference to the man page of
236 .Pn cat , 236 .Pn cat
237 which is in section one of the Unix manual. 237 in section one of the Unix manual.
238 \fIRequests for Comments\fP (RFCs), which describe the working 238 \fIRequests for Comments\fP (RFCs), which describe the working
239 of the Internet, are referenced as ``RFC\|821''. 239 of the Internet, are referenced as ``RFC\|821''.
240 A list of relevant RFCs is located at the end of the document.
241 Literature is cited in brackets, such as 240 Literature is cited in brackets, such as
242 .[ ``[ 241 .[ ``[
243 kernighan pike unix programming env 242 kernighan pike unix programming env
244 .]]''. 243 .]]''.
245 Citations of email messages and websites are distinguished by 244 Citations of email messages and websites are distinguished by
246 ``mail:'' and ``web:'' prefixes. 245 ``mail:'' and ``web:'' prefixes.
247 All references are collected at the end of the document. 246 All references are collected at the end of the document.
248 The websites of the software projects mentioned are collected 247 Links to the software projects mentioned throughout
249 in a list in the appendix. 248 the text are collected there as well.
250 .P 249 .P
251 This document describes practical programming work. 250 This document describes practical programming work.
252 The code of mmh is managed with the 251 The code of mmh is managed with the
253 .Pn git 252 .Pn git
254 version control system. 253 version control system.
255 All code changes were checked in. 254 All code changes were checked in.
256 In the discussions, references to corresponding code changes are printed 255 In the discussions, references to corresponding code changes are printed
257 as ``\c 256 as ``\c
258 .Ci 1a2b3c4 ''. 257 .Ci 1a2b3c4 ''.
259 The identifier is the seven-letter-prefix of the changeset hash value, 258 The identifier is the seven-letter-prefix of the changeset's hash value,
260 which is considered unique. 259 which is considered unique.
261 A change can be looked up in the repository, on the command line with 260 Any change can be looked up in the repository, using the command line
262 .Cl "git show XXX" , 261 .Cl "git show 1234567" .
263 replacing `\f(CWXXX\fP' with the concrete hash value or any unique prefix. 262 (`\f(CW1234567\fP' needs to be replaced with the concrete hash value.)
264 In this example: 263 At the time of writing, changesets could be looked up online at:
265 .Cl "git show 1a2b3c4" . 264 .CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=1234567" \|.
266 At the time of writing, changesets can be looked up online at:
267 .CW "http://git.marmaro.de/?p=mmh;a=commitdiff;h=XXX" .
268 But as we all know, URIs are always at risk to change. 265 But as we all know, URIs are always at risk to change.
269 .P
270 Whenever lines of code were determined, David A. Wheeler's \fIsloccount\fP
271 was used to measure the amount in a comparable way.
272 266
273 267
274 .U2 "Acknowledgments 268 .U2 "Acknowledgments
275 .P 269 .P
276 .\"so thanks 270 .\"so thanks