aboutsummaryrefslogtreecommitdiff
path: root/forged/internal/git2c/cmd_index.go
diff options
context:
space:
mode:
Diffstat (limited to 'forged/internal/git2c/cmd_index.go')
-rw-r--r--forged/internal/git2c/cmd_index.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/forged/internal/git2c/cmd_index.go b/forged/internal/git2c/cmd_index.go
index a705a63..8862b2c 100644
--- a/forged/internal/git2c/cmd_index.go
+++ b/forged/internal/git2c/cmd_index.go
@@ -10,6 +10,8 @@ import (
"io"
)
+// CmdIndex requests a repository index from git2d and returns the list of commits
+// and the contents of a README file if available.
func (c *Client) CmdIndex(repoPath string) ([]Commit, *FilenameContents, error) {
if err := c.writer.WriteData([]byte(repoPath)); err != nil {
return nil, nil, fmt.Errorf("sending repo path failed: %w", err)