add comment

lunny · lunny · commit 195afb93b3e8 · 2025-10-08T09:45:17.000-07:00
diff --git a/services/pull/merge_prepare.go b/services/pull/merge_prepare.go
@@ -32,6 +32,9 @@ type mergeContext struct {
 	env       []string
 }
 
+// PrepareGitCmd prepares a git command with the correct directory, environment, and output buffers
+// This function can only be called with gitcmd.Run()
+// Do NOT use it with gitcmd.RunStd*() functions, otherwise it will panic
 func (ctx *mergeContext) PrepareGitCmd(cmd *gitcmd.Command) *gitcmd.Command {
 	ctx.outbuf.Reset()
 	ctx.errbuf.Reset()

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ type mergeContext struct {`
`32`	`32`	`env []string`
`33`	`33`	`}`
`34`	`34`
	`35`	`+// PrepareGitCmd prepares a git command with the correct directory, environment, and output buffers`
	`36`	`+// This function can only be called with gitcmd.Run()`
	`37`	`+// Do NOT use it with gitcmd.RunStd*() functions, otherwise it will panic`
`35`	`38`	`func (ctx mergeContext) PrepareGitCmd(cmd gitcmd.Command) *gitcmd.Command {`
`36`	`39`	`ctx.outbuf.Reset()`
`37`	`40`	`ctx.errbuf.Reset()`