diff options
| author | Runxi Yu <me@runxiyu.org> | 2025-04-06 09:58:02 +0800 |
|---|---|---|
| committer | Runxi Yu <me@runxiyu.org> | 2025-04-06 09:58:02 +0800 |
| commit | 6f5e22e764283262ae8c6519bb030766db0fd35b (patch) | |
| tree | c56038bd7b5dc31d5bae5dd6e323688725c5262e /forged/internal/git2c/cmd_index.go | |
| parent | Fix load ordering issue that causes the forge title to disappear (diff) | |
| download | forge-6f5e22e764283262ae8c6519bb030766db0fd35b.tar.gz forge-6f5e22e764283262ae8c6519bb030766db0fd35b.tar.zst forge-6f5e22e764283262ae8c6519bb030766db0fd35b.zip | |
Add more documentation comments
Diffstat (limited to 'forged/internal/git2c/cmd_index.go')
| -rw-r--r-- | forged/internal/git2c/cmd_index.go | 2 |
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) |