summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2020-04-16 18:53:37 +0530
committerNirbheek Chauhan <nirbheek@centricular.com>2020-04-16 18:54:26 +0530
commitd6fdd8afc657ff3881a5cc38c2d191c5c92c3c7b (patch)
tree5cde04c097c199b35b9189673cb35e49a8830ae3 /README.md
parent88f5262ba3530084361e532711215166b77f94f7 (diff)
downloadgstreamer-d6fdd8afc657ff3881a5cc38c2d191c5c92c3c7b.tar.gz
README: Document gst-worktree, remove checkout-branch-worktree
Closes https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/72
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 8a35a8dbce..4e09364ec1 100644
--- a/README.md
+++ b/README.md
@@ -172,20 +172,20 @@ platform for things to work.
## Checkout another branch using worktrees
-If you need to have several versions of GStreamer coexisting (eg. `master` and `1.14`),
-you can use the `checkout-branch-worktree` script provided by `gst-build`. It allows you
+If you need to have several versions of GStreamer coexisting (eg. `master` and `1.16`),
+you can use the `gst-worktree.py` script provided by `gst-build`. It allows you
to create a new `gst-build` environment with new checkout of all the GStreamer modules as
[git worktrees](https://git-scm.com/docs/git-worktree).
-For example to get a fresh checkout of `gst-1.14` from a `gst-build` in master **already
-built** in a `build` directory you can simply run:
+For example to get a fresh checkout of `gst-1.16` from a `gst-build` repository
+that is checked out at master, you can run:
```
-./checkout-branch-worktree ../gst-build-1.16 origin/1.14 -C builddir
+./gst-worktree.py add gst-build-1.16 origin/1.16
```
-This will create a new ``gst-build-1.14`` folder at the same level of ``gst-build`` pointing to the given branch ie *1.14*
-for all the subprojects ( gstreamer, gst-plugins-base etc.)
+This will create a new ``gst-build-1.16`` directory pointing to the given branch `1.16`
+for all the subprojects (gstreamer, gst-plugins-base, etc.)
## Add information about GStreamer development environment in your prompt line