aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Subprojects.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/markdown/Subprojects.md')
-rw-r--r--docs/markdown/Subprojects.md48
1 files changed, 36 insertions, 12 deletions
diff --git a/docs/markdown/Subprojects.md b/docs/markdown/Subprojects.md
index 02a83e6..57f5176 100644
--- a/docs/markdown/Subprojects.md
+++ b/docs/markdown/Subprojects.md
@@ -258,7 +258,22 @@ the following command-line options:
`glib-2.0` must also be forced to fallback, in this case with
`--force-fallback-for=glib,gsteamer`.
-## Download subprojects
+## `meson subprojects` command
+
+*Since 0.49.0*
+
+`meson subprojects` has various subcommands to manage all subprojects. If the
+subcommand fails on any subproject the execution continues with other subprojects.
+All subcommands accepts `--sourcedir` argument pointing to the root source dir
+of the main project.
+
+*Since 0.56.0* all subcommands accepts `--type <file,git,hg,svn>` argument to
+run the subcommands only on subprojects of the given type.
+
+*Since 0.56.0* If the subcommand fails on any subproject an error code is returned
+at the end instead of retuning success.
+
+### Download subprojects
*Since 0.49.0*
@@ -269,7 +284,7 @@ offline. The command-line `meson subprojects download` can be used for that, it
will download all missing subprojects, but will not update already fetched
subprojects.
-## Update subprojects
+### Update subprojects
*Since 0.49.0*
@@ -282,15 +297,22 @@ To pull latest version of all your subprojects at once, just run the command:
be pulled and used next time meson reconfigure the project. This can be
triggered using `meson --reconfigure`. Previous source tree is not deleted, to
prevent from any loss of local changes.
-- If the wrap file points to a git commit or tag, a checkout of that commit is
- performed.
-- If the wrap file points to a git branch, and the current branch has the same
- name, a `git pull` is performed.
-- If the wrap file points to a git branch, and the current branch is different,
- it is skipped. Unless `--rebase` option is passed in which case
- `git pull --rebase` is performed.
-
-## Start a topic branch across all git subprojects
+- If subproject is currently in detached mode, a checkout of the revision from
+ wrap file is performed. *Since 0.56.0* a rebase is also performed in case the
+ revision already existed locally by was outdated. If `--reset` is specified,
+ a hard reset is performed instead of rebase.
+- If subproject is currently at the same branch as specified by the wrap file,
+ a rebase on `origin` commit is performed. *Since 0.56.0* If `--reset` is
+ specified, a hard reset is performed instead of rebase.
+- If subproject is currently in a different branch as specified by the wrap file,
+ it is skipped unless `--rebase` option is passed in which case a rebase on
+ `origin` commit is performed. *Since 0.56.0* the `--rebase` argument is
+ deprecated and has no effect. Instead, a checkout of the revision from wrap file
+ file is performed and a rebase is also performed in case the revision already
+ existed locally by was outdated. If `--reset` is specified, a hard reset is
+ performed instead of rebase.
+
+### Start a topic branch across all git subprojects
*Since 0.49.0*
@@ -303,7 +325,9 @@ changes.
To come back to the revision set in wrap file (i.e. master), just run
`meson subprojects checkout` with no branch name.
-## Execute a command on all subprojects
+*Since 0.56.0* any pending changes are now stashed before checkout a new branch.
+
+### Execute a command on all subprojects
*Since 0.51.0*