Skip to content

Commit

Permalink
nixos/treewide: remove boolean examples for options
Browse files Browse the repository at this point in the history 
They contain no useful information and increase the length of the
autogenerated options documentation.

See discussion in #18816.
  • Loading branch information
@fpletz
fpletz committed Mar 17, 2017
1 parent a8785da commit 9536169
Show file tree
Hide file tree
Showing 47 changed files with 1 addition and 86 deletions.
1 change: 0 additions & 1 deletion nixos/modules/installer/cd-dvd/iso-image.nix
View file
Expand Up @@ -172,7 +172,6 @@ in

isoImage.includeSystemBuildDependencies = mkOption {
default = false;
example = true;
description = ''
Set this option to include all the needed sources etc in the
image. It significantly increases image size. Use that when
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/programs/adb.nix
View file
Expand Up @@ -10,7 +10,6 @@ with lib;
programs.adb = {
enable = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Whether to configure system to use Android Debug Bridge (adb).
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/programs/gphoto2.nix
View file
Expand Up @@ -10,7 +10,6 @@ with lib;
programs.gphoto2 = {
enable = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Whether to configure system to use gphoto2.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/programs/mosh.nix
View file
Expand Up @@ -14,7 +14,6 @@ in
Whether to enable mosh. Note, this will open ports in your firewall!
'';
default = false;
example = true;
type = lib.types.bool;
};
};
Expand Down
3 changes: 0 additions & 3 deletions nixos/modules/programs/ssmtp.nix
View file
Expand Up @@ -22,7 +22,6 @@ in
directDelivery = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Use the trivial Mail Transfer Agent (MTA)
<command>ssmtp</command> package to allow programs to send
Expand Down Expand Up @@ -65,7 +64,6 @@ in
useTLS = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Whether TLS should be used to connect to the default mail
server.
Expand All @@ -75,7 +73,6 @@ in
useSTARTTLS = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Whether the STARTTLS should be used to connect to the default
mail server. (This is needed for TLS-capable mail servers
Expand Down
5 changes: 0 additions & 5 deletions nixos/modules/programs/tmux.nix
View file
Expand Up @@ -65,7 +65,6 @@ in {

aggressiveResize = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Resize the window to the size of the smallest session for which it is the current window.
Expand All @@ -81,14 +80,12 @@ in {

clock24 = mkOption {
default = false;
example = true;
type = types.bool;
description = "Use 24 hour clock.";
};

customPaneNavigationAndResize = mkOption {
default = false;
example = true;
type = types.bool;
description = "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode.";
};
Expand Down Expand Up @@ -124,14 +121,12 @@ in {

newSession = mkOption {
default = false;
example = true;
type = types.bool;
description = "Automatically spawn a session if trying to attach and none are running.";
};

reverseSplit = mkOption {
default = false;
example = true;
type = types.bool;
description = "Reverse the window split shortcuts.";
};
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/programs/vim.nix
View file
Expand Up @@ -9,7 +9,6 @@ in {
defaultEditor = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
When enabled, installs vim and configures vim to be the default editor
using the EDITOR environment variable.
Expand Down
3 changes: 0 additions & 3 deletions nixos/modules/security/grsecurity.nix
View file
Expand Up @@ -21,7 +21,6 @@ in

enable = mkOption {
type = types.bool;
example = true;
default = false;
description = ''
Enable grsecurity/PaX.
Expand All @@ -30,7 +29,6 @@ in

lockTunables = mkOption {
type = types.bool;
example = false;
default = true;
description = ''
Whether to automatically lock grsecurity tunables
Expand All @@ -43,7 +41,6 @@ in

disableEfiRuntimeServices = mkOption {
type = types.bool;
example = false;
default = true;
description = ''
Whether to disable access to EFI runtime services. Enabling EFI runtime
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/backup/rsnapshot.nix
View file
Expand Up @@ -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;
};

Expand Down
2 changes: 0 additions & 2 deletions nixos/modules/services/computing/boinc/client.nix
View file
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/databases/cassandra.nix
View file
Expand Up @@ -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 {
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/databases/openldap.nix
View file
Expand Up @@ -25,7 +25,6 @@ in
description = "
Whether to enable the ldap server.
";
example = true;
};

user = mkOption {
Expand Down
3 changes: 0 additions & 3 deletions nixos/modules/services/editors/emacs.nix
View file
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/mail/offlineimap.nix
View file
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/misc/ihaskell.nix
View file
Expand Up @@ -16,7 +16,6 @@ in
services.ihaskell = {
enable = mkOption {
default = false;
example = true;
description = "Autostart an IHaskell notebook service.";
};

Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/misc/taskserver/default.nix
View file
Expand Up @@ -148,7 +148,6 @@ in {
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Whether to enable the Taskwarrior server.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/monitoring/arbtt.nix
View file
Expand Up @@ -10,7 +10,6 @@ in {
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Enable the arbtt statistics capture service.
'';
Expand Down
9 changes: 0 additions & 9 deletions nixos/modules/services/networking/aiccu.nix
View file
Expand Up @@ -35,7 +35,6 @@ in {
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = "Enable aiccu IPv6 over IPv4 SiXXs tunnel";
};

Expand Down Expand Up @@ -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.
Expand All @@ -124,7 +120,6 @@ in {
defaultRoute = mkOption {
type = types.bool;
default = true;
example = false;
description = "Add a default route";
};

Expand All @@ -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
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/networking/ferm.nix
View file
Expand Up @@ -19,7 +19,6 @@ in {
services.ferm = {
enable = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Whether to enable Ferm Firewall.
Expand Down
2 changes: 0 additions & 2 deletions nixos/modules/services/networking/firefox/sync-server.nix
View file
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/networking/mosquitto.nix
View file
Expand Up @@ -147,7 +147,6 @@ in

allowAnonymous = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Allow clients to connect without authentication.
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/networking/quagga.nix
View file
Expand Up @@ -104,7 +104,6 @@ in
enable = mkOption {
type = types.bool;
default = any isEnabled services;
example = true;
description = ''
Whether to enable the Zebra routing manager.
Expand Down
3 changes: 0 additions & 3 deletions nixos/modules/services/networking/znc.nix
View file
Expand Up @@ -132,7 +132,6 @@ in
services.znc = {
enable = mkOption {
default = false;
example = true;
type = types.bool;
description = ''
Enable a ZNC service for a user.
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion nixos/modules/services/scheduling/cron.nix
View file
Expand Up @@ -39,7 +39,7 @@ in

enable = mkOption {
type = types.bool;
example = true;
default = false;
description = "Whether to enable the Vixie cron daemon.";
};

Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/security/haka.nix
View file
Expand Up @@ -99,7 +99,6 @@ in

pcap = mkOption {
default = true;
example = false;
type = types.bool;
description = "Whether to enable pcap";
};
Expand Down
2 changes: 0 additions & 2 deletions nixos/modules/services/torrent/deluge.nix
View file
Expand Up @@ -13,7 +13,6 @@ in {
deluge = {
enable = mkOption {
default = false;
example = true;
description = "Start the Deluge daemon";
};

Expand All @@ -29,7 +28,6 @@ in {
deluge.web = {
enable = mkOption {
default = false;
example = true;
description = ''
Start Deluge Web daemon.
'';
Expand Down
1 change: 0 additions & 1 deletion nixos/modules/services/web-apps/atlassian/crowd.nix
View file
Expand Up @@ -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.";
};
};
Expand Down

0 comments on commit 9536169

Please sign in to comment.