Skip to content

Commit

Permalink
Remove the deprecated --local-liblarch launch parameter from the manpage
Browse files Browse the repository at this point in the history
Document how to (un)install a git version of liblarch with pip instead.
  • Loading branch information
nekohayo authored and diegogangl committed Jan 11, 2022
1 parent 77bc039 commit f4b8247
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,15 @@ echo 'deb http://deb.debian.org/debian buster-backports main' | sudo tee -a /etc
sudo apt install meson python3-gi-cairo python3-gi gir1.2-pango-1.0 gir1.2-gdkpixbuf-2.0 gir1.2-gtk-3.0 itstool gettext python3-lxml libgirepository1.0-dev
```

liblarch may be harder to come by until distributions package the python3 version of it, alongside GTG 0.4+ itself.
liblarch may be harder to come by until distributions package the python3 version of it, alongside GTG 0.6+ itself.
You can get it meanwhile via PIP (commonly provided by `python3-pip` package):

```sh
pip3 install --user -e git+https://github.com/getting-things-gnome/liblarch.git#egg=liblarch
```

Alternatively, if you had checked out a specific version of liblarch that you want to test, in a parent folder for example (`../liblarch`), you could do: `pip3 install --user ../liblarch/` (you can later remove that with `pip3 uninstall liblarch` if you need to).

Optional Dependencies:
* [setproctitle](https://pypi.org/project/setproctitle/)
(to set the process title when listing processes like `ps`)
Expand Down
8 changes: 3 additions & 5 deletions docs/contributors/test suite - coverage testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,11 @@ omit =
../liblarch/test*
```

# Coverage
# Running the test

coverage run gtg -d

You can add more arguments for gtg at the end of command above. For example, if you would like to use local `liblarch` for both testing, you can use:
Simply execute:

coverage run gtg -d -l
coverage run gtg -d

# Report

Expand Down
4 changes: 0 additions & 4 deletions docs/source/man/gtg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ OPTIONS
**-h, --help**
Prints some information about gtg's usage and options.

**-l, --local-liblarch**
Use local liblarch. Look for the liblarch python library in ../liblarch.
This is mainly useful for testing purpose.

**-t TITLE, --title=TITLE**
Set the window's title to TITLE.

Expand Down

0 comments on commit f4b8247

Please sign in to comment.