From 8195e8df7b1b09b7e2f52c6d39c0b47a9093bac4 Mon Sep 17 00:00:00 2001 From: Matt Joiner Date: Fri, 29 Dec 2017 12:16:05 +1100 Subject: [PATCH] Improve some doc comments --- connection.go | 3 ++- metainfo/info.go | 5 ++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/connection.go b/connection.go index 7d94f08b..92c72f57 100644 --- a/connection.go +++ b/connection.go @@ -1053,7 +1053,8 @@ func (c *connection) receiveChunk(msg *pp.Message) { // Need to record that it hasn't been written yet, before we attempt to do // anything with it. piece.incrementPendingWrites() - // Record that we have the chunk. + // Record that we have the chunk, so we aren't trying to download it while + // waiting for it to be written to storage. piece.unpendChunkIndex(chunkIndex(req.chunkSpec, t.chunkSize)) // Cancel pending requests for this chunk. diff --git a/metainfo/info.go b/metainfo/info.go index a7e23a7f..77cb9eba 100644 --- a/metainfo/info.go +++ b/metainfo/info.go @@ -66,6 +66,8 @@ func (info *Info) BuildFromFilePath(root string) (err error) { return } +// Concatenates all the files in the torrent into w. open is a function that +// gets at the contents of the given file. func (info *Info) writeFiles(w io.Writer, open func(fi FileInfo) (io.ReadCloser, error)) error { for _, fi := range info.UpvertedFiles() { r, err := open(fi) @@ -81,7 +83,8 @@ func (info *Info) writeFiles(w io.Writer, open func(fi FileInfo) (io.ReadCloser, return nil } -// Set info.Pieces by hashing info.Files. +// Sets Pieces (the block of piece hashes in the Info) by using the passed +// function to get at the torrent data. func (info *Info) GeneratePieces(open func(fi FileInfo) (io.ReadCloser, error)) error { if info.PieceLength == 0 { return errors.New("piece length must be non-zero") -- 2.48.1