Merge pull request #770 from jbenet/pkg-docs

document some packages
This commit is contained in:
Juan Batiz-Benet 2015-02-10 16:06:22 -08:00
commit 8be756313a
6 changed files with 8 additions and 0 deletions

View File

@ -1,3 +1,4 @@
// cmd/ipfs implements the primary CLI binary for ipfs
package main
import (

View File

@ -57,6 +57,7 @@ remains to be implemented.
cmds.BoolOption("quiet", "q", "Write minimal output"),
cmds.BoolOption(progressOptionName, "p", "Stream progress data"),
cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object"),
cmds.BoolOption("t", "trickle", "Use trickle-dag format for dag generation"),
},
PreRun: func(req cmds.Request) error {
if quiet, _, _ := req.Option("quiet").Bool(); quiet {

View File

@ -1,3 +1,5 @@
// package core implements the IpfsNode object and methods for constructing
// and properly setting it up.
package core
import (

View File

@ -1,3 +1,4 @@
// package decision implements the decision engine for the bitswap service.
package decision
import (

View File

@ -1,3 +1,5 @@
// package wantlist implements an object for bitswap that contains the keys
// that a given peer wants.
package wantlist
import (

View File

@ -1,3 +1,4 @@
// package namesys implements various functionality for the ipns naming system.
package namesys
import (