README: Document gst-worktree, remove checkout-branch-worktree

Closes https://gitlab.freedesktop.org/gstreamer/gst-build/-/issues/72
This commit is contained in:
Nirbheek Chauhan 2020-04-16 18:53:37 +05:30
parent 88f5262ba3
commit d6fdd8afc6
2 changed files with 7 additions and 17 deletions

View file

@ -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

View file

@ -1,10 +0,0 @@
#!/bin/sh
cd `dirname $0`
case "$MSYSTEM" in
*MINGW*) PYTHON="py -3";;
*) PYTHON="python3";;
esac
$PYTHON gst-worktree.py add "$@"