added missing function docs

Author: asiyani

config.go

@@ -83,6 +83,8 @@ func loadConfig(path string, lastModTime time.Time, onChange func(*mirror.RepoPo
 	return modTime, onChange(newConfig)
 }
 
+// ensureConfig will do the diff between current repoPool state and new config
+// and based on that diff it will add/remove repositories and worktrees
 func ensureConfig(repoPool *mirror.RepoPool, newConfig *mirror.RepoPoolConfig) bool {
 	success := true
 
@@ -180,6 +182,8 @@ func parseConfigFile(path string) (*mirror.RepoPoolConfig, error) {
 	return conf, nil
 }
 
+// diffRepositories will do the diff between current state and new config and
+// return new repositories config and list of remote url which are not found in config
 func diffRepositories(repoPool *mirror.RepoPool, newConfig *mirror.RepoPoolConfig) (
 	newRepos []mirror.RepositoryConfig,
 	removedRepos []string,
@@ -206,6 +210,8 @@ func diffRepositories(repoPool *mirror.RepoPool, newConfig *mirror.RepoPoolConfi
 	return
 }
 
+// diffWorktrees will do the diff between current repo's worktree state and new worktree config
+// it will return new worktree configs and link names of the link not found in new config
 func diffWorktrees(repo *mirror.Repository, newRepoConf *mirror.RepositoryConfig) (
 	newWTCs []mirror.WorktreeConfig,
 	removedWTs []string,

pkg/mirror/repo_pool.go

@@ -171,6 +171,7 @@ func (rp *RepoPool) Repository(remote string) (*Repository, error) {
 	return nil, ErrNotExist
 }
 
+// RepositoriesRemote returns remote URLs of all the repositories
 func (rp *RepoPool) RepositoriesRemote() []string {
 	rp.lock.RLock()
 	defer rp.lock.RUnlock()
@@ -182,6 +183,7 @@ func (rp *RepoPool) RepositoriesRemote() []string {
 	return urls
 }
 
+// RepositoriesDirPath returns local paths of all the mirrored repositories
 func (rp *RepoPool) RepositoriesDirPath() []string {
 	rp.lock.RLock()
 	defer rp.lock.RUnlock()

pkg/mirror/repository.go

@@ -165,6 +165,7 @@ func (r *Repository) AddWorktreeLink(wtc WorktreeConfig) error {
 	return nil
 }
 
+// WorktreeLinks returns current clone of worktree maps
 func (r *Repository) WorktreeLinks() map[string]*WorkTreeLink {
 	r.lock.RLock()
 	defer r.lock.RUnlock()
@@ -394,7 +395,7 @@ func (r *Repository) cloneByRef(ctx context.Context, dst, ref, pathspec string,
 	return hash, nil
 }
 
-// returns if repositories mirror loop is running or not
+// IsRunning returns if repositories mirror loop is running or not
 func (r *Repository) IsRunning() bool {
 	r.lock.RLock()
 	defer r.lock.RUnlock()
@@ -498,7 +499,7 @@ func (r *Repository) Mirror(ctx context.Context) error {
 }
 
 // RemoveWorktreeLink removes workTree link from the mirror repository.
-// it will remove published link as well even if it failed to remove worktree
+// it will remove published link as well even (if it failed to remove worktree)
 func (r *Repository) RemoveWorktreeLink(link string) error {
 	r.lock.Lock()
 	defer r.lock.Unlock()

pkg/mirror/worktree.go

@@ -17,6 +17,9 @@ type WorkTreeLink struct {
 	log       *slog.Logger
 }
 
+// Equals returns if given worktree and its config is equal
+// they are considered equal only if link, ref and pathspecs are matching.
+// order of pothspecs is ignored
 func (wt *WorkTreeLink) Equals(wtc WorktreeConfig) bool {
 	sortedConfigPaths := slices.Clone(wtc.Pathspecs)
 	slices.Sort(sortedConfigPaths)