From 3192d98bdc5e730a71158dbfd46ab1cf5e0b05d0 Mon Sep 17 00:00:00 2001
From: Florian Bruhin <me@the-compiler.org>
Date: Fri, 12 Mar 2021 22:25:42 +0100
Subject: doc: Move backend info above type info

More consistent with other comments (like requiring a restart)
---
 doc/help/settings.asciidoc  | 164 ++++++++++++++++++++++----------------------
 scripts/dev/src2asciidoc.py |   2 +-
 2 files changed, 83 insertions(+), 83 deletions(-)

diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc
index 7a5cfd47b..0ecd7d753 100644
--- a/doc/help/settings.asciidoc
+++ b/doc/help/settings.asciidoc
@@ -1600,6 +1600,8 @@ The `lightness-cielab` value was added with QtWebEngine 5.14 and is treated like
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -1610,8 +1612,6 @@ Valid values:
 
 Default: +pass:[lightness-cielab]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[colors.webpage.darkmode.contrast]]
 === colors.webpage.darkmode.contrast
 Contrast for dark mode.
@@ -1619,12 +1619,12 @@ This only has an effect when `colors.webpage.darkmode.algorithm` is set to `ligh
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Float>>
 
 Default: +pass:[0.0]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[colors.webpage.darkmode.enabled]]
 === colors.webpage.darkmode.enabled
 Render all web contents using a dark theme.
@@ -1645,12 +1645,12 @@ Example configurations from Chromium's `chrome://flags`:
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[colors.webpage.darkmode.grayscale.all]]
 === colors.webpage.darkmode.grayscale.all
 Render all colors as grayscale.
