add comment

lunny · lunny · commit 1183b33a7f3b · 2025-10-08T09:53:06.000-07:00
diff --git a/services/pull/temp_repo.go b/services/pull/temp_repo.go
@@ -37,6 +37,9 @@ type prTmpRepoContext struct {
 	errbuf      *strings.Builder // any use should be preceded by a Reset and preferably after use
 }
 
+// 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 *prTmpRepoContext) PrepareGitCmd(cmd *gitcmd.Command) *gitcmd.Command {
 	ctx.outbuf.Reset()
 	ctx.errbuf.Reset()

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,9 @@ type prTmpRepoContext struct {`
`37`	`37`	`errbuf *strings.Builder // any use should be preceded by a Reset and preferably after use`
`38`	`38`	`}`
`39`	`39`
	`40`	`+// PrepareGitCmd prepares a git command with the correct directory, environment, and output buffers`
	`41`	`+// This function can only be called with gitcmd.Run()`
	`42`	`+// Do NOT use it with gitcmd.RunStd*() functions, otherwise it will panic`
`40`	`43`	`func (ctx prTmpRepoContext) PrepareGitCmd(cmd gitcmd.Command) *gitcmd.Command {`
`41`	`44`	`ctx.outbuf.Reset()`
`42`	`45`	`ctx.errbuf.Reset()`