Doc: generated

mbtproject · Jan 23, 2018 · defd01e · defd01e
1 parent 29ca1c4
commit defd01e
Show file tree

Hide file tree

Showing 21 changed files with 164 additions and 17 deletions.
diff --git a/doc/mbt.md b/doc/mbt.md
@@ -27,4 +27,4 @@ See help for individual commands for more information.
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 * [mbt version](mbt_version.md)	 - Displays the version of mbt
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_apply.md b/doc/mbt_apply.md
@@ -34,5 +34,6 @@ Template must be committed to the repository.
 * [mbt](mbt.md)	 - Build utility for monorepos
 * [mbt apply branch](mbt_apply_branch.md)	 - Applies the manifest of specified branch over a template
 * [mbt apply commit](mbt_apply_commit.md)	 - Applies the manifest of specified commit over a template
+* [mbt apply local](mbt_apply_local.md)	 - Applies the manifest of local directory state over a template
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_apply_branch.md b/doc/mbt_apply_branch.md
@@ -31,4 +31,4 @@ mbt apply branch <branch> [flags]
 ### SEE ALSO
 * [mbt apply](mbt_apply.md)	 - Main command for applying the repository manifest over a template
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_apply_commit.md b/doc/mbt_apply_commit.md
@@ -33,4 +33,4 @@ mbt apply commit <sha> [flags]
 ### SEE ALSO
 * [mbt apply](mbt_apply.md)	 - Main command for applying the repository manifest over a template
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_apply_local.md b/doc/mbt_apply_local.md
@@ -0,0 +1,35 @@
+## mbt apply local
+
+Applies the manifest of local directory state over a template
+
+### Synopsis
+
+
+Applies the manifest of local directory state over a template
+
+Calculated manifest and the template is based on the content of local directory.
+This command is useful for testing pending changes in workspace.
+
+
+```
+mbt apply local [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for local
+```
+
+### Options inherited from parent commands
+
+```
+      --in string    path to repo
+      --out string   output path
+      --to string    template to apply
+```
+
+### SEE ALSO
+* [mbt apply](mbt_apply.md)	 - Main command for applying the repository manifest over a template
+
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build.md b/doc/mbt_build.md
@@ -28,6 +28,7 @@ See sub command help for more information.
 * [mbt build branch](mbt_build_branch.md)	 - Builds the specified branch
 * [mbt build diff](mbt_build_diff.md)	 - Builds the diff between from and to commits
 * [mbt build head](mbt_build_head.md)	 - Builds the local directory
+* [mbt build local](mbt_build_local.md)	 - Builds the diff between the work dir and the last commit
 * [mbt build pr](mbt_build_pr.md)	 - Builds the diff between the src and dst branches
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build_branch.md b/doc/mbt_build_branch.md
@@ -31,4 +31,4 @@ mbt build branch <branch> [flags]
 ### SEE ALSO
 * [mbt build](mbt_build.md)	 - Main command for building the repository
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build_diff.md b/doc/mbt_build_diff.md
@@ -35,4 +35,4 @@ mbt build diff --from <sha> --to <sha> [flags]
 ### SEE ALSO
 * [mbt build](mbt_build.md)	 - Main command for building the repository
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build_head.md b/doc/mbt_build_head.md
@@ -30,4 +30,4 @@ mbt build head [flags]
 ### SEE ALSO
 * [mbt build](mbt_build.md)	 - Main command for building the repository
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build_local.md b/doc/mbt_build_local.md
@@ -0,0 +1,37 @@
+## mbt build local
+
+Builds the diff between the work dir and the last commit
+
+### Synopsis
+
+
+Builds the diff between the work dir and the last commit
+
+Works out the merge base between the local working directory and the last 
+commit on this branch. Then it will try to build only the modules have changed
+during the last commit and the current build.
+
+Specify the --all flag to everything local branch. 
+
+
+```
+mbt build local [--all] [flags]
+```
+
+### Options
+
+```
+  -a, --all    all modules
+  -h, --help   help for local
+```
+
+### Options inherited from parent commands
+
+```
+      --in string   path to repo
+```
+
+### SEE ALSO
+* [mbt build](mbt_build.md)	 - Main command for building the repository
+
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_build_pr.md b/doc/mbt_build_pr.md
@@ -34,4 +34,4 @@ mbt build pr --src <branch> --dst <branch> [flags]
 ### SEE ALSO
 * [mbt build](mbt_build.md)	 - Main command for building the repository
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe.md b/doc/mbt_describe.md
@@ -29,8 +29,10 @@ command and also to pipe mbt manifest to external tools.
 * [mbt](mbt.md)	 - Build utility for monorepos
 * [mbt describe branch](mbt_describe_branch.md)	 - Describes the manifest for the given branch
 * [mbt describe commit](mbt_describe_commit.md)	 - Describes the manifest of a specified commit
