diff --git a/adder/adder.go b/adder/adder.go index 81a212cf..ebd05f8e 100644 --- a/adder/adder.go +++ b/adder/adder.go @@ -1,3 +1,5 @@ +// Package adder implements functionality to add content to IPFS daemons +// managed by the Cluster. package adder import ( diff --git a/api/rest/client/client.go b/api/rest/client/client.go index bb88367a..24c297fd 100644 --- a/api/rest/client/client.go +++ b/api/rest/client/client.go @@ -1,3 +1,6 @@ +// Package client provides a Go Client for the IPFS Cluster API provided +// by the "api/rest" component. It supports both the HTTP(s) endpoint and +// the libp2p-http endpoint. package client import ( diff --git a/config/config.go b/config/config.go index 97aec216..2274c741 100644 --- a/config/config.go +++ b/config/config.go @@ -1,3 +1,6 @@ +// Package config provides interfaces and utilities for different Cluster +// components to register, read, write and validate configuration sections +// stored in a central configuration file. package config import ( diff --git a/ipfs-cluster-ctl/main.go b/ipfs-cluster-ctl/main.go index a373338a..12f445b6 100644 --- a/ipfs-cluster-ctl/main.go +++ b/ipfs-cluster-ctl/main.go @@ -1,3 +1,4 @@ +// The ipfs-cluster-ctl application. package main import ( diff --git a/ipfs-cluster-service/lock.go b/ipfs-cluster-service/lock.go index 8fb7656a..fa9ca5fb 100644 --- a/ipfs-cluster-service/lock.go +++ b/ipfs-cluster-service/lock.go @@ -1,4 +1,3 @@ -// lock logic heavily inspired by go-ipfs/repo/fsrepo/lock/lock.go package main import ( @@ -10,6 +9,8 @@ import ( fslock "github.com/ipfs/go-fs-lock" ) +// lock logic heavily inspired by go-ipfs/repo/fsrepo/lock/lock.go + // The name of the file used for locking const lockFileName = "cluster.lock" diff --git a/ipfs-cluster-service/main.go b/ipfs-cluster-service/main.go index f9c2e6c8..361acf02 100644 --- a/ipfs-cluster-service/main.go +++ b/ipfs-cluster-service/main.go @@ -1,3 +1,4 @@ +// The ipfs-cluster-service application. package main import ( diff --git a/pintracker/stateless/stateless.go b/pintracker/stateless/stateless.go index df205463..d1e4f00e 100644 --- a/pintracker/stateless/stateless.go +++ b/pintracker/stateless/stateless.go @@ -1,3 +1,6 @@ +// Package stateless implements a PinTracker component for IPFS Cluster, which +// aims to reduce the memory footprint when handling really large cluster +// states. package stateless import ( diff --git a/test/test.go b/test/test.go index 7dbcabfe..d291d6cc 100644 --- a/test/test.go +++ b/test/test.go @@ -1,3 +1,3 @@ -// Package test offers testing utilities to ipfs-cluster like -// mocks +// Package test offers testing utilities for all the IPFS Cluster +// codebase, like IPFS daemon and RPC mocks and pre-defined testing CIDs. package test