Google Git
Sign in
code/git/c455bd8950e0e5593949b746ad96d1449bbbf9d5
commit
c455bd8950e0e5593949b746ad96d1449bbbf9d5
[log] [tgz]
author
Štěpán Němec <stepnem@gmail.com>
Thu Nov 04 18:12:48 2010 +0100
committer
Junio C Hamano <gitster@pobox.com>
Fri Nov 05 10:03:17 2010 -0700
tree
c664bda9ebeb837cc12e70daed5127ca33459525
parent
ca209065f3cc3462eb0ae6090f6b13f38aa2114c [diff]
CodingGuidelines: Add a section on writing documentation

Provide a few examples on argument and option notation in usage strings
and command synopses.

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