+* [mbt describe diff](mbt_describe_diff.md)	 - Describes the manifest for diff between from and to commits
 * [mbt describe head](mbt_describe_head.md)	 - Describes the manifest for the branch pointed at head
 * [mbt describe intersection](mbt_describe_intersection.md)	 - Describes the intersection between two commit trees
+* [mbt describe local](mbt_describe_local.md)	 - Describes the manifest for the local branch
 * [mbt describe pr](mbt_describe_pr.md)	 - Describes the manifest for diff between src and dst branches
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_branch.md b/doc/mbt_describe_branch.md
@@ -31,4 +31,4 @@ mbt describe branch <branch> [flags]
 ### SEE ALSO
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_commit.md b/doc/mbt_describe_commit.md
@@ -32,4 +32,4 @@ mbt describe commit <sha> [flags]
 ### SEE ALSO
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_diff.md b/doc/mbt_describe_diff.md
@@ -0,0 +1,37 @@
+## mbt describe diff
+
+Describes the manifest for diff between from and to commits
+
+### Synopsis
+
+
+Describes the manifest for diff between from and to commits
+
+Works out the merge base for from and to commits and 
+displays all modules which have been changed between merge base and 
+the to commit.	
+
+
+```
+mbt describe diff --from <commit> --to <commit> [flags]
+```
+
+### Options
+
+```
+      --from string   from commit
+  -h, --help          help for diff
+      --to string     to commit
+```
+
+### Options inherited from parent commands
+
+```
+      --in string   path to repo
+      --json        format output as json
+```
+
+### SEE ALSO
+* [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
+
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_head.md b/doc/mbt_describe_head.md
@@ -30,4 +30,4 @@ mbt describe head [flags]
 ### SEE ALSO
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_intersection.md b/doc/mbt_describe_intersection.md
@@ -32,4 +32,4 @@ mbt describe intersection --kind <branch|commit> --first <first> --second <secon
 ### SEE ALSO
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_local.md b/doc/mbt_describe_local.md
@@ -0,0 +1,34 @@
+## mbt describe local
+
+Describes the manifest for the local branch
+
+### Synopsis
+
+
+Describes the manifest for the local branch
+
+Displays all modules in the local working directory even if they have not been committed.
+
+
+```
+mbt describe local [flags]
+```
+
+### Options
+
+```
+  -a, --all    describe all
+  -h, --help   help for local
+```
+
+### Options inherited from parent commands
+
+```
+      --in string   path to repo
+      --json        format output as json
+```
+
+### SEE ALSO
+* [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
+
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_describe_pr.md b/doc/mbt_describe_pr.md
@@ -34,4 +34,4 @@ mbt describe pr --src <branch> --dst <branch> [flags]
 ### SEE ALSO
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/mbt_version.md b/doc/mbt_version.md
@@ -26,4 +26,4 @@ mbt version [flags]
 ### SEE ALSO
 * [mbt](mbt.md)	 - Build utility for monorepos
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018
diff --git a/doc/readme.md b/doc/readme.md
@@ -27,4 +27,4 @@ See help for individual commands for more information.
 * [mbt describe](mbt_describe.md)	 - Describes the manifest of a repo
 * [mbt version](mbt_version.md)	 - Displays the version of mbt
 
-###### Auto generated by spf13/cobra on 14-Jan-2018
+###### Auto generated by spf13/cobra on 24-Jan-2018