summaryrefslogtreecommitdiff
path: root/doc/contributing.asciidoc
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2021-01-26 15:16:36 +0100
committerFlorian Bruhin <me@the-compiler.org>2021-01-26 15:19:01 +0100
commit1a4fff1a4216d4d2736621527e2ff6c744ab6656 (patch)
treee31c962c150353f37826c276f50c7d6530d022ed /doc/contributing.asciidoc
parenteeb26a6aa8e9ddc7b48d656ea93dea987ee88c79 (diff)
downloadqutebrowser-1a4fff1a4216d4d2736621527e2ff6c744ab6656.tar.gz
qutebrowser-1a4fff1a4216d4d2736621527e2ff6c744ab6656.zip
doc: Switch URLs to https
Diffstat (limited to 'doc/contributing.asciidoc')
-rw-r--r--doc/contributing.asciidoc78
1 files changed, 38 insertions, 40 deletions
diff --git a/doc/contributing.asciidoc b/doc/contributing.asciidoc
index f50067571..dc7b331b1 100644
--- a/doc/contributing.asciidoc
+++ b/doc/contributing.asciidoc
@@ -27,7 +27,7 @@ several ways:
https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[subscribe]
first).
* Join the IRC channel irc://irc.freenode.org/#qutebrowser[`#qutebrowser`] on
-http://freenode.net/[Freenode]
+https://freenode.net/[Freenode]
(https://webchat.freenode.net/?channels=#qutebrowser[webchat]).
Finding something to work on
@@ -60,14 +60,14 @@ There are also some things to do if you don't want to write code:
Using git
---------
-qutebrowser uses http://git-scm.com/[git] for its development. You can clone
+qutebrowser uses https://git-scm.com/[git] for its development. You can clone
the repo like this:
----
git clone https://github.com/qutebrowser/qutebrowser.git
----
-If you don't know git, a http://git-scm.com/[git cheatsheet] might come in
+If you don't know git, a https://git-scm.com/[git cheatsheet] might come in
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`.
@@ -117,10 +117,10 @@ Currently, the following tox environments are available:
* `flake8`: Run various linting checks via https://pypi.python.org/pypi/flake8[flake8].
* `vulture`: Run https://pypi.python.org/pypi/vulture[vulture] to find
unused code portions.
-* `pylint`: Run http://pylint.org/[pylint] static code analysis.
+* `pylint`: Run https://pylint.org/[pylint] static code analysis.
* `pyroma`: Check packaging practices with
https://pypi.python.org/pypi/pyroma/[pyroma].
-* `eslint`: Run http://eslint.org/[ESLint] javascript checker.
+* `eslint`: Run https://eslint.org/[ESLint] javascript checker.
* `check-manifest`: Check MANIFEST.in completeness with
https://github.com/mgedmin/check-manifest[check-manifest].
* `mkvenv`: Bootstrap a virtualenv for testing.
@@ -193,8 +193,8 @@ qutebrowser instance, waits for it to exit and then shows the graph.
Available methods for visualization are:
* https://jiffyclub.github.io/snakeviz/[SnakeViz] (`--profile-tool=snakeviz`, the default)
-* https://pypi.python.org/pypi/pyprof2calltree/[pyprof2calltree] and http://kcachegrind.sourceforge.net/html/Home.html[KCacheGrind] (`--profile-tool=kcachegrind`)
-* https://github.com/jrfonseca/gprof2dot[gprof2dot] (`--profile-tool=gprof2dot`, needs `dot` from http://graphviz.org/[Graphviz] and http://feh.finalrewind.org/[feh])
+* https://pypi.python.org/pypi/pyprof2calltree/[pyprof2calltree] and https://kcachegrind.github.io/[KCacheGrind] (`--profile-tool=kcachegrind`)
+* https://github.com/jrfonseca/gprof2dot[gprof2dot] (`--profile-tool=gprof2dot`, needs `dot` from https://graphviz.org/[Graphviz] and https://feh.finalrewind.org/[feh])
* https://github.com/nschloe/tuna[tuna] (`--profile-tool=tuna`)
You can also save the binary profile data to a file (`--profile-tool=none`).
@@ -219,17 +219,16 @@ Useful websites
Some resources which might be handy:
-* http://doc.qt.io/qt-5/classes.html[The Qt5 reference]
+* https://doc.qt.io/qt-5/classes.html[The Qt5 reference]
* https://docs.python.org/3/library/index.html[The Python reference]
-* http://httpbin.org/[httpbin, a test service for HTTP requests/responses]
+* https://httpbin.org/[httpbin, a test service for HTTP requests/responses]
* https://requestbin.com/[RequestBin, a service to inspect HTTP requests]
Documentation of used Python libraries:
-* http://jinja.pocoo.org/docs/dev/[jinja2]
-* http://pygments.org/docs/[pygments]
-* http://pythonhosted.org/setuptools/[setuptools]
-* http://www.pyinstaller.org/[PyInstaller]
+* https://jinja.palletsprojects.com/[jinja2]
+* https://pygments.org/docs/[pygments]
+* https://www.pyinstaller.org/[PyInstaller]
* https://pypi.python.org/pypi/colorama[colorama]
Related RFCs and standards:
@@ -239,50 +238,49 @@ HTTP
* https://tools.ietf.org/html/rfc2616[RFC 2616 - Hypertext Transfer Protocol
-- HTTP/1.1]
-(http://www.rfc-editor.org/errata_search.php?rfc=2616[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=2616[Errata])
* https://tools.ietf.org/html/rfc7230[RFC 7230 - Hypertext Transfer Protocol
(HTTP/1.1): Message Syntax and Routing]
-(http://www.rfc-editor.org/errata_search.php?rfc=7230[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7230[Errata])
* https://tools.ietf.org/html/rfc7231[RFC 7231 - Hypertext Transfer Protocol
(HTTP/1.1): Semantics and Content]
-(http://www.rfc-editor.org/errata_search.php?rfc=7231[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7231[Errata])
* https://tools.ietf.org/html/rfc7232[RFC 7232 - Hypertext Transfer Protocol
(HTTP/1.1): Conditional Requests]
-(http://www.rfc-editor.org/errata_search.php?rfc=7232[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7232[Errata])
* https://tools.ietf.org/html/rfc7233[RFC 7233 - Hypertext Transfer Protocol
(HTTP/1.1): Range Requests]
-(http://www.rfc-editor.org/errata_search.php?rfc=7233[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7233[Errata])
* https://tools.ietf.org/html/rfc7234[RFC 7234 - Hypertext Transfer Protocol
(HTTP/1.1): Caching]
-(http://www.rfc-editor.org/errata_search.php?rfc=7234[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7234[Errata])
* https://tools.ietf.org/html/rfc7235[RFC 7235 - Hypertext Transfer Protocol
(HTTP/1.1): Authentication]
-(http://www.rfc-editor.org/errata_search.php?rfc=7235[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=7235[Errata])
* https://tools.ietf.org/html/rfc5987[RFC 5987 - Character Set and Language
Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters]
-(http://www.rfc-editor.org/errata_search.php?rfc=5987[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=5987[Errata])
* https://tools.ietf.org/html/rfc6266[RFC 6266 - Use of the
Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)]
-(http://www.rfc-editor.org/errata_search.php?rfc=6266[Errata])
-* http://tools.ietf.org/html/rfc6265[RFC 6265 - HTTP State Management Mechanism
-(Cookies)] (http://www.rfc-editor.org/errata_search.php?rfc=6265[Errata])
+(https://www.rfc-editor.org/errata_search.php?rfc=6266[Errata])
+* https://tools.ietf.org/html/rfc6265[RFC 6265 - HTTP State Management Mechanism
+(Cookies)] (https://www.rfc-editor.org/errata_search.php?rfc=6265[Errata])
* http://www.cookiecentral.com/faq/#3.5[Netscape Cookie Format]
Other
^^^^^
* https://tools.ietf.org/html/rfc5646[RFC 5646 - Tags for Identifying
-Languages] (http://www.rfc-editor.org/errata_search.php?rfc=5646[Errata])
-* http://www.w3.org/TR/CSS2/[Cascading Style Sheets Level 2 Revision 1 (CSS
+Languages] (https://www.rfc-editor.org/errata_search.php?rfc=5646[Errata])
+* https://www.w3.org/TR/CSS2/[Cascading Style Sheets Level 2 Revision 1 (CSS
2.1) Specification]
-* http://doc.qt.io/qt-5/stylesheet-reference.html[Qt Style Sheets Reference]
-* http://mimesniff.spec.whatwg.org/[MIME Sniffing Standard]
-* http://spec.whatwg.org/[WHATWG specifications]
-* http://www.w3.org/html/wg/drafts/html/master/Overview.html[HTML 5.1 Nightly]
-* http://www.w3.org/TR/webstorage/[Web Storage]
-* http://www.brynosaurus.com/cachedir/spec.html[Cache directory tagging
-standard]
-* http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG
+* https://doc.qt.io/qt-5/stylesheet-reference.html[Qt Style Sheets Reference]
+* https://mimesniff.spec.whatwg.org/[MIME Sniffing Standard]
+* https://spec.whatwg.org/[WHATWG specifications]
+* https://www.w3.org/html/wg/drafts/html/master/Overview.html[HTML 5.1 Nightly]
+* https://www.w3.org/TR/webstorage/[Web Storage]
+* https://bford.info/cachedir/[Cache directory tagging standard]
+* https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG
basedir specification]
Hints
@@ -355,7 +353,7 @@ All objects can be printed by starting with the `--debug` flag and using the
The registry is mainly used for <<commands,command handlers>>, but it can
also be useful in places where using Qt's
-http://doc.qt.io/qt-5/signalsandslots.html[signals and slots] mechanism would
+https://doc.qt.io/qt-5/signalsandslots.html[signals and slots] mechanism would
be difficult.
Logging
@@ -435,7 +433,7 @@ e.g., an argument `foo=True` will be converted to a flag `-f`/`--foo` in
qutebrowser's commandline.
The type can be overridden using Python's
-http://legacy.python.org/dev/peps/pep-3107/[function annotations]:
+https://www.python.org/dev/peps/pep-3107/[function annotations]:
[source,python]
----
@@ -522,7 +520,7 @@ Running valgrind on QtWebKit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to run qutebrowser (and thus QtWebKit) with
-http://valgrind.org/[valgrind], you'll need to pass `--smc-check=all` to it or
+https://valgrind.org/[valgrind], you'll need to pass `--smc-check=all` to it or
recompile QtWebKit with the Javascript JIT disabled.
This is needed so valgrind handles self-modifying code correctly:
@@ -600,20 +598,20 @@ The hierarchy of widgets when QtWebEngine is involved looks like this:
- The `WebEngineTab` has a `_widget` attribute, which is the https://doc.qt.io/qt-5/qwebengineview.html[QWebEngineView]
- That view has a https://doc.qt.io/qt-5/qwebenginepage.html[QWebEnginePage] for everything which doesn't require rendering.
- The view also has a layout with exactly one element (which also is its `focusProxy()`)
-- That element is the http://code.qt.io/cgit/qt/qtwebengine.git/tree/src/webenginewidgets/render_widget_host_view_qt_delegate_widget.cpp[RenderWidgetHostViewQtDelegateWidget] (it inherits https://doc.qt.io/qt-5/qquickwidget.html[QQuickWidget]) - also often referred to as RWHV or RWHVQDW. It can be obtained via `sip.cast(tab._widget.focusProxy(), QQuickWidget)`.
+- That element is the https://code.qt.io/cgit/qt/qtwebengine.git/tree/src/webenginewidgets/render_widget_host_view_qt_delegate_widget.cpp[RenderWidgetHostViewQtDelegateWidget] (it inherits https://doc.qt.io/qt-5/qquickwidget.html[QQuickWidget]) - also often referred to as RWHV or RWHVQDW. It can be obtained via `sip.cast(tab._widget.focusProxy(), QQuickWidget)`.
- Calling `rootObject()` on that gives us the https://doc.qt.io/qt-5/qquickitem.html[QQuickItem] where Chromium renders into (?). With it, we can do things like `.setRotation(20)`.
Style conventions
-----------------
qutebrowser's coding conventions are based on
-http://legacy.python.org/dev/peps/pep-0008/[PEP8] and the https://google.github.io/styleguide/pyguide.html[Google Python style guidelines] with some additions:
+https://www.python.org/dev/peps/pep-0008/[PEP8] and the https://google.github.io/styleguide/pyguide.html[Google Python style guidelines] with some additions:
* The _Raise:_ section is not added to the docstring.
* Methods overriding Qt methods (obviously!) don't follow the naming schemes.
* Everything else does though, even slots.
* Docstrings should look like described in
-http://legacy.python.org/dev/peps/pep-0257/[PEP257] and the google guidelines.
+https://www.python.org/dev/peps/pep-0257/[PEP257] and the google guidelines.
* Class docstrings have additional _Attributes:_, _Class attributes:_ and
_Signals:_ sections.
* In docstrings of command handlers (registered via `@cmdutils.register`), the