@@ -1658,12 +1658,12 @@ This only has an effect when `colors.webpage.darkmode.algorithm` is set to `ligh
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[colors.webpage.darkmode.grayscale.images]]
 === colors.webpage.darkmode.grayscale.images
 Desaturation factor for images in dark mode.
@@ -1671,14 +1671,14 @@ If set to 0, images are left as-is. If set to 1, images are completely grayscale
 
 This setting requires a restart.
 
-Type: <<types,Float>>
-
-Default: +pass:[0.0]+
-
 On QtWebEngine, this setting requires Qt 5.14 or newer.
 
 On QtWebKit, this setting is unavailable.
 
+Type: <<types,Float>>
+
+Default: +pass:[0.0]+
+
 [[colors.webpage.darkmode.policy.images]]
 === colors.webpage.darkmode.policy.images
 Which images to apply dark mode to.
@@ -1686,6 +1686,8 @@ With QtWebEngine 5.15.0, this setting can cause frequent renderer process crashe
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -1696,8 +1698,6 @@ Valid values:
 
 Default: +pass:[smart]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[colors.webpage.darkmode.policy.page]]
 === colors.webpage.darkmode.policy.page
 Which pages to apply dark mode to.
@@ -1705,6 +1705,10 @@ The underlying Chromium setting has been removed in QtWebEngine 5.15.3, thus thi
 
 This setting requires a restart.
 
+On QtWebEngine, this setting requires Qt 5.14 or newer.
+
+On QtWebKit, this setting is unavailable.
+
 Type: <<types,String>>
 
 Valid values:
@@ -1714,10 +1718,6 @@ Valid values:
 
 Default: +pass:[smart]+
 
-On QtWebEngine, this setting requires Qt 5.14 or newer.
-
-On QtWebKit, this setting is unavailable.
-
 [[colors.webpage.darkmode.threshold.background]]
 === colors.webpage.darkmode.threshold.background
 Threshold for inverting background elements with dark mode.
@@ -1726,14 +1726,14 @@ Note: This behavior is the opposite of `colors.webpage.darkmode.threshold.text`!
 
 This setting requires a restart.
 
-Type: <<types,Int>>
-
-Default: +pass:[0]+
-
 On QtWebEngine, this setting requires Qt 5.14 or newer.
 
 On QtWebKit, this setting is unavailable.
 
+Type: <<types,Int>>
+
+Default: +pass:[0]+
+
 [[colors.webpage.darkmode.threshold.text]]
 === colors.webpage.darkmode.threshold.text
 Threshold for inverting text with dark mode.
@@ -1741,14 +1741,14 @@ Text colors with brightness below this threshold will be inverted, and above it
 
 This setting requires a restart.
 
-Type: <<types,Int>>
-
-Default: +pass:[256]+
-
 On QtWebEngine, this setting requires Qt 5.14 or newer.
 
 On QtWebKit, this setting is unavailable.
 
+Type: <<types,Int>>
+
+Default: +pass:[256]+
+
 [[colors.webpage.preferred_color_scheme]]
 === colors.webpage.preferred_color_scheme
 Value to use for `prefers-color-scheme:` for websites.
@@ -1757,6 +1757,10 @@ The "auto" value is broken on QtWebEngine 5.15.2 due to a Qt bug. There, it will
 
 This setting requires a restart.
 
+On QtWebEngine, this setting requires Qt 5.14 or newer.
+
+On QtWebKit, this setting is unavailable.
+
 Type: <<types,String>>
 
 Valid values:
@@ -1767,10 +1771,6 @@ Valid values:
 
 Default: +pass:[auto]+
 
-On QtWebEngine, this setting requires Qt 5.14 or newer.
-
-On QtWebKit, this setting is unavailable.
-
 [[completion.cmd_history_max_items]]
 === completion.cmd_history_max_items
 Number of commands to save in the command history.
@@ -1942,12 +1942,12 @@ Automatically start playing `<video>` elements.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.blocking.adblock.lists]]
 === content.blocking.adblock.lists
 List of URLs to ABP-style adblocking rulesets.
@@ -2040,24 +2040,24 @@ An application cache acts like an HTTP cache in some sense. For documents that u
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebKit backend.
-
 [[content.cache.maximum_pages]]
 === content.cache.maximum_pages
 Maximum number of pages to hold in the global memory page cache.
 The page cache allows for a nicer user experience when navigating forth or back to pages in the forward/back history, by pausing and resuming up to _n_ pages.
 For more information about the feature, please refer to: https://webkit.org/blog/427/webkit-page-cache-i-the-basics/
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Int>>
 
 Default: +pass:[0]+
 
-This setting is only available with the QtWebKit backend.
-
 [[content.cache.size]]
 === content.cache.size
 Size (in bytes) of the HTTP network cache. Null to use the default value.
@@ -2074,12 +2074,12 @@ Note this is needed for some websites to work properly.
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.cookies.accept]]
 === content.cookies.accept
 Which cookies to accept.
@@ -2139,12 +2139,12 @@ Try to pre-fetch DNS entries to speed up browsing.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.frame_flattening]]
 === content.frame_flattening
 Expand each subframe to its contents.
@@ -2152,12 +2152,12 @@ This will flatten all the frames to become one scrollable page.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebKit backend.
-
 [[content.fullscreen.overlay_timeout]]
 === content.fullscreen.overlay_timeout
 Set fullscreen notification overlay timeout in milliseconds.
@@ -2316,12 +2316,12 @@ Allow JavaScript to close tabs.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebKit backend.
-
 [[content.javascript.can_open_tabs_automatically]]
 === content.javascript.can_open_tabs_automatically
 Allow JavaScript to open new tabs without user interaction.
@@ -2410,6 +2410,8 @@ Allow websites to record audio.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2420,14 +2422,14 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.media.audio_video_capture]]
 === content.media.audio_video_capture
 Allow websites to record audio and video.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2438,14 +2440,14 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.media.video_capture]]
 === content.media.video_capture
 Allow websites to record video.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2456,14 +2458,14 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.mouse_lock]]
 === content.mouse_lock
 Allow websites to lock your mouse pointer.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2474,8 +2476,6 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.mute]]
 === content.mute
 Automatically mute tabs.
@@ -2502,6 +2502,8 @@ Allow websites to show notifications.
 
 This setting supports URL patterns.
 
+On QtWebEngine, this setting requires Qt 5.13 or newer.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2512,8 +2514,6 @@ Valid values:
 
 Default: +pass:[ask]+
 
-On QtWebEngine, this setting requires Qt 5.13 or newer.
-
 [[content.pdfjs]]
 === content.pdfjs
 Allow pdf.js to view PDF files in the browser.
@@ -2531,6 +2531,8 @@ Allow websites to request persistent storage quota via `navigator.webkitPersiste
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2541,8 +2543,6 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.plugins]]
 === content.plugins
 Enable plugins in Web pages.
@@ -2559,12 +2559,12 @@ Draw the background color and images also when the page is printed.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.private_browsing]]
 === content.private_browsing
 Open new windows in private browsing mode which does not record visited pages.
@@ -2592,18 +2592,20 @@ Default: +pass:[system]+
 === content.proxy_dns_requests
 Send DNS requests over the configured proxy.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-This setting is only available with the QtWebKit backend.
-
 [[content.register_protocol_handler]]
 === content.register_protocol_handler
 Allow websites to register protocol handlers via `navigator.registerProtocolHandler`.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,BoolAsk>>
 
 Valid values:
@@ -2614,8 +2616,6 @@ Valid values:
 
 Default: +pass:[ask]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.site_specific_quirks]]
 === content.site_specific_quirks
 Enable quirks (such as faked user agent headers) needed to get specific sites to work properly.
@@ -2648,6 +2648,8 @@ How navigation requests to URLs with unknown schemes are handled.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -2658,8 +2660,6 @@ Valid values:
 
 Default: +pass:[allow-from-user-interaction]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.user_stylesheets]]
 === content.user_stylesheets
 List of user stylesheet filenames to use.
