From 6f5e22e764283262ae8c6519bb030766db0fd35b Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 6 Apr 2025 09:58:02 +0800 Subject: Add more documentation comments --- forged/internal/git2c/client.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'forged/internal/git2c/client.go') diff --git a/forged/internal/git2c/client.go b/forged/internal/git2c/client.go index d178c47..82454d1 100644 --- a/forged/internal/git2c/client.go +++ b/forged/internal/git2c/client.go @@ -11,13 +11,15 @@ import ( "git.sr.ht/~sircmpwn/go-bare" ) +// Client represents a connection to the git2d backend daemon. type Client struct { - SocketPath string + socketPath string conn net.Conn writer *bare.Writer reader *bare.Reader } +// NewClient establishes a connection to a git2d socket and returns a new Client. func NewClient(socketPath string) (*Client, error) { conn, err := net.Dial("unix", socketPath) if err != nil { @@ -28,13 +30,14 @@ func NewClient(socketPath string) (*Client, error) { reader := bare.NewReader(conn) return &Client{ - SocketPath: socketPath, + socketPath: socketPath, conn: conn, writer: writer, reader: reader, }, nil } +// Close terminates the underlying socket connection. func (c *Client) Close() error { if c.conn != nil { return c.conn.Close() -- cgit v1.2.3