git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v5 15/21] parse-options: add link to doc file in parse-options.h

From
Heba Waly via GitGitGadget <gitgitgadget@gmail.com>
Date
Nov 17, 2019, 21:04 UTC
Message-ID
<0e9e89fd8380f3f2a3b89ad02a05f87ea2251f1d.1574024701.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.434.v5.git.1574024700.gitgitgadget@gmail.com>
From: Heba Waly <heba.waly@gmail.com>

Add a link to Documentation/technical/api-parse-options.txt in parse-options.h So the developers would know where to find more info about the API.

Signed-off-by: Heba Waly <heba.waly@gmail.com>
---
 parse-options.h | 4 ++++
 1 file changed, 4 insertions(+)
diff --git a/parse-options.h b/parse-options.h
index 38a33a087e..164ec566b0 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -1,6 +1,10 @@
 #ifndef PARSE_OPTIONS_H
 #define PARSE_OPTIONS_H
 
+/**
+ * Refer to Documentation/technical/api-parse-options.txt for the API doc.
+ */
+
 enum parse_opt_type {
 	/* special types */
 	OPTION_END,
-- 
gitgitgadget
Previous: Heba Waly via GitGitGadgetNext: Heba Waly via GitGitGadget
Message 113 of 123 in “[Outreachy] Move doc to header files”
  1. 00/10 [Outreachy] Move doc to header filesHeba Waly via GitGitGadget, Oct 29, 2019
  2. 01/10 diff: move doc to diff.h and diffcore.hHeba Waly via GitGitGadget, Oct 29, 2019
  3. 03/10 graph: move doc to graph.h and graph.cHeba Waly via GitGitGadget, Oct 29, 2019
  4. 05/10 sha1-array: move doc to sha1-array.hHeba Waly via GitGitGadget, Oct 29, 2019
  5. 08/10 attr: move doc to attr.hHeba Waly via GitGitGadget, Oct 29, 2019
  6. 04/10 merge: move doc to ll-merge.hHeba Waly via GitGitGadget, Oct 29, 2019
  7. Elijah NewrenOct 30, 2019
  8. Heba WalyOct 31, 2019
  9. Junio C HamanoNov 2, 2019
  10. 10/10 pathspec: move doc to pathspec.hHeba Waly via GitGitGadget, Oct 29, 2019
  11. 07/10 refs: move doc to refs.hHeba Waly via GitGitGadget, Oct 29, 2019
  12. 06/10 remote: move doc to remote.h and refspec.hHeba Waly via GitGitGadget, Oct 29, 2019
  13. 09/10 revision: move doc to revision.hHeba Waly via GitGitGadget, Oct 29, 2019
  14. Emily ShafferOct 29, 2019
  15. 02/10 dir: move doc to dir.hHeba Waly via GitGitGadget, Oct 29, 2019
  16. 00/20 [Outreachy] Move doc to header filesHeba Waly via GitGitGadget, Nov 6, 2019
  17. 04/20 merge: move doc to ll-merge.hHeba Waly via GitGitGadget, Nov 6, 2019
  18. 05/20 sha1-array: move doc to sha1-array.hHeba Waly via GitGitGadget, Nov 6, 2019
  19. 06/20 remote: move doc to remote.h and refspec.hHeba Waly via GitGitGadget, Nov 6, 2019
  20. 09/20 revision: move doc to revision.hHeba Waly via GitGitGadget, Nov 6, 2019
  21. 03/20 graph: move doc to graph.h and graph.cHeba Waly via GitGitGadget, Nov 6, 2019
  22. 07/20 refs: move doc to refs.hHeba Waly via GitGitGadget, Nov 6, 2019
  23. 08/20 attr: move doc to attr.hHeba Waly via GitGitGadget, Nov 6, 2019
  24. 02/20 dir: move doc to dir.hHeba Waly via GitGitGadget, Nov 6, 2019
  25. Emily ShafferNov 7, 2019
  26. Heba WalyNov 11, 2019
  27. 13/20 argv-array: move doc to argv-array.hHeba Waly via GitGitGadget, Nov 6, 2019
  28. 16/20 run-command: move doc to run-command.hHeba Waly via GitGitGadget, Nov 6, 2019
  29. 15/20 parse-options: move doc to parse-options.hHeba Waly via GitGitGadget, Nov 6, 2019
  30. Junio C HamanoNov 11, 2019
  31. Heba WalyNov 11, 2019
  32. Junio C HamanoNov 12, 2019
  33. Heba WalyNov 15, 2019
  34. Junio C HamanoNov 15, 2019
  35. Emily ShafferNov 15, 2019
  36. Heba WalyNov 17, 2019
  37. 18/20 tree-walk: move doc to tree-walk.hHeba Waly via GitGitGadget, Nov 6, 2019
  38. 20/20 trace2: move doc to trace2.hHeba Waly via GitGitGadget, Nov 6, 2019
  39. 19/20 submodule-config: move doc to submodule-config.hHeba Waly via GitGitGadget, Nov 6, 2019
  40. 10/20 pathspec: move doc to pathspec.hHeba Waly via GitGitGadget, Nov 6, 2019
  41. Emily ShafferNov 7, 2019
  42. Heba WalyNov 10, 2019
  43. 14/20 credential: move doc to credential.hHeba Waly via GitGitGadget, Nov 6, 2019
  44. 17/20 trace: move doc to trace.hHeba Waly via GitGitGadget, Nov 6, 2019
  45. Emily ShafferNov 7, 2019
  46. 12/20 cache: move doc to cache.hHeba Waly via GitGitGadget, Nov 6, 2019
  47. Emily ShafferNov 6, 2019
  48. 11/20 sigchain: move doc to sigchain.hHeba Waly via GitGitGadget, Nov 6, 2019
  49. Emily ShafferNov 6, 2019
  50. Heba WalyNov 11, 2019
  51. 01/20 diff: move doc to diff.h and diffcore.hHeba Waly via GitGitGadget, Nov 6, 2019
  52. 00/21 [Outreachy] Move doc to header filesHeba Waly via GitGitGadget, Nov 11, 2019
  53. 01/21 diff: move doc to diff.h and diffcore.hHeba Waly via GitGitGadget, Nov 11, 2019
  54. Junio C HamanoNov 12, 2019
  55. Heba WalyNov 14, 2019
  56. 02/21 dir: move doc to dir.hHeba Waly via GitGitGadget, Nov 11, 2019
  57. 03/21 graph: move doc to graph.h and graph.cHeba Waly via GitGitGadget, Nov 11, 2019
  58. 05/21 sha1-array: move doc to sha1-array.hHeba Waly via GitGitGadget, Nov 11, 2019
  59. 04/21 merge: move doc to ll-merge.hHeba Waly via GitGitGadget, Nov 11, 2019
  60. 12/21 cache: move doc to cache.hHeba Waly via GitGitGadget, Nov 11, 2019
  61. Junio C HamanoNov 12, 2019
  62. Heba WalyNov 14, 2019
  63. 06/21 remote: move doc to remote.h and refspec.hHeba Waly via GitGitGadget, Nov 11, 2019
  64. 11/21 sigchain: move doc to sigchain.hHeba Waly via GitGitGadget, Nov 11, 2019
  65. 08/21 attr: move doc to attr.hHeba Waly via GitGitGadget, Nov 11, 2019
  66. 13/21 argv-array: move doc to argv-array.hHeba Waly via GitGitGadget, Nov 11, 2019
  67. 10/21 pathspec: move doc to pathspec.hHeba Waly via GitGitGadget, Nov 11, 2019
  68. 09/21 revision: move doc to revision.hHeba Waly via GitGitGadget, Nov 11, 2019
  69. 07/21 refs: move doc to refs.hHeba Waly via GitGitGadget, Nov 11, 2019
  70. 18/21 tree-walk: move doc to tree-walk.hHeba Waly via GitGitGadget, Nov 11, 2019
  71. 20/21 trace2: move doc to trace2.hHeba Waly via GitGitGadget, Nov 11, 2019
  72. Junio C HamanoNov 12, 2019
  73. Heba WalyNov 14, 2019
  74. 21/21 api-index: remove api doc index filesHeba Waly via GitGitGadget, Nov 11, 2019
  75. 15/21 parse-options: move doc to parse-options.hHeba Waly via GitGitGadget, Nov 11, 2019
  76. 19/21 submodule-config: move doc to submodule-config.hHeba Waly via GitGitGadget, Nov 11, 2019
  77. 16/21 run-command: move doc to run-command.hHeba Waly via GitGitGadget, Nov 11, 2019
  78. 17/21 trace: move doc to trace.hHeba Waly via GitGitGadget, Nov 11, 2019
  79. 14/21 credential: move doc to credential.hHeba Waly via GitGitGadget, Nov 11, 2019
  80. 00/21 [Outreachy] Move doc to header filesHeba Waly via GitGitGadget, Nov 15, 2019
  81. 01/21 diff: move doc to diff.h and diffcore.hHeba Waly via GitGitGadget, Nov 15, 2019
  82. 05/21 sha1-array: move doc to sha1-array.hHeba Waly via GitGitGadget, Nov 15, 2019
  83. 07/21 refs: move doc to refs.hHeba Waly via GitGitGadget, Nov 15, 2019
  84. 09/21 revision: move doc to revision.hHeba Waly via GitGitGadget, Nov 15, 2019
  85. 10/21 pathspec: move doc to pathspec.hHeba Waly via GitGitGadget, Nov 15, 2019
  86. 12/21 cache: move doc to cache.hHeba Waly via GitGitGadget, Nov 15, 2019
  87. 04/21 merge: move doc to ll-merge.hHeba Waly via GitGitGadget, Nov 15, 2019
  88. 11/21 sigchain: move doc to sigchain.hHeba Waly via GitGitGadget, Nov 15, 2019
  89. 08/21 attr: move doc to attr.hHeba Waly via GitGitGadget, Nov 15, 2019
  90. 15/21 parse-options: move doc to parse-options.hHeba Waly via GitGitGadget, Nov 15, 2019
  91. 16/21 run-command: move doc to run-command.hHeba Waly via GitGitGadget, Nov 15, 2019
  92. 19/21 submodule-config: move doc to submodule-config.hHeba Waly via GitGitGadget, Nov 15, 2019
  93. 21/21 api-index: remove api doc index filesHeba Waly via GitGitGadget, Nov 15, 2019
  94. 18/21 tree-walk: move doc to tree-walk.hHeba Waly via GitGitGadget, Nov 15, 2019
  95. 20/21 trace2: move doc to trace2.hHeba Waly via GitGitGadget, Nov 15, 2019
  96. 17/21 trace: move doc to trace.hHeba Waly via GitGitGadget, Nov 15, 2019
  97. 06/21 remote: move doc to remote.h and refspec.hHeba Waly via GitGitGadget, Nov 15, 2019
  98. 14/21 credential: move doc to credential.hHeba Waly via GitGitGadget, Nov 15, 2019
  99. 13/21 argv-array: move doc to argv-array.hHeba Waly via GitGitGadget, Nov 15, 2019
  100. 02/21 dir: move doc to dir.hHeba Waly via GitGitGadget, Nov 15, 2019
  101. 03/21 graph: move doc to graph.h and graph.cHeba Waly via GitGitGadget, Nov 15, 2019
  102. 00/21 [Outreachy] Move doc to header filesHeba Waly via GitGitGadget, Nov 17, 2019
  103. 01/21 diff: move doc to diff.h and diffcore.hHeba Waly via GitGitGadget, Nov 17, 2019
  104. 03/21 graph: move doc to graph.h and graph.cHeba Waly via GitGitGadget, Nov 17, 2019
  105. 02/21 dir: move doc to dir.hHeba Waly via GitGitGadget, Nov 17, 2019
  106. 04/21 merge: move doc to ll-merge.hHeba Waly via GitGitGadget, Nov 17, 2019
  107. 06/21 remote: move doc to remote.h and refspec.hHeba Waly via GitGitGadget, Nov 17, 2019
  108. 05/21 sha1-array: move doc to sha1-array.hHeba Waly via GitGitGadget, Nov 17, 2019
  109. 07/21 refs: move doc to refs.hHeba Waly via GitGitGadget, Nov 17, 2019
  110. 08/21 attr: move doc to attr.hHeba Waly via GitGitGadget, Nov 17, 2019
  111. 09/21 revision: move doc to revision.hHeba Waly via GitGitGadget, Nov 17, 2019
  112. 11/21 sigchain: move doc to sigchain.hHeba Waly via GitGitGadget, Nov 17, 2019
  113. 15/21 parse-options: add link to doc file in parse-options.hHeba Waly via GitGitGadget, Nov 17, 2019
  114. 19/21 submodule-config: move doc to submodule-config.hHeba Waly via GitGitGadget, Nov 17, 2019
  115. 13/21 argv-array: move doc to argv-array.hHeba Waly via GitGitGadget, Nov 17, 2019
  116. 18/21 tree-walk: move doc to tree-walk.hHeba Waly via GitGitGadget, Nov 17, 2019
  117. 16/21 run-command: move doc to run-command.hHeba Waly via GitGitGadget, Nov 17, 2019
  118. 21/21 api-index: remove api doc index filesHeba Waly via GitGitGadget, Nov 17, 2019
  119. 20/21 trace2: move doc to trace2.hHeba Waly via GitGitGadget, Nov 17, 2019
  120. 17/21 trace: move doc to trace.hHeba Waly via GitGitGadget, Nov 17, 2019
  121. 14/21 credential: move doc to credential.hHeba Waly via GitGitGadget, Nov 17, 2019
  122. 12/21 cache: move doc to cache.hHeba Waly via GitGitGadget, Nov 17, 2019
  123. 10/21 pathspec: move doc to pathspec.hHeba Waly via GitGitGadget, Nov 17, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.