From: Yaroslav Kolomiiets <yarikos@gmail.com>
Date: Thu, 30 Apr 2020 19:23:20 +0000 (+0100)
Subject: add BEP references to documentation of the metadata fields
X-Git-Tag: v1.16.0~45
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=b4e10e00a90ffe9acbf8fe15bbc023e10c0b6de9;p=btrtrc.git

add BEP references to documentation of the metadata fields
---

diff --git a/metainfo/fileinfo.go b/metainfo/fileinfo.go
index 58073a1b..5aea9727 100644
--- a/metainfo/fileinfo.go
+++ b/metainfo/fileinfo.go
@@ -4,8 +4,8 @@ import "strings"
 
 // Information specific to a single file inside the MetaInfo structure.
 type FileInfo struct {
-	Length   int64    `bencode:"length"`
-	Path     []string `bencode:"path"`
+	Length   int64    `bencode:"length"` // BEP3
+	Path     []string `bencode:"path"`   // BEP3
 	PathUTF8 []string `bencode:"path.utf-8,omitempty"`
 }
 
diff --git a/metainfo/info.go b/metainfo/info.go
index 53223130..3190dfb0 100644
--- a/metainfo/info.go
+++ b/metainfo/info.go
@@ -14,14 +14,14 @@ import (
 
 // The info dictionary.
 type Info struct {
-	PieceLength int64  `bencode:"piece length"`
-	Pieces      []byte `bencode:"pieces"`
-	Name        string `bencode:"name"`
-	Length      int64  `bencode:"length,omitempty"`
-	Private     *bool  `bencode:"private,omitempty"`
+	PieceLength int64  `bencode:"piece length"`      // BEP3
+	Pieces      []byte `bencode:"pieces"`            // BEP3
+	Name        string `bencode:"name"`              // BEP3
+	Length      int64  `bencode:"length,omitempty"`  // BEP3, mutually exclusive with Files
+	Private     *bool  `bencode:"private,omitempty"` // BEP27
 	// TODO: Document this field.
 	Source string     `bencode:"source,omitempty"`
-	Files  []FileInfo `bencode:"files,omitempty"`
+	Files  []FileInfo `bencode:"files,omitempty"` // BEP3, mutually exclusive with Length
 }
 
 // This is a helper that sets Files and Pieces from a root path and its
diff --git a/metainfo/metainfo.go b/metainfo/metainfo.go
index 9f628fe0..5e84b012 100644
--- a/metainfo/metainfo.go
+++ b/metainfo/metainfo.go
@@ -9,15 +9,15 @@ import (
 )
 
 type MetaInfo struct {
-	InfoBytes    bencode.Bytes `bencode:"info,omitempty"`
-	Announce     string        `bencode:"announce,omitempty"`
-	AnnounceList AnnounceList  `bencode:"announce-list,omitempty"`
-	Nodes        []Node        `bencode:"nodes,omitempty"`
+	InfoBytes    bencode.Bytes `bencode:"info,omitempty"`          // BEP 3
+	Announce     string        `bencode:"announce,omitempty"`      // BEP 3
+	AnnounceList AnnounceList  `bencode:"announce-list,omitempty"` // BEP 12
+	Nodes        []Node        `bencode:"nodes,omitempty"`         // BEP 5
 	CreationDate int64         `bencode:"creation date,omitempty,ignore_unmarshal_type_error"`
 	Comment      string        `bencode:"comment,omitempty"`
 	CreatedBy    string        `bencode:"created by,omitempty"`
 	Encoding     string        `bencode:"encoding,omitempty"`
-	UrlList      UrlList       `bencode:"url-list,omitempty"`
+	UrlList      UrlList       `bencode:"url-list,omitempty"` // BEP 19
 }
 
 // Load a MetaInfo from an io.Reader. Returns a non-nil error in case of