diff options
author | Franz Pletz <fpletz@fnordicwalking.de> | 2017-03-17 23:31:52 +0100 |
---|---|---|
committer | Franz Pletz <fpletz@fnordicwalking.de> | 2017-03-17 23:36:19 +0100 |
commit | 953616907493c5b81ba3ec9dd86f1422f4d1fcd3 (patch) | |
tree | 1ebe5e1caaed3b8a5920280bba56406974202326 /nixos/modules/services | |
parent | a8785daf0ea794f1791c598c6cac9db3858b45bb (diff) | |
download | nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar.gz nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar.bz2 nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar.lz nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar.xz nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.tar.zst nixlib-953616907493c5b81ba3ec9dd86f1422f4d1fcd3.zip |
nixos/treewide: remove boolean examples for options
They contain no useful information and increase the length of the autogenerated options documentation. See discussion in #18816.
Diffstat (limited to 'nixos/modules/services')
35 files changed, 1 insertions, 65 deletions
diff --git a/nixos/modules/services/backup/rsnapshot.nix b/nixos/modules/services/backup/rsnapshot.nix index 16815bcc8605..bb5dcab1dcf2 100644 --- a/nixos/modules/services/backup/rsnapshot.nix +++ b/nixos/modules/services/backup/rsnapshot.nix @@ -26,7 +26,6 @@ in enableManualRsnapshot = mkOption { description = "Whether to enable manual usage of the rsnapshot command with this module."; default = true; - example = false; type = types.bool; }; diff --git a/nixos/modules/services/computing/boinc/client.nix b/nixos/modules/services/computing/boinc/client.nix index 91bd463732de..e43b6bbb2536 100644 --- a/nixos/modules/services/computing/boinc/client.nix +++ b/nixos/modules/services/computing/boinc/client.nix @@ -12,7 +12,6 @@ in enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable the BOINC distributed computing client. If this option is set to true, the boinc_client daemon will be run as a @@ -41,7 +40,6 @@ in allowRemoteGuiRpc = mkOption { type = types.bool; default = false; - example = true; description = '' If set to true, any remote host can connect to and control this BOINC client (subject to password authentication). If instead set to false, diff --git a/nixos/modules/services/databases/cassandra.nix b/nixos/modules/services/databases/cassandra.nix index b43b448ed7e1..5df4ae57f809 100644 --- a/nixos/modules/services/databases/cassandra.nix +++ b/nixos/modules/services/databases/cassandra.nix @@ -310,7 +310,6 @@ in { autoBootstrap = mkOption { description = "It makes new (non-seed) nodes automatically migrate the right data to themselves."; default = true; - example = true; type = types.bool; }; streamingSocketTimoutInMS = mkOption { diff --git a/nixos/modules/services/databases/openldap.nix b/nixos/modules/services/databases/openldap.nix index d76859bf3eb6..e884098cb08d 100644 --- a/nixos/modules/services/databases/openldap.nix +++ b/nixos/modules/services/databases/openldap.nix @@ -25,7 +25,6 @@ in description = " Whether to enable the ldap server. "; - example = true; }; user = mkOption { diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix index 08fa6de6374c..2c5a0c4849ef 100644 --- a/nixos/modules/services/editors/emacs.nix +++ b/nixos/modules/services/editors/emacs.nix @@ -21,7 +21,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable a user service for the Emacs daemon. Use <literal>emacsclient</literal> to connect to the daemon. If <literal>true</literal>, <varname>services.emacs.install</varname> is @@ -32,7 +31,6 @@ in { install = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to install a user service for the Emacs daemon. Once the service is started, use emacsclient to connect to the @@ -57,7 +55,6 @@ in { defaultEditor = mkOption { type = types.bool; default = false; - example = true; description = '' When enabled, configures emacsclient to be the default editor using the EDITOR environment variable. diff --git a/nixos/modules/services/mail/offlineimap.nix b/nixos/modules/services/mail/offlineimap.nix index 85ece020905b..4b24bd8d0813 100644 --- a/nixos/modules/services/mail/offlineimap.nix +++ b/nixos/modules/services/mail/offlineimap.nix @@ -12,7 +12,6 @@ in { install = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to install a user service for Offlineimap. Once the service is started, emails will be fetched automatically. diff --git a/nixos/modules/services/misc/ihaskell.nix b/nixos/modules/services/misc/ihaskell.nix index df7b9be0db50..e07a4a44613a 100644 --- a/nixos/modules/services/misc/ihaskell.nix +++ b/nixos/modules/services/misc/ihaskell.nix @@ -16,7 +16,6 @@ in services.ihaskell = { enable = mkOption { default = false; - example = true; description = "Autostart an IHaskell notebook service."; }; diff --git a/nixos/modules/services/misc/taskserver/default.nix b/nixos/modules/services/misc/taskserver/default.nix index 826f463bbd75..ba9f52f1904b 100644 --- a/nixos/modules/services/misc/taskserver/default.nix +++ b/nixos/modules/services/misc/taskserver/default.nix @@ -148,7 +148,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable the Taskwarrior server. diff --git a/nixos/modules/services/monitoring/arbtt.nix b/nixos/modules/services/monitoring/arbtt.nix index 1135c2c441cb..a8d5e3b7fa07 100644 --- a/nixos/modules/services/monitoring/arbtt.nix +++ b/nixos/modules/services/monitoring/arbtt.nix @@ -10,7 +10,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable the arbtt statistics capture service. ''; diff --git a/nixos/modules/services/networking/aiccu.nix b/nixos/modules/services/networking/aiccu.nix index 4301da288814..aeb0910d6246 100644 --- a/nixos/modules/services/networking/aiccu.nix +++ b/nixos/modules/services/networking/aiccu.nix @@ -35,7 +35,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = "Enable aiccu IPv6 over IPv4 SiXXs tunnel"; }; @@ -88,21 +87,18 @@ in { verbose = mkOption { type = types.bool; default = false; - example = true; description = "Be verbose?"; }; automatic = mkOption { type = types.bool; default = true; - example = false; description = "Automatic Login and Tunnel activation"; }; requireTLS = mkOption { type = types.bool; default = false; - example = true; description = '' When set to true, if TLS is not supported on the server the TIC transaction will fail. @@ -124,7 +120,6 @@ in { defaultRoute = mkOption { type = types.bool; default = true; - example = false; description = "Add a default route"; }; @@ -138,7 +133,6 @@ in { makeHeartBeats = mkOption { type = types.bool; default = true; - example = false; description = '' In general you don't want to turn this off Of course only applies to AYIYA and heartbeat tunnels not to static ones @@ -148,21 +142,18 @@ in { noConfigure = mkOption { type = types.bool; default = false; - example = true; description = "Don't configure anything"; }; behindNAT = mkOption { type = types.bool; default = false; - example = true; description = "Notify the user that a NAT-kind network is detected"; }; localIPv4Override = mkOption { type = types.bool; default = false; - example = true; description = '' Overrides the IPv4 parameter received from TIC This allows one to configure a NAT into "DMZ" mode and then diff --git a/nixos/modules/services/networking/ferm.nix b/nixos/modules/services/networking/ferm.nix index 8933e166f59f..07338ccf4d9c 100644 --- a/nixos/modules/services/networking/ferm.nix +++ b/nixos/modules/services/networking/ferm.nix @@ -19,7 +19,6 @@ in { services.ferm = { enable = mkOption { default = false; - example = true; type = types.bool; description = '' Whether to enable Ferm Firewall. diff --git a/nixos/modules/services/networking/firefox/sync-server.nix b/nixos/modules/services/networking/firefox/sync-server.nix index 70d2d72ca8b7..5c14ceff6a0d 100644 --- a/nixos/modules/services/networking/firefox/sync-server.nix +++ b/nixos/modules/services/networking/firefox/sync-server.nix @@ -33,7 +33,6 @@ in enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether to enable a Firefox Sync Server, this give the opportunity to Firefox users to store all synchronized data on their own server. To use this @@ -78,7 +77,6 @@ in allowNewUsers = mkOption { type = types.bool; default = true; - example = false; description = '' Whether to allow new-user signups on the server. Only request by existing accounts will be honored. diff --git a/nixos/modules/services/networking/mosquitto.nix b/nixos/modules/services/networking/mosquitto.nix index f926cd710c8d..2325424ff3c5 100644 --- a/nixos/modules/services/networking/mosquitto.nix +++ b/nixos/modules/services/networking/mosquitto.nix @@ -147,7 +147,6 @@ in allowAnonymous = mkOption { default = false; - example = true; type = types.bool; description = '' Allow clients to connect without authentication. diff --git a/nixos/modules/services/networking/quagga.nix b/nixos/modules/services/networking/quagga.nix index ac83da920638..aab58cc77b90 100644 --- a/nixos/modules/services/networking/quagga.nix +++ b/nixos/modules/services/networking/quagga.nix @@ -104,7 +104,6 @@ in enable = mkOption { type = types.bool; default = any isEnabled services; - example = true; description = '' Whether to enable the Zebra routing manager. diff --git a/nixos/modules/services/networking/znc.nix b/nixos/modules/services/networking/znc.nix index 0d41e3ea92ce..6d68b790e869 100644 --- a/nixos/modules/services/networking/znc.nix +++ b/nixos/modules/services/networking/znc.nix @@ -132,7 +132,6 @@ in services.znc = { enable = mkOption { default = false; - example = true; type = types.bool; description = '' Enable a ZNC service for a user. @@ -251,7 +250,6 @@ in useSSL = mkOption { default = true; - example = true; type = types.bool; description = '' Indicates whether the ZNC server should use SSL when listening on the specified port. A self-signed certificate will be generated. @@ -278,7 +276,6 @@ in mutable = mkOption { default = false; - example = true; type = types.bool; description = '' Indicates whether to allow the contents of the `dataDir` directory to be changed diff --git a/nixos/modules/services/scheduling/cron.nix b/nixos/modules/services/scheduling/cron.nix index 6eb277d0a2f2..7b1a1599e141 100644 --- a/nixos/modules/services/scheduling/cron.nix +++ b/nixos/modules/services/scheduling/cron.nix @@ -39,7 +39,7 @@ in enable = mkOption { type = types.bool; - example = true; + default = false; description = "Whether to enable the Vixie cron daemon."; }; diff --git a/nixos/modules/services/security/haka.nix b/nixos/modules/services/security/haka.nix index f48a79b1f7f1..b64a1b4d03e0 100644 --- a/nixos/modules/services/security/haka.nix +++ b/nixos/modules/services/security/haka.nix @@ -99,7 +99,6 @@ in pcap = mkOption { default = true; - example = false; type = types.bool; description = "Whether to enable pcap"; }; diff --git a/nixos/modules/services/torrent/deluge.nix b/nixos/modules/services/torrent/deluge.nix index a9c08b66eb82..2534f09b555a 100644 --- a/nixos/modules/services/torrent/deluge.nix +++ b/nixos/modules/services/torrent/deluge.nix @@ -13,7 +13,6 @@ in { deluge = { enable = mkOption { default = false; - example = true; description = "Start the Deluge daemon"; }; @@ -29,7 +28,6 @@ in { deluge.web = { enable = mkOption { default = false; - example = true; description = '' Start Deluge Web daemon. ''; diff --git a/nixos/modules/services/web-apps/atlassian/crowd.nix b/nixos/modules/services/web-apps/atlassian/crowd.nix index ada26f8057ba..7ff7dc4e5748 100644 --- a/nixos/modules/services/web-apps/atlassian/crowd.nix +++ b/nixos/modules/services/web-apps/atlassian/crowd.nix @@ -88,7 +88,6 @@ in secure = mkOption { type = types.bool; default = true; - example = false; description = "Whether the connections to the proxy should be considered secure."; }; }; diff --git a/nixos/modules/services/web-apps/atlassian/jira.nix b/nixos/modules/services/web-apps/atlassian/jira.nix index 6e31d20d0681..0ab94d95eee8 100644 --- a/nixos/modules/services/web-apps/atlassian/jira.nix +++ b/nixos/modules/services/web-apps/atlassian/jira.nix @@ -78,7 +78,6 @@ in secure = mkOption { type = types.bool; default = true; - example = false; description = "Whether the connections to the proxy should be considered secure."; }; }; diff --git a/nixos/modules/services/web-servers/caddy.nix b/nixos/modules/services/web-servers/caddy.nix index a49838c876f9..eec285f6bc44 100644 --- a/nixos/modules/services/web-servers/caddy.nix +++ b/nixos/modules/services/web-servers/caddy.nix @@ -29,7 +29,6 @@ in agree = mkOption { default = false; - example = true; type = types.bool; description = "Agree to Let's Encrypt Subscriber Agreement"; }; diff --git a/nixos/modules/services/x11/compton.nix b/nixos/modules/services/x11/compton.nix index 7cbca1dcddfd..d1f7f164e641 100644 --- a/nixos/modules/services/x11/compton.nix +++ b/nixos/modules/services/x11/compton.nix @@ -43,7 +43,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Whether of not to enable Compton as the X.org composite manager. ''; @@ -52,7 +51,6 @@ in { fade = mkOption { type = types.bool; default = false; - example = true; description = '' Fade windows in and out. ''; @@ -93,7 +91,6 @@ in { shadow = mkOption { type = types.bool; default = false; - example = true; description = '' Draw window shadows. ''; diff --git a/nixos/modules/services/x11/desktop-managers/enlightenment.nix b/nixos/modules/services/x11/desktop-managers/enlightenment.nix index d908553ccdf8..38e24e9b709a 100644 --- a/nixos/modules/services/x11/desktop-managers/enlightenment.nix +++ b/nixos/modules/services/x11/desktop-managers/enlightenment.nix @@ -20,7 +20,6 @@ in services.xserver.desktopManager.enlightenment.enable = mkOption { default = false; - example = true; description = "Enable the Enlightenment desktop environment."; }; diff --git a/nixos/modules/services/x11/desktop-managers/gnome3.nix b/nixos/modules/services/x11/desktop-managers/gnome3.nix index 21453d1917e8..a1790ccd675c 100644 --- a/nixos/modules/services/x11/desktop-managers/gnome3.nix +++ b/nixos/modules/services/x11/desktop-managers/gnome3.nix @@ -53,7 +53,6 @@ in { services.xserver.desktopManager.gnome3 = { enable = mkOption { default = false; - example = true; description = "Enable Gnome 3 desktop manager."; }; diff --git a/nixos/modules/services/x11/desktop-managers/kodi.nix b/nixos/modules/services/x11/desktop-managers/kodi.nix index de00ff93b17c..3ce49b9d2bf8 100644 --- a/nixos/modules/services/x11/desktop-managers/kodi.nix +++ b/nixos/modules/services/x11/desktop-managers/kodi.nix @@ -11,7 +11,6 @@ in services.xserver.desktopManager.kodi = { enable = mkOption { default = false; - example = true; description = "Enable the kodi multimedia center."; }; }; diff --git a/nixos/modules/services/x11/desktop-managers/xterm.nix b/nixos/modules/services/x11/desktop-managers/xterm.nix index eab914071410..29752ff405e2 100644 --- a/nixos/modules/services/x11/desktop-managers/xterm.nix +++ b/nixos/modules/services/x11/desktop-managers/xterm.nix @@ -13,7 +13,6 @@ in services.xserver.desktopManager.xterm.enable = mkOption { default = true; - example = false; description = "Enable a xterm terminal as a desktop manager."; }; diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index b358550ba41d..d75c785270b3 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -73,7 +73,6 @@ in { clickMethod = mkOption { type = types.nullOr (types.enum [ "none" "buttonareas" "clickfinger" ]); default = null; - example = "none"; description = '' Enables a click method. Permitted values are none, buttonareas, clickfinger. @@ -85,14 +84,12 @@ in { leftHanded = mkOption { type = types.bool; default = false; - example = true; description = "Enables left-handed button orientation, i.e. swapping left and right buttons."; }; middleEmulation = mkOption { type = types.bool; default = true; - example = false; description = '' Enables middle button emulation. When enabled, pressing the left and right buttons @@ -103,7 +100,6 @@ in { naturalScrolling = mkOption { type = types.bool; default = false; - example = true; description = "Enables or disables natural scrolling behavior."; }; @@ -131,7 +127,6 @@ in { horizontalScrolling = mkOption { type = types.bool; default = true; - example = false; description = '' Disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll @@ -153,7 +148,6 @@ in { tapping = mkOption { type = types.bool; default = true; - example = false; description = '' Enables or disables tap-to-click behavior. @@ -163,7 +157,6 @@ in { tappingDragLock = mkOption { type = types.bool; default = true; - example = false; description = '' Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap- @@ -175,7 +168,6 @@ in { disableWhileTyping = mkOption { type = types.bool; default = true; - example = false; description = '' Disable input method while typing. diff --git a/nixos/modules/services/x11/hardware/multitouch.nix b/nixos/modules/services/x11/hardware/multitouch.nix index f8386b5e333b..0e9eb0214947 100644 --- a/nixos/modules/services/x11/hardware/multitouch.nix +++ b/nixos/modules/services/x11/hardware/multitouch.nix @@ -18,20 +18,17 @@ in { enable = mkOption { default = false; - example = true; description = "Whether to enable multitouch touchpad support."; }; invertScroll = mkOption { default = false; - example = true; type = types.bool; description = "Whether to invert scrolling direction à la OSX Lion"; }; ignorePalm = mkOption { default = false; - example = true; type = types.bool; description = "Whether to ignore touches detected as being the palm (i.e when typing)"; }; @@ -39,7 +36,6 @@ in { tapButtons = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable tap buttons."; }; diff --git a/nixos/modules/services/x11/hardware/synaptics.nix b/nixos/modules/services/x11/hardware/synaptics.nix index 2a7f4e5cbcd1..54454c736c1d 100644 --- a/nixos/modules/services/x11/hardware/synaptics.nix +++ b/nixos/modules/services/x11/hardware/synaptics.nix @@ -29,7 +29,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = "Whether to enable touchpad support."; }; @@ -102,7 +101,6 @@ in { tapButtons = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable tap buttons."; }; @@ -125,7 +123,6 @@ in { palmDetect = mkOption { type = types.bool; default = false; - example = true; description = "Whether to enable palm detection (hardware support required)"; }; @@ -146,7 +143,6 @@ in { horizontalScroll = mkOption { type = types.bool; default = true; - example = false; description = "Whether to enable horizontal scrolling (on touchpad)"; }; diff --git a/nixos/modules/services/x11/redshift.nix b/nixos/modules/services/x11/redshift.nix index 78a97df98775..eb5dfdf95849 100644 --- a/nixos/modules/services/x11/redshift.nix +++ b/nixos/modules/services/x11/redshift.nix @@ -12,7 +12,6 @@ in { enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable Redshift to change your screen's colour temperature depending on the time of day. diff --git a/nixos/modules/services/x11/unclutter-xfixes.nix b/nixos/modules/services/x11/unclutter-xfixes.nix index bd02c5ed9895..b94dfb1a26a6 100644 --- a/nixos/modules/services/x11/unclutter-xfixes.nix +++ b/nixos/modules/services/x11/unclutter-xfixes.nix @@ -11,7 +11,6 @@ in { description = "Enable unclutter-xfixes to hide your mouse cursor when inactive."; type = types.bool; default = false; - example = true; }; package = mkOption { diff --git a/nixos/modules/services/x11/unclutter.nix b/nixos/modules/services/x11/unclutter.nix index ebc195d108d0..6c789b7578fa 100644 --- a/nixos/modules/services/x11/unclutter.nix +++ b/nixos/modules/services/x11/unclutter.nix @@ -11,7 +11,6 @@ in { description = "Enable unclutter to hide your mouse cursor when inactive"; type = types.bool; default = false; - example = true; }; package = mkOption { diff --git a/nixos/modules/services/x11/urxvtd.nix b/nixos/modules/services/x11/urxvtd.nix index be36efaa5897..57ad93f20174 100644 --- a/nixos/modules/services/x11/urxvtd.nix +++ b/nixos/modules/services/x11/urxvtd.nix @@ -11,7 +11,6 @@ in { options.services.urxvtd.enable = mkOption { type = types.bool; default = false; - example = true; description = '' Enable urxvtd, the urxvt terminal daemon. To use urxvtd, run "urxvtc". diff --git a/nixos/modules/services/x11/window-managers/exwm.nix b/nixos/modules/services/x11/window-managers/exwm.nix index dbbd8a125d66..dc1d957c1709 100644 --- a/nixos/modules/services/x11/window-managers/exwm.nix +++ b/nixos/modules/services/x11/window-managers/exwm.nix @@ -21,7 +21,6 @@ in enable = mkEnableOption "exwm"; enableDefaultConfig = mkOption { default = true; - example = false; type = lib.types.bool; description = "Enable an uncustomised exwm configuration."; }; diff --git a/nixos/modules/services/x11/window-managers/xmonad.nix b/nixos/modules/services/x11/window-managers/xmonad.nix index 6af88d4f645b..e25a8ae22823 100644 --- a/nixos/modules/services/x11/window-managers/xmonad.nix +++ b/nixos/modules/services/x11/window-managers/xmonad.nix @@ -44,7 +44,6 @@ in enableContribAndExtras = mkOption { default = false; - example = true; type = lib.types.bool; description = "Enable xmonad-{contrib,extras} in Xmonad."; }; |