summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2016-11-07 18:17:39 -0300
committerThibault Saunier <thibault.saunier@osg.samsung.com>2016-11-08 15:16:57 -0300
commitc843f487408d7468d6fb64eb581c569fca9cec01 (patch)
tree4c0ceffda44c89cca873879b34d2477193396523 /README.md
parentac383f6b68cb2354ba7e48e5cab334ae3402b7ca (diff)
downloadgstreamer-c843f487408d7468d6fb64eb581c569fca9cec01.tar.gz
Add 'update' and `git-update` targets to update git repos
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 28 insertions, 6 deletions
diff --git a/README.md b/README.md
index 13e67d0e88..55f508bad1 100644
--- a/README.md
+++ b/README.md
@@ -28,18 +28,40 @@ NOTE: on fedora (and maybe other distributions) replace `ninja` with `ninja-buil
# Development environment
+## Uninstalled environment
+
gst-build also contains a special `uninstalled` target that lets you enter an
-uninstalled development environment where you will be able to work on GStreamer easily.
-You can get into that environment running:
+uninstalled development environment where you will be able to work on GStreamer
+easily. You can get into that environment running:
```
ninja -C build/ uninstalled
```
-If your operating system handles symlinks, built modules source code will be available
-at the root of `gst-build/` for example GStreamer core will be in `gstreamer/`. Otherwise
-they will be present in `subprojects/`. You can simply hack in there and to rebuild you
-just need to rerun `ninja -C build/`.
+If your operating system handles symlinks, built modules source code will be
+available at the root of `gst-build/` for example GStreamer core will be in
+`gstreamer/`. Otherwise they will be present in `subprojects/`. You can simply
+hack in there and to rebuild you just need to rerun `ninja -C build/`.
+
+## Update git subprojects
+
+We added a special `update` target to update subprojects (it uses `git pull
+--rebase` meaning you should always make sure the branches you work on are
+following the right upstream branch, you can set it with `git branch
+--set-upstream-to origin/master` if you are working on `gst-build` master
+branch).
+
+Update all GStreamer modules and rebuild:
+
+```
+ninja -C build/ update
+```
+
+Update all GStreamer modules without rebuilding:
+
+```
+ninja -C build/ git-update
+```
## Add information about GStreamer development environment in your prompt line