Document ConfigDir

client.go

@@ -336,6 +336,8 @@ func (cl *Client) configDir() string {
 	return cl.config.ConfigDir
 }
 
+// The directory where the Client expects to find and store configuration
+// data. Defaults to $HOME/.config/torrent.
 func (cl *Client) ConfigDir() string {
 	return cl.configDir()
 }

doc.go

@@ -14,5 +14,14 @@ BitTorrent features implemented include:
  * Some IPv6
  * UDP Trackers
 
+ConfigDir
+
+A Client has a configurable ConfigDir that defaults to $HOME/.config/torrent.
+Torrent metainfo files are cached at $CONFIGDIR/torrents/$infohash.torrent.
+Infohashes in $CONFIGDIR/banned_infohashes cannot be added to the Client. A
+P2P Plaintext Format blocklist is loaded from a file at the location specified
+by the environment variable TORRENT_BLOCKLIST_FILE if set, otherwise from
+$CONFIGDIR/blocklist.
+
 */
 package torrent