Doc metainfo.Info.BuildFromFilePath

diff --git a/metainfo/metainfo.go b/metainfo/metainfo.go
index 1dda2702574a7a5d682564219cea072cc57d4950..f6bc7690f253adbae3d5453640707255fed83ddf 100644 (file)
--- a/metainfo/metainfo.go
+++ b/metainfo/metainfo.go
@@ -54,6 +54,8 @@ type Info struct {
        Files       []FileInfo `bencode:"files,omitempty"`
 }
 
+// This is a helper that sets Files and Pieces from a root path and its
+// children.
 func (info *Info) BuildFromFilePath(root string) (err error) {
        info.Name = filepath.Base(root)
        info.Files = nil