Merge pull request #2223 from ipfs/feature/doc-add

rht · rht · commit bc94293b5f28 · 2016-01-23T11:16:37.000+07:00
Generic doc fixes to `ipfs add`
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ USAGE:
     BASIC COMMANDS
     
         init          Initialize ipfs local configuration
-        add <path>    Add an object to ipfs
+        add <path>    Add a file to ipfs
         cat <ref>     Show ipfs object data
         get <ref>     Download ipfs objects
         ls <ref>      List links from an object
diff --git a/core/commands/add.go b/core/commands/add.go
@@ -30,12 +30,11 @@ const (
 
 var AddCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Add an object to ipfs.",
+		Tagline: "Add a file to ipfs.",
 		ShortDescription: `
 Adds contents of <path> to ipfs. Use -r to add directories.
 Note that directories are added recursively, to form the ipfs
-MerkleDAG. A smarter partial add with a staging area (like git)
-remains to be implemented.
+MerkleDAG.
 `,
 	},
 
@@ -44,15 +43,15 @@ remains to be implemented.
 	},
 	Options: []cmds.Option{
 		cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
-		cmds.BoolOption(quietOptionName, "q", "Write minimal output"),
-		cmds.BoolOption(silentOptionName, "Write no output"),
-		cmds.BoolOption(progressOptionName, "p", "Stream progress data"),
-		cmds.BoolOption(trickleOptionName, "t", "Use trickle-dag format for dag generation"),
-		cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - do not write to disk"),
-		cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object"),
+		cmds.BoolOption(quietOptionName, "q", "Write minimal output."),
+		cmds.BoolOption(silentOptionName, "Write no output."),
+		cmds.BoolOption(progressOptionName, "p", "Stream progress data."),
+		cmds.BoolOption(trickleOptionName, "t", "Use trickle-dag format for dag generation."),
+		cmds.BoolOption(onlyHashOptionName, "n", "Only chunk and hash - do not write to disk."),
+		cmds.BoolOption(wrapOptionName, "w", "Wrap files with a directory object."),
 		cmds.BoolOption(hiddenOptionName, "H", "Include files that are hidden. Only takes effect on recursive add."),
-		cmds.StringOption(chunkerOptionName, "s", "chunking algorithm to use"),
-		cmds.BoolOption(pinOptionName, "Pin this object when adding.  Default true"),
+		cmds.StringOption(chunkerOptionName, "s", "Chunking algorithm to use."),
+		cmds.BoolOption(pinOptionName, "Pin this object when adding.  Default: true."),
 	},
 	PreRun: func(req cmds.Request) error {
 		if quiet, _, _ := req.Option(quietOptionName).Bool(); quiet {
diff --git a/core/commands/root.go b/core/commands/root.go
@@ -32,7 +32,7 @@ ipfs [<flags>] <command> [<arg>] ...
 BASIC COMMANDS
 
     init          Initialize ipfs local configuration
-    add <path>    Add an object to ipfs
+    add <path>    Add a file to ipfs
     cat <ref>     Show ipfs object data
     get <ref>     Download ipfs objects
     ls <ref>      List links from an object
