path: root/graph.c
diff options
authorHeba Waly <>2019-11-17 21:04:42 (GMT)
committerJunio C Hamano <>2019-11-18 06:21:28 (GMT)
commit3f1480b745b70e9f7c0629b58a98ddcb516490bb (patch)
tree1d45365ddb9d471e3a0bed13b00b85494203be7e /graph.c
parent266f03eccd36b84c88206aa6d18b163223294229 (diff)
graph: move doc to graph.h and graph.c
Move the documentation from Documentation/technical/api-history-graph.txt to graph.h and graph.c as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. The graph library was already well documented, so few comments were added to both graph.h and graph.c Also documentation/technical/api-history-graph.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and synchronized with the documentation in the header file. Signed-off-by: Heba Waly <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'graph.c')
1 files changed, 1 insertions, 0 deletions
diff --git a/graph.c b/graph.c
index f531354..eab3af1 100644
--- a/graph.c
+++ b/graph.c
@@ -34,6 +34,7 @@ static void graph_padding_line(struct git_graph *graph, struct strbuf *sb);
* handle directly. It is assumed that this is the same file handle as the
* file specified by the graph diff options. This is necessary so that
* graph_show_strbuf can be called even with a NULL graph.
+ * If a NULL graph is supplied, the strbuf is printed as-is.
static void graph_show_strbuf(struct git_graph *graph,
FILE *file,