From 973afbcec98d92adcbac60b166a44547b5efa587 Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Sat, 2 Apr 2016 08:10:47 -0400 Subject: [PATCH 1/4] Add note about redirecting config for testing. New contributors might like to be reminded to redirect the config access of their locally-built qutebrowser to avoid overwriting their global settings. --- INSTALL.asciidoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/INSTALL.asciidoc b/INSTALL.asciidoc index 1e1d0afd5..241f14f8d 100644 --- a/INSTALL.asciidoc +++ b/INSTALL.asciidoc @@ -266,6 +266,14 @@ your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`): ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" ---- +If you are developing on qutebrowser, you may want to redirect it to a local +config: + +---- +#!/bin/bash +~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@" +---- + Updating ~~~~~~~~ From 2634b333f2b7e1dccc4c8b0bbda14dd7805278bf Mon Sep 17 00:00:00 2001 From: Ryan Roden-Corrent Date: Sat, 2 Apr 2016 11:56:26 -0400 Subject: [PATCH 2/4] Move note about conifg redirect to CONTRIBUTING. This was a note for developers, so it makes more sense to have in CONTRIBUTING. This also adds a section on using tox, which was mentioned only in INSTALL and not CONTRIBUTING. --- CONTRIBUTING.asciidoc | 29 +++++++++++++++++++++++++++++ INSTALL.asciidoc | 8 -------- 2 files changed, 29 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc index 46a388143..f88f5cee5 100644 --- a/CONTRIBUTING.asciidoc +++ b/CONTRIBUTING.asciidoc @@ -63,6 +63,35 @@ handy. Of course, if using git is the issue which prevents you from contributing, feel free to send normal patches instead, e.g. generated via `diff -Nur`. +Running qutebrowser with tox +------------------------------- + +Once you have cloned the repository, you can run tox inside the qutebrowser +repository to set up a +https://docs.python.org/3/library/venv.html[virtual environment]: + +---- +$ tox -e mkvenv +---- + +This installs all needed Python dependencies in a `.venv` subfolder. The +system-wide Qt5/PyQt5 installations are symlinked into the virtual environment. + +You can then create a simple wrapper script to start qutebrowser: + +---- +#!/bin/bash +~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" +---- + +If you regularly use a non-development version of qutebrowser, you may want to +redirect your development version it to a local config using the `-c` flag: + +---- +#!/bin/bash +~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@" +---- + Getting patches ~~~~~~~~~~~~~~~ diff --git a/INSTALL.asciidoc b/INSTALL.asciidoc index 241f14f8d..1e1d0afd5 100644 --- a/INSTALL.asciidoc +++ b/INSTALL.asciidoc @@ -266,14 +266,6 @@ your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`): ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" ---- -If you are developing on qutebrowser, you may want to redirect it to a local -config: - ----- -#!/bin/bash -~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@" ----- - Updating ~~~~~~~~ From c3d154a856ade632b57cb19f3965747768127606 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Mon, 4 Apr 2016 07:59:14 +0200 Subject: [PATCH 3/4] Revert "Move note about conifg redirect to CONTRIBUTING." This reverts commit 2634b333f2b7e1dccc4c8b0bbda14dd7805278bf. --- CONTRIBUTING.asciidoc | 29 ----------------------------- INSTALL.asciidoc | 8 ++++++++ 2 files changed, 8 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc index f88f5cee5..46a388143 100644 --- a/CONTRIBUTING.asciidoc +++ b/CONTRIBUTING.asciidoc @@ -63,35 +63,6 @@ handy. Of course, if using git is the issue which prevents you from contributing, feel free to send normal patches instead, e.g. generated via `diff -Nur`. -Running qutebrowser with tox -------------------------------- - -Once you have cloned the repository, you can run tox inside the qutebrowser -repository to set up a -https://docs.python.org/3/library/venv.html[virtual environment]: - ----- -$ tox -e mkvenv ----- - -This installs all needed Python dependencies in a `.venv` subfolder. The -system-wide Qt5/PyQt5 installations are symlinked into the virtual environment. - -You can then create a simple wrapper script to start qutebrowser: - ----- -#!/bin/bash -~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" ----- - -If you regularly use a non-development version of qutebrowser, you may want to -redirect your development version it to a local config using the `-c` flag: - ----- -#!/bin/bash -~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@" ----- - Getting patches ~~~~~~~~~~~~~~~ diff --git a/INSTALL.asciidoc b/INSTALL.asciidoc index 1e1d0afd5..241f14f8d 100644 --- a/INSTALL.asciidoc +++ b/INSTALL.asciidoc @@ -266,6 +266,14 @@ your `$PATH` (e.g. `/usr/local/bin/qutebrowser` or `~/bin/qutebrowser`): ~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@" ---- +If you are developing on qutebrowser, you may want to redirect it to a local +config: + +---- +#!/bin/bash +~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser -c .qutebrowser-local "$@" +---- + Updating ~~~~~~~~ From 5cdb4336696fb8a84d7ba3981541afd975f0d824 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Mon, 4 Apr 2016 07:59:22 +0200 Subject: [PATCH 4/4] Regenerate authors --- README.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/README.asciidoc b/README.asciidoc index 2a0ebc982..94df11d17 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -195,6 +195,7 @@ Contributors, sorted by the number of commits in descending order: * Larry Hynes * Johannes Altmanninger * Samir Benmendil +* Ryan Roden-Corrent * Regina Hug * Mathias Fussenegger * Marcelo Santos