@@ -2684,6 +2684,8 @@ Which interfaces to expose via WebRTC.
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -2695,8 +2697,6 @@ Valid values:
 
 Default: +pass:[all-interfaces]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[content.xss_auditing]]
 === content.xss_auditing
 Monitor load requests for cross-site scripting attempts.
@@ -3120,6 +3120,8 @@ Default: +pass:[/usr/share/dict/words]+
 === hints.find_implementation
 Which implementation to use to find elements to hint.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -3129,8 +3131,6 @@ Valid values:
 
 Default: +pass:[python]+
 
-This setting is only available with the QtWebKit backend.
-
 [[hints.hide_unmatched_rapid_hints]]
 === hints.hide_unmatched_rapid_hints
 Hide unmatched hints in rapid mode.
@@ -3600,6 +3600,8 @@ This is needed for QtWebEngine to work with Nouveau drivers and can be useful in
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -3611,8 +3613,6 @@ Valid values:
 
 Default: +pass:[none]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[qt.highdpi]]
 === qt.highdpi
 Turn on Qt HighDPI scaling.
@@ -3632,6 +3632,8 @@ This improves the RAM usage of renderer processes, at the expense of performance
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -3642,8 +3644,6 @@ Valid values:
 
 Default: +pass:[auto]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[qt.process_model]]
 === qt.process_model
 Which Chromium process model to use.
@@ -3655,6 +3655,8 @@ See the following pages for more details:
 
 This setting requires a restart.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,String>>
 
 Valid values:
@@ -3665,20 +3667,18 @@ Valid values:
 
 Default: +pass:[process-per-site-instance]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[qt.workarounds.locale]]
 === qt.workarounds.locale
 Work around locale parsing issues in QtWebEngine 5.15.3.
 With some locales, QtWebEngine 5.15.3 is unusable without this workaround. In affected scenarios, QtWebEngine will log "Network service crashed, restarting service." and only display a blank page.
 However, It is expected that distributions shipping QtWebEngine 5.15.3 follow up with a proper fix soon, so it is disabled by default.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebEngine backend.
-
 [[qt.workarounds.remove_service_workers]]
 === qt.workarounds.remove_service_workers
 Delete the QtWebEngine Service Worker directory on every start.
@@ -3741,12 +3741,12 @@ Default: +pass:[true]+
 === search.wrap
 Wrap around at the top and bottom of the page when advancing through text matches using `:search-next` and `:search-prev`.
 
+On QtWebEngine, this setting requires Qt 5.14 or newer.
+
 Type: <<types,Bool>>
 
 Default: +pass:[true]+
 
-On QtWebEngine, this setting requires Qt 5.14 or newer.
-
 [[session.default_name]]
 === session.default_name
 Name of the session to save by default.
@@ -3769,6 +3769,8 @@ Default: +pass:[false]+
 Languages to use for spell checking.
 You can check for available languages and install dictionaries using scripts/dictcli.py. Run the script with -h/--help for instructions.
 
+This setting is only available with the QtWebEngine backend.
+
 Type: <<types,List of String>>
 
 Valid values:
@@ -3819,8 +3821,6 @@ Valid values:
 
 Default: empty
 
-This setting is only available with the QtWebEngine backend.
-
 [[statusbar.padding]]
 === statusbar.padding
 Padding (in pixels) for the statusbar.
@@ -4438,12 +4438,12 @@ Apply the zoom factor on a frame only to the text or to all content.
 
 This setting supports URL patterns.
 
+This setting is only available with the QtWebKit backend.
+
 Type: <<types,Bool>>
 
 Default: +pass:[false]+
 
-This setting is only available with the QtWebKit backend.
-
 == Setting types
 [[types]]
 [options="header",width="75%",cols="25%,75%"]
diff --git a/scripts/dev/src2asciidoc.py b/scripts/dev/src2asciidoc.py
index 4f05f98ca..375868349 100755
--- a/scripts/dev/src2asciidoc.py
+++ b/scripts/dev/src2asciidoc.py
@@ -447,6 +447,7 @@ def _generate_setting_option(f, opt):
         f.write("\nThis setting supports URL patterns.\n")
     if opt.no_autoconfig:
         f.write("\nThis setting can only be set in config.py.\n")
+    _generate_setting_backend_info(f, opt)
     f.write("\n")
     typ = opt.typ.get_name().replace(',', '&#44;')
     f.write('Type: <<types,{typ}>>\n'.format(typ=typ))
@@ -465,7 +466,6 @@ def _generate_setting_option(f, opt):
         f.write("\n")
 
     f.write("Default: {}\n".format(opt.typ.to_doc(opt.default)))
-    _generate_setting_backend_info(f, opt)
 
 
 def generate_settings(filename):
-- 
cgit v1.2.3-54-g00ecf