From defd01ea06eaff8ce27d2bc65832e353682316ef Mon Sep 17 00:00:00 2001 From: buddyspike Date: Wed, 24 Jan 2018 06:06:09 +1100 Subject: [PATCH] Doc: generated --- doc/mbt.md | 2 +- doc/mbt_apply.md | 3 ++- doc/mbt_apply_branch.md | 2 +- doc/mbt_apply_commit.md | 2 +- doc/mbt_apply_local.md | 35 ++++++++++++++++++++++++++++++ doc/mbt_build.md | 3 ++- doc/mbt_build_branch.md | 2 +- doc/mbt_build_diff.md | 2 +- doc/mbt_build_head.md | 2 +- doc/mbt_build_local.md | 37 ++++++++++++++++++++++++++++++++ doc/mbt_build_pr.md | 2 +- doc/mbt_describe.md | 4 +++- doc/mbt_describe_branch.md | 2 +- doc/mbt_describe_commit.md | 2 +- doc/mbt_describe_diff.md | 37 ++++++++++++++++++++++++++++++++ doc/mbt_describe_head.md | 2 +- doc/mbt_describe_intersection.md | 2 +- doc/mbt_describe_local.md | 34 +++++++++++++++++++++++++++++ doc/mbt_describe_pr.md | 2 +- doc/mbt_version.md | 2 +- doc/readme.md | 2 +- 21 files changed, 164 insertions(+), 17 deletions(-) create mode 100644 doc/mbt_apply_local.md create mode 100644 doc/mbt_build_local.md create mode 100644 doc/mbt_describe_diff.md create mode 100644 doc/mbt_describe_local.md diff --git a/doc/mbt.md b/doc/mbt.md index 07710df8..2bf5af52 100644 --- 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 index 67411605..af10c6de 100644 --- 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 index 36b003a1..53eeca0d 100644 --- a/doc/mbt_apply_branch.md +++ b/doc/mbt_apply_branch.md @@ -31,4 +31,4 @@ mbt apply 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 index 5c783b81..048d22e9 100644 --- a/doc/mbt_apply_commit.md +++ b/doc/mbt_apply_commit.md @@ -33,4 +33,4 @@ mbt apply commit [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 new file mode 100644 index 00000000..8ca34a4b --- /dev/null +++ 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 index 8c3933a5..56895ca6 100644 --- 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 index 78fc468e..251c55c5 100644 --- a/doc/mbt_build_branch.md +++ b/doc/mbt_build_branch.md @@ -31,4 +31,4 @@ mbt build 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 index 83421428..ffc50b56 100644 --- a/doc/mbt_build_diff.md +++ b/doc/mbt_build_diff.md @@ -35,4 +35,4 @@ mbt build diff --from --to [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 index 5c96f31e..325924dd 100644 --- 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 new file mode 100644 index 00000000..0ab328f7 --- /dev/null +++ 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 index a08c95ce..fa500608 100644 --- a/doc/mbt_build_pr.md +++ b/doc/mbt_build_pr.md @@ -34,4 +34,4 @@ mbt build pr --src --dst [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 index ed0632da..e7c0f398 100644 --- 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 index 798e56b0..0bd54bc6 100644 --- a/doc/mbt_describe_branch.md +++ b/doc/mbt_describe_branch.md @@ -31,4 +31,4 @@ mbt describe 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 index 30fd7aa0..82ca9279 100644 --- a/doc/mbt_describe_commit.md +++ b/doc/mbt_describe_commit.md @@ -32,4 +32,4 @@ mbt describe commit [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 new file mode 100644 index 00000000..498b8792 --- /dev/null +++ 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 --to [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 index 0dade7fc..517a49e3 100644 --- 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 index 5c353d0c..f3983d87 100644 --- a/doc/mbt_describe_intersection.md +++ b/doc/mbt_describe_intersection.md @@ -32,4 +32,4 @@ mbt describe intersection --kind --first --second --dst [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 index a37b59f9..632c11f5 100644 --- 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 index 07710df8..2bf5af52 100644 --- 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