Re: [PATCH] sub-process: fix comment about api-sub-process.txt

Jonathan Nieder [off-list ref] writes:

Christian Couder wrote:

quoted

Subject: sub-process: fix comment about api-sub-process.txt

nit: this one-line description doesn't describe what was wrong and is
being fixed.  I think something like

	sub-process: correct path to API docs in comment

would be easier to understand in "git log" output.

Indeed.  Thanks.

quoted

Signed-off-by: Christian Couder <redacted>
---
 sub-process.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

With or without such a tweak,
Reviewed-by: Jonathan Nieder <redacted>

quoted

diff --git a/sub-process.h b/sub-process.h
index 7d451e1cde..d9a45cd359 100644
--- a/sub-process.h
+++ b/sub-process.h

@@ -7,7 +7,7 @@
 
 /*
  * Generic implementation of background process infrastructure.
- * See Documentation/technical/api-background-process.txt.
+ * See: Documentation/technical/api-sub-process.txt
  */
 
  /* data structures */