Skip to content

Commit

Permalink
make package comments more descriptive
Browse files Browse the repository at this point in the history
A lot has happened since the 'package rsync' one was written :)

Package rsyncd is the package that gets imported the most currently,
so ensure it also has a complete description.
  • Loading branch information
stapelberg committed Feb 24, 2025
1 parent 8f73d56 commit 211e10d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
// Package rsync contains a native Go rsync implementation.
// Package rsync (gokrazy/rsync) contains a native Go rsync implementation that
// supports sending and receiving files as client or server, compatible with the
// original tridge rsync (from the samba project) or openrsync (used on OpenBSD
// and macOS 15+).
//
// The only component currently is gokr-rsyncd, a read-only rsync daemon
// sender-only Go implementation of rsyncd. rsync daemon is a custom
Expand Down
4 changes: 4 additions & 0 deletions rsyncd/rsyncd.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
// Package rsyncd implements an rsync server (only), but note that gokrazy/rsync
// contains a native Go rsync implementation that supports sending and receiving
// files as client or server, compatible with the original tridge rsync (from
// the samba project) or openrsync (used on OpenBSD and macOS 15+).
package rsyncd

import (
Expand Down

0 comments on commit 211e10d

Please sign in to comment.