Google Git
Sign in
googlers / jrn / git / f430ed8b9991769073bf3095702f8e8801b365fc
commitf430ed8b9991769073bf3095702f8e8801b365fc[log] [tgz]
authorJohn Keeping <john@keeping.me.uk>Sun Dec 16 14:00:29 2012 +0000
committerJunio C Hamano <gitster@pobox.com>Sun Dec 16 17:59:07 2012 -0800
tree45f29760739684ebfd3ba04fea96eb91bc1ad00d
parentbdd478d620034dc6517aea940f5dc6b88f780c04 [diff]
Documentation: don't link to example mail addresses

Email addresses in documentation are converted into mailto: hyperlinks
in the HTML output and footnotes in man pages.  This isn't desirable for
cases where the address is used as an example and is not valid.

Particularly annoying is the example "jane@laptop.(none)" which appears
in git-shortlog(1) as "jane@laptop[1].(none)", with note 1 saying:

	1. jane@laptop
	   mailto:jane@laptop

Fix this by escaping these email addresses with a leading backslash, to
prevent Asciidoc expanding them as inline macros.

In the case of mailmap.txt, render the address monospaced so that it
matches the block examples surrounding that paragraph.

Helped-by: Jeff King <peff@peff.net>
Signed-off-by: John Keeping <john@keeping.me.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
3 files changed
tree: 45f29760739684ebfd3ba04fea96eb91bc1ad00d
  1. block-sha1/
  2. builtin/
  3. compat/
  4. contrib/
  5. Documentation/
  6. git-gui/
  7. git_remote_helpers/
  8. gitk-git/
  9. gitweb/
  10. mergetools/
  11. perl/
  12. po/
  13. ppc/
  14. t/
  15. templates/
  16. vcs-svn/
  17. xdiff/
  18. RelNotes ⇨ Documentation/RelNotes/1.8.0.2.txt
  19. .gitattributes
  20. .gitignore
  21. .mailmap
  22. abspath.c
  23. aclocal.m4
  24. advice.c
  25. advice.h
  26. alias.c
  27. alloc.c
  28. archive-tar.c
  29. archive-zip.c
  30. archive.c
  31. archive.h
  32. argv-array.c
  33. argv-array.h
  34. attr.c
  35. attr.h
  36. base85.c
  37. bisect.c
  38. bisect.h
  39. blob.c
  40. blob.h
  41. branch.c
  42. branch.h
  43. builtin.h
  44. bulk-checkin.c
  45. bulk-checkin.h
  46. bundle.c
  47. bundle.h
  48. cache-tree.c
  49. cache-tree.h
  50. cache.h
  51. check-builtins.sh
  52. check-racy.c
  53. check_bindir
  54. color.c
  55. color.h
  56. column.c
  57. column.h
  58. combine-diff.c
  59. command-list.txt
  60. commit.c
  61. commit.h
  62. config.c
  63. config.mak.in
  64. configure.ac
  65. connect.c
  66. connected.c
  67. connected.h
  68. convert.c
  69. convert.h
  70. copy.c
  71. COPYING
  72. credential-cache--daemon.c
  73. credential-cache.c
  74. credential-store.c
  75. credential.c
  76. credential.h
  77. csum-file.c
  78. csum-file.h
  79. ctype.c
  80. daemon.c
  81. date.c
  82. decorate.c
  83. decorate.h
  84. delta.h
  85. diff-delta.c
  86. diff-lib.c
  87. diff-no-index.c
  88. diff.c
  89. diff.h
  90. diffcore-break.c
  91. diffcore-delta.c
  92. diffcore-order.c
  93. diffcore-pickaxe.c
  94. diffcore-rename.c
  95. diffcore.h
  96. dir.c
  97. dir.h
  98. editor.c
  99. entry.c
  100. environment.c
  101. exec_cmd.c
  102. exec_cmd.h
  103. fast-import.c
  104. fetch-pack.h
  105. fixup-builtins
  106. fmt-merge-msg.h
  107. fsck.c
  108. fsck.h
  109. generate-cmdlist.sh
  110. gettext.c
  111. gettext.h
  112. git-add--interactive.perl
  113. git-am.sh
  114. git-archimport.perl
  115. git-bisect.sh
  116. git-compat-util.h
  117. git-cvsexportcommit.perl
  118. git-cvsimport.perl
  119. git-cvsserver.perl
  120. git-difftool--helper.sh
  121. git-difftool.perl
  122. git-filter-branch.sh
  123. git-instaweb.sh
  124. git-lost-found.sh
  125. git-merge-octopus.sh
  126. git-merge-one-file.sh
  127. git-merge-resolve.sh
  128. git-mergetool--lib.sh
  129. git-mergetool.sh
  130. git-p4.py
  131. git-parse-remote.sh
  132. git-pull.sh
  133. git-quiltimport.sh
  134. git-rebase--am.sh
  135. git-rebase--interactive.sh
  136. git-rebase--merge.sh
  137. git-rebase.sh
  138. git-relink.perl
  139. git-remote-testgit.py
  140. git-repack.sh
  141. git-request-pull.sh
  142. git-send-email.perl
  143. git-sh-i18n.sh
  144. git-sh-setup.sh
  145. git-stash.sh
  146. git-submodule.sh
  147. git-svn.perl
  148. GIT-VERSION-GEN
  149. git-web--browse.sh
  150. git.c
  151. git.spec.in
  152. gpg-interface.c
  153. gpg-interface.h
  154. graph.c
  155. graph.h
  156. grep.c
  157. grep.h
  158. hash.c
  159. hash.h
  160. help.c
  161. help.h
  162. hex.c
  163. http-backend.c
  164. http-fetch.c
  165. http-push.c
  166. http-walker.c
  167. http.c
  168. http.h
  169. ident.c
  170. imap-send.c
  171. INSTALL
  172. kwset.c
  173. kwset.h
  174. levenshtein.c
  175. levenshtein.h
  176. LGPL-2.1
  177. list-objects.c
  178. list-objects.h
  179. ll-merge.c
  180. ll-merge.h
  181. lockfile.c
  182. log-tree.c
  183. log-tree.h
  184. mailmap.c
  185. mailmap.h
  186. Makefile
  187. match-trees.c
  188. merge-file.c
  189. merge-file.h
  190. merge-recursive.c
  191. merge-recursive.h
  192. mergesort.c
  193. mergesort.h
  194. name-hash.c
  195. notes-cache.c
  196. notes-cache.h
  197. notes-merge.c
  198. notes-merge.h
  199. notes.c
  200. notes.h
  201. object.c
  202. object.h
  203. pack-check.c
  204. pack-refs.c
  205. pack-refs.h
  206. pack-revindex.c
  207. pack-revindex.h
  208. pack-write.c
  209. pack.h
  210. pager.c
  211. parse-options-cb.c
  212. parse-options.c
  213. parse-options.h
  214. patch-delta.c
  215. patch-ids.c
  216. patch-ids.h
  217. path.c
  218. pkt-line.c
  219. pkt-line.h
  220. preload-index.c
  221. pretty.c
  222. progress.c
  223. progress.h
  224. prompt.c
  225. prompt.h
  226. quote.c
  227. quote.h
  228. reachable.c
  229. reachable.h
  230. read-cache.c
  231. README
  232. reflog-walk.c
  233. reflog-walk.h
  234. refs.c
  235. refs.h
  236. remote-curl.c
  237. remote.c
  238. remote.h
  239. replace_object.c
  240. rerere.c
  241. rerere.h
  242. resolve-undo.c
  243. resolve-undo.h
  244. revision.c
  245. revision.h
  246. run-command.c
  247. run-command.h
  248. send-pack.h
  249. sequencer.c
  250. sequencer.h
  251. server-info.c
  252. setup.c
  253. sh-i18n--envsubst.c
  254. sha1-array.c
  255. sha1-array.h
  256. sha1-lookup.c
  257. sha1-lookup.h
  258. sha1_file.c
  259. sha1_name.c
  260. shallow.c
  261. shell.c
  262. shortlog.h
  263. show-index.c
  264. sideband.c
  265. sideband.h
  266. sigchain.c
  267. sigchain.h
  268. strbuf.c
  269. strbuf.h
  270. streaming.c
  271. streaming.h
  272. string-list.c
  273. string-list.h
  274. submodule.c
  275. submodule.h
  276. symlinks.c
  277. tag.c
  278. tag.h
  279. tar.h
  280. test-chmtime.c
  281. test-ctype.c
  282. test-date.c
  283. test-delta.c
  284. test-dump-cache-tree.c
  285. test-genrandom.c
  286. test-index-version.c
  287. test-line-buffer.c
  288. test-match-trees.c
  289. test-mergesort.c
  290. test-mktemp.c
  291. test-parse-options.c
  292. test-path-utils.c
  293. test-regex.c
  294. test-revision-walking.c
  295. test-run-command.c
  296. test-scrap-cache-tree.c
  297. test-sha1.c
  298. test-sha1.sh
  299. test-sigchain.c
  300. test-string-list.c
  301. test-subprocess.c
  302. test-svn-fe.c
  303. thread-utils.c
  304. thread-utils.h
  305. trace.c
  306. transport-helper.c
  307. transport.c
  308. transport.h
  309. tree-diff.c
  310. tree-walk.c
  311. tree-walk.h
  312. tree.c
  313. tree.h
  314. unimplemented.sh
  315. unix-socket.c
  316. unix-socket.h
  317. unpack-trees.c
  318. unpack-trees.h
  319. upload-pack.c
  320. url.c
  321. url.h
  322. usage.c
  323. userdiff.c
  324. userdiff.h
  325. utf8.c
  326. utf8.h
  327. varint.c
  328. varint.h
  329. version.c
  330. version.h
  331. walker.c
  332. walker.h
  333. wrap-for-bin.sh
  334. wrapper.c
  335. write_or_die.c
  336. ws.c
  337. wt-status.c
  338. wt-status.h
  339. xdiff-interface.c
  340. xdiff-interface.h
  341. zlib.c