From 1f39c7782a3b5fde3c46f78c88585142efc34bea Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 7 Apr 2015 22:35:35 +0200 Subject: [PATCH 1/3] Add a changelog for released versions. See #608. --- CHANGELOG.asciidoc | 193 +++++++++++++++++++++++++++++++++++++++ README.asciidoc | 1 + doc/help/index.asciidoc | 1 + scripts/asciidoc2html.py | 1 + 4 files changed, 196 insertions(+) create mode 100644 CHANGELOG.asciidoc diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc new file mode 100644 index 000000000..abf466904 --- /dev/null +++ b/CHANGELOG.asciidoc @@ -0,0 +1,193 @@ +Change Log +=========== + +// http://keepachangelog.com/ + +All notable changes to this project will be documented in this file. +This project adheres to http://semver.org/[Semantic Versioning]. + +// tags: +// `Added` for new features. +// `Changed` for changes in existing functionality. +// `Deprecated` for once-stable features removed in upcoming releases. +// `Removed` for deprecated features removed in this release. +// `Fixed` for any bug fixes. +// `Security` to invite users to upgrade in case of vulnerabilities. + +v0.2.0 (unreleased) +------------------- + +... + +https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.4[v0.1.4] +----------------------------------------------------------------------- + +Changed +~~~~~~~ + +* The Windows builds come with Qt 5.4.1 which has some https://lists.schokokeks.org/pipermail/qutebrowser/2015-March/000054.html[related bugfixes]. +* Improvements to CPU usage when idle. +* Ensure there's no size for `font-family` settings. +* Handle URLs with double-colon as search strings. +* Adjust prompt size hint based on content. +* Refactor websettings and save/restore defaults. +* Various small improvements to logging. +* Various improvements for hinting. +* Improve parsing of `faulthandler` logs. + +Removed +~~~~~~~ + +* Remove default search engines. +* Remove debug console completing completely. + +Fixed +~~~~~ + +* Ignore RuntimeError in `mouserelease_insertmode`. +* Hide Qt warning when aborting download reply. +* Hide "Error while shutting down tabs" message. +* Clear open target in `acceptNavigationRequest`. +* Fix handling of signals with deleted tabs. +* Restore `sys.std*` in `utils.fake_io` on exceptions. +* Allow font names with integers in them. +* Fix `QIODevice` warnings when closing tabs. +* Set the `QSettings` path to a config-subdirectory. +* Add workaround for adblock-message without window. +* Fix searching for terms starting with a slash. +* Ignore tab key presses if they'd switch focus. + +Security +~~~~~~~~ + +* Stop the icon database from being created when private-browsing is set to true. +* Disable insecure SSL ciphers. + +https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.3[v0.1.3] +----------------------------------------------------------------------- + +Changed +~~~~~~~ + +* Various small logging improvements. +* Don't open relative files in `fuzzy_url` with `:open` +* Various crashdialog improvements. +* Hide adblocked iframes. + +Fixed +~~~~~ + +* Handle shutdown of page with prompt correctly. +* fuzzy_url: handle invalid URLs with autosearch off +* Handle explicit searches with `auto-search=false`. +* Abort download override question on error/cancel. +* Set a higher z-index for hint labels. +* Close contextmenu when closing tab to avoid crash. +* Fix statusbar quickly popping up as window. +* Clean up `NetworkManager` after downloads finished. +* Fix restoring of cmd widget after an error. +* Fix retrying of downloads after the tab is closed. +* Fix `check_libraries()` output for Arch Linux. +* Handle all `IPCErrors` properly. +* Handle another `webelem.IsNullError` with hints. +* Handle `UnicodeDecodeError` when reading configs. + +Security +~~~~~~~~ + +* Fix for HTTP passwords accidentally being written to debug log. + +https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.2[v0.1.2] +----------------------------------------------------------------------- + +Changed +~~~~~~~ + +* Uncheck sending of debug log by default when private browsing is on. +* Add SSL info to version info. + +Removed +~~~~~~~ + +* Remove hosts-file.net from blocker default lists. + +Fixed +~~~~~ + +* Fix rare exception when a key is pressed shorly after opening a window +* Fix exception with certain invalid URLs like `http:foo:0` +* Work around Qt bug which renders checkboxes on OS X unusable +* Fix exception when a local files can't be read in `:adblock-update` +* Hide 2 more Qt warnings. +* Add `!important` to hint CSS so websites don't override the hint look +* Make `init_venv.py` work with multiple sip `.so` files. +* Fix splitting with certain commands with an empty argument +* Fix uppercase hints. +* Fix segfaults if another page is loaded while a prompt is open +* Fix exception with invalid `ShellCommand` config values. +* Replace unencodable chars +* Fix user-stylesheet setting with an empty value. + + +https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1.1[v0.1.1] +----------------------------------------------------------------------- + +Added +~~~~~ + +* Set window icon and add a qutebrowser.ico file for Windows. +* Ask the user when downloading to an already existing file. +* Add a `network -> proxy-dns-requests` option. +* Add "Remove finished" to the download context menu +* Open and remove clicked downloads. + +Changes +~~~~~~~ + +* Windows releases are now built with Qt 5.4 which brings many improvements and bugfixes. +* Add a troubleshooting section to the FAQ. +* Display IPC errors to the user. +* Rewrite keymode handling to use only one mode which also fixes various bugs. +* Save version to state config. +* Set zoom to default instead of 100% with `:zoom`/`=`. +* Adjust page zoom if default zoom changed. +* Force tabs to be focused on `:undo`. +* Replace manual installation instructions on OS X with homebrew/macports. +* Allow min-/maximizing of print preview on Windows. +* Various documentation improvements. +* Various other small improvements and cleanups. + +Removed +~~~~~~~ + +* Clean up and temporarily disable alias completion. + +Fixed +~~~~~ + +* Fix setting of `QWebSettings` (e.g. web fonts) with empty strings. +* Re-focus web view when leaving prompt/yesno mode. +* Handle `:restart` correctly with Python eggs. +* Handle an invalid cwd properly. +* Fix popping of a dead question in prompter. +* Fix `AttributeError` on config changes on Ubuntu. +* Don't treat things like "31c3" as IP address. +* Handle category being `None` in Qt message handler. +* Force-include pygments in `freeze.py`. +* Fix scroll percentage not updating on some pages like twitter. +* Encode `Content-Disposition` header name properly. +* Fix item sorting in `NeighborList`. +* Handle data being `None` in download read timer. +* Stop download read timer when reply has finished. +* Fix handling of small/big `fuzzyval`'s in `NeighborList`. +* Fix crashes when entering invalid values in `qute:settings`. +* Abort questions in `NetworkManager` when destroyed. +* Fix height calculation of download view. +* Always auto-remove adblock downloads when done. +* Ensure the docs get included in `freeze.py`. +* Fix crash with `:zoom`. + +https://github.com/The-Compiler/qutebrowser/releases/tag/v0.1[v0.1] +------------------------------------------------------------------- + +Initial release. diff --git a/README.asciidoc b/README.asciidoc index 6ab44051d..ff3b536b7 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -49,6 +49,7 @@ image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding c * link:doc/FAQ.asciidoc[Frequently asked questions] * link:CONTRIBUTING.asciidoc[Contributing to qutebrowser] * link:doc/INSTALL.asciidoc[INSTALL] +* link:CHANGELOG.asciidoc[Change Log] * link:doc/stacktrace.asciidoc[Reporting segfaults] * link:doc/userscripts.asciidoc[How to write userscripts] diff --git a/doc/help/index.asciidoc b/doc/help/index.asciidoc index 0ff537e72..56bb3a807 100644 --- a/doc/help/index.asciidoc +++ b/doc/help/index.asciidoc @@ -8,6 +8,7 @@ The following help pages are currently available: * link:quickstart.html[Quick start guide] * link:FAQ.html[Frequently asked questions] +* link:CHANGELOG.html[Change Log] * link:commands.html[Documentation of commands] * link:settings.html[Documentation of settings] * link:userscripts.html[How to write userscripts] diff --git a/scripts/asciidoc2html.py b/scripts/asciidoc2html.py index 7b0289f6a..b5ca60b20 100755 --- a/scripts/asciidoc2html.py +++ b/scripts/asciidoc2html.py @@ -90,6 +90,7 @@ def main(colors=False): args = parser.parse_args() asciidoc_files = [ ('doc/FAQ.asciidoc', 'qutebrowser/html/doc/FAQ.html'), + ('CHANGELOG.asciidoc', 'qutebrowser/html/doc/CHANGELOG.html'), ('doc/quickstart.asciidoc', 'qutebrowser/html/doc/quickstart.html'), ('doc/userscripts.asciidoc', 'qutebrowser/html/doc/userscripts.html'), ] From b591dedf7fda5ba399937a7db13e22f3d22de405 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 7 Apr 2015 22:38:51 +0200 Subject: [PATCH 2/3] Move FAQ/INSTALL to repo root. That's where most people probably expect them... --- doc/FAQ.asciidoc => FAQ.asciidoc | 0 doc/INSTALL.asciidoc => INSTALL.asciidoc | 0 README.asciidoc | 10 +++++----- scripts/asciidoc2html.py | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) rename doc/FAQ.asciidoc => FAQ.asciidoc (100%) rename doc/INSTALL.asciidoc => INSTALL.asciidoc (100%) diff --git a/doc/FAQ.asciidoc b/FAQ.asciidoc similarity index 100% rename from doc/FAQ.asciidoc rename to FAQ.asciidoc diff --git a/doc/INSTALL.asciidoc b/INSTALL.asciidoc similarity index 100% rename from doc/INSTALL.asciidoc rename to INSTALL.asciidoc diff --git a/README.asciidoc b/README.asciidoc index ff3b536b7..e686ea522 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -34,7 +34,7 @@ See the https://github.com/The-Compiler/qutebrowser/releases[github releases page] for available downloads (currently a source archive, and standalone packages as well as MSI installers for Windows). -See link:doc/INSTALL.asciidoc[INSTALL] for detailed instructions on how to get +See link:INSTALL.asciidoc[INSTALL] for detailed instructions on how to get qutebrowser running for various platforms. Documentation @@ -46,9 +46,9 @@ available: * A http://qutebrowser.org/img/cheatsheet-big.png[key binding cheatsheet]: + image:http://qutebrowser.org/img/cheatsheet-small.png["qutebrowser key binding cheatsheet",link="http://qutebrowser.org/img/cheatsheet-big.png"] * link:doc/quickstart.asciidoc[Quick start guide] -* link:doc/FAQ.asciidoc[Frequently asked questions] +* link:FAQ.asciidoc[Frequently asked questions] * link:CONTRIBUTING.asciidoc[Contributing to qutebrowser] -* link:doc/INSTALL.asciidoc[INSTALL] +* link:INSTALL.asciidoc[INSTALL] * link:CHANGELOG.asciidoc[Change Log] * link:doc/stacktrace.asciidoc[Reporting segfaults] * link:doc/userscripts.asciidoc[How to write userscripts] @@ -108,8 +108,8 @@ console: * https://pypi.python.org/pypi/colorlog/[colorlog] * On Windows: https://pypi.python.org/pypi/colorama/[colorama] -See link:doc/INSTALL.asciidoc[INSTALL] for directions on how to install -qutebrowser and its dependencies. +See link:INSTALL.asciidoc[INSTALL] for directions on how to install qutebrowser +and its dependencies. Donating -------- diff --git a/scripts/asciidoc2html.py b/scripts/asciidoc2html.py index b5ca60b20..707a780c9 100755 --- a/scripts/asciidoc2html.py +++ b/scripts/asciidoc2html.py @@ -89,7 +89,7 @@ def main(colors=False): metavar=('PYTHON', 'ASCIIDOC')) args = parser.parse_args() asciidoc_files = [ - ('doc/FAQ.asciidoc', 'qutebrowser/html/doc/FAQ.html'), + ('FAQ.asciidoc', 'qutebrowser/html/doc/FAQ.html'), ('CHANGELOG.asciidoc', 'qutebrowser/html/doc/CHANGELOG.html'), ('doc/quickstart.asciidoc', 'qutebrowser/html/doc/quickstart.html'), ('doc/userscripts.asciidoc', 'qutebrowser/html/doc/userscripts.html'), From 10619325f6a932af18041c612530da1fc0294441 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Tue, 7 Apr 2015 22:41:22 +0200 Subject: [PATCH 3/3] Update MANIFEST.in/.gitignore. --- .gitignore | 4 ++++ MANIFEST.in | 3 +-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 0cdfea7c2..8b81dfc20 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,10 @@ __pycache__ /qutebrowser/git-commit-id /doc/*.html /README.html +/CHANGELOG.html +/CONTRIBUTING.html +/FAQ.html +/INSTALL.html /qutebrowser/html/doc/ /.venv /.coverage diff --git a/MANIFEST.in b/MANIFEST.in index d619c0702..681ca170b 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -8,7 +8,7 @@ graft doc/img graft misc include qutebrowser/test/testfile include qutebrowser/git-commit-id -include COPYING doc/* README.asciidoc +include COPYING doc/* README.asciidoc CONTRIBUTING.asciidoc FAQ.asciidoc INSTALL.asciidoc CHANGELOG.asciidoc include qutebrowser.desktop include requirements.txt include tox.ini @@ -22,7 +22,6 @@ exclude scripts/gen_resources.sh exclude scripts/quit_segfault_test.sh exclude scripts/segfault_test.sh exclude doc/notes -exclude CONTRIBUTING.asciidoc recursive-exclude doc *.asciidoc prune test exclude qutebrowser.rcc