Nixpkgs: All options should have types

Created on 22 Dec 2019 · 9Comments · Source: NixOS/nixpkgs

Describe the bug

To make the usage of options and errors more clear, every option should have a type.
Currently, more than 300 options don't have a type.

To Reproduce
Steps to reproduce the behavior:

curl https://nixos.org/nixos/options.json.gz | zcat | jq -r 'to_entries[] | select(.value.type == "unspecified") | .key | "- [ ] " + .' | xclip -selection clipboard

Expected behavior

All options should have a type.

Additional context

Options without types:

[ ] boot.crashDump.reservedMemory
[ ] boot.kernelPackages
[ ] dysnomia.components
[ ] dysnomia.containers
[ ] dysnomia.extraContainerPaths
[ ] dysnomia.extraContainerProperties
[ ] dysnomia.extraModulePaths
[ ] dysnomia.properties
[ ] environment.checkConfigurationOptions
[ ] fonts.enableFontDir
[ ] fonts.enableGhostscriptFonts
[ ] hardware.pcmcia.config
[ ] nesting.children
[ ] nesting.clone
[ ] networking.tcpcrypt.enable
[ ] networking.timeServers
[ ] networking.wicd.enable
[ ] programs.cdemu.enable
[ ] programs.cdemu.group
[ ] programs.cdemu.gui
[ ] programs.cdemu.image-analyzer
[ ] programs.criu.enable
[ ] programs.systemtap.enable
[ ] programs.zsh.ohMyZsh.enable
[ ] security.apparmor.confineSUIDApplications
[ ] security.pam.enableEcryptfs
[ ] security.pam.enableOTPW
[ ] security.pam.enableSSHAgentAuth
[ ] security.pam.loginLimits
[ ] security.pam.services..limits
[ ] services.activemq.configurationDir
[ ] services.amule.dataDir
[ ] services.amule.enable
[ ] services.amule.user
[ ] services.autofs.debug
[ ] services.autofs.enable
[ ] services.autofs.timeout
[ ] services.babeld.enable
[ ] services.babeld.extraConfig
[ ] services.bacula-dir.extraDirectorConfig
[ ] services.bacula-dir.extraMessagesConfig
[ ] services.bacula-dir.name
[ ] services.bacula-dir.password
[ ] services.bacula-fd.director..monitor
[ ] services.bacula-fd.director..password
[ ] services.bacula-fd.extraClientConfig
[ ] services.bacula-fd.extraMessagesConfig
[ ] services.bacula-fd.name
[ ] services.bacula-sd.autochanger..changerCommand
[ ] services.bacula-sd.autochanger..changerDevice
[ ] services.bacula-sd.autochanger..devices
[ ] services.bacula-sd.autochanger..extraAutochangerConfig
[ ] services.bacula-sd.device..archiveDevice
[ ] services.bacula-sd.device..extraDeviceConfig
[ ] services.bacula-sd.device..mediaType
[ ] services.bacula-sd.director..monitor
[ ] services.bacula-sd.director..password
[ ] services.bacula-sd.extraMessagesConfig
[ ] services.bacula-sd.extraStorageConfig
[ ] services.bacula-sd.name
[ ] services.bind.blockedNetworks
[ ] services.bind.cacheNetworks
[ ] services.bind.enable
[ ] services.bind.forwarders
[ ] services.bind.ipv4Only
[ ] services.bind.zones
[ ] services.bitlbee.enable
[ ] services.bitlbee.extraDefaults
[ ] services.bitlbee.extraSettings
[ ] services.bitlbee.interface
[ ] services.bitlbee.portNumber
[ ] services.buildbot-master.pythonPackages
[ ] services.cgminer.config
[ ] services.cgminer.enable
[ ] services.cgminer.hardware
[ ] services.cgminer.pools
[ ] services.cgminer.user
[ ] services.chrony.enable
[ ] services.chrony.initstepslew
[ ] services.chrony.servers
[ ] services.clickhouse.enable #76667
[ ] services.cntlm.domain
[ ] services.cntlm.enable
[ ] services.cntlm.noproxy
[ ] services.cntlm.port
[ ] services.cntlm.proxy
[ ] services.cntlm.username
[ ] services.consul.extraConfig
[ ] services.deluge.openFilesLimit
[ ] services.devmon.enable
[ ] services.disnix.enable
[ ] services.disnix.useWebServiceInterface
[ ] services.elasticsearch-curator.actionYAML
[ ] services.felix.enable
[ ] services.felix.group
[ ] services.felix.user
[ ] services.firebird.baseDir #76667
[ ] services.firebird.enable #76667
[ ] services.firebird.port #76667
[ ] services.firebird.user #76667
[ ] services.flashpolicyd.enable
[ ] services.flashpolicyd.policy
[ ] services.foldingAtHome.config
[ ] services.foldingAtHome.enable
[ ] services.foldingAtHome.nickname
[ ] services.fourStore.database
[ ] services.fourStore.enable
[ ] services.fourStore.options
[ ] services.fourStoreEndpoint.database
[ ] services.fourStoreEndpoint.enable
[ ] services.fourStoreEndpoint.listenAddress
[ ] services.fourStoreEndpoint.options
[ ] services.fourStoreEndpoint.port
[ ] services.fprot.updater.enable
[ ] services.fprot.updater.frequency
[ ] services.fprot.updater.licenseKeyfile
[ ] services.fprot.updater.productData
[ ] services.gale.setuidWrapper
[ ] services.gnunet.enable
[ ] services.gnunet.extraOptions
[ ] services.gnunet.fileSharing.quota
[ ] services.gnunet.load.hardNetUpBandwidth
[ ] services.gnunet.load.maxNetDownBandwidth
[ ] services.gnunet.load.maxNetUpBandwidth
[ ] services.gnunet.tcp.port
[ ] services.gnunet.udp.port
[ ] services.gocd-agent.extraOptions
[ ] services.gocd-agent.startupOptions
[ ] services.gocd-server.extraGroups
[ ] services.gocd-server.extraOptions
[ ] services.gocd-server.startupOptions
[ ] services.gogoclient.autorun
[ ] services.gogoclient.server
[ ] services.gogoclient.username
[ ] services.gvpe.configFile
[ ] services.gvpe.configText
[ ] services.gvpe.customIFSetup
[ ] services.gvpe.enable
[ ] services.gvpe.ipAddress
[ ] services.gvpe.nodename
[ ] services.gvpe.subnet
[ ] services.hadoop.coreSite
[ ] services.hadoop.hdfsSite
[ ] services.hadoop.mapredSite
[ ] services.hadoop.yarnSite
[ ] services.heyefi.cardMacaddress
[ ] services.heyefi.uploadDir
[ ] services.heyefi.uploadKey
[ ] services.heyefi.user
[ ] services.hoogle.haskellPackages
[ ] services.hoogle.packages
[ ] services.hostapd.enable
[ ] services.hostapd.interface
[ ] services.hostapd.noScan
[ ] services.hostapd.wpa
[ ] services.ihaskell.enable
[ ] services.ihaskell.extraPackages
[ ] services.ircdHybrid.adminEmail
[ ] services.ircdHybrid.certificate
[ ] services.ircdHybrid.description
[ ] services.ircdHybrid.enable
[ ] services.ircdHybrid.extraIPs
[ ] services.ircdHybrid.extraPort
[ ] services.ircdHybrid.rsaKey
[ ] services.ircdHybrid.serverName
[ ] services.ircdHybrid.sid
[ ] services.jboss.deployDir
[ ] services.jboss.enable
[ ] services.jboss.libUrl
[ ] services.jboss.logDir
[ ] services.jboss.serverDir
[ ] services.jboss.tempDir
[ ] services.jboss.useJK
[ ] services.jboss.user
[ ] services.kerberos_server.enable
[ ] services.localtime.enable
[ ] services.lshd.enable
[ ] services.lshd.hostKey
[ ] services.lshd.interfaces
[ ] services.lshd.loginShell
[ ] services.lshd.passwordAuthentication
[ ] services.lshd.portNumber
[ ] services.lshd.publicKeyAuthentication
[ ] services.lshd.rootLogin
[ ] services.lshd.srpKeyExchange
[ ] services.lshd.subsystems
[ ] services.lshd.syslog
[ ] services.lshd.tcpForwarding
[ ] services.lshd.x11Forwarding
[ ] services.mailpile.enable
[ ] services.mailpile.hostname
[ ] services.mailpile.port
[ ] services.mediatomb.group
[ ] services.mediatomb.interface
[ ] services.mediatomb.port
[ ] services.mediatomb.user
[ ] services.mediatomb.uuid
[ ] services.mediawiki.name
[ ] services.memcached.enable #76667
[ ] services.memcached.extraOptions #76667
[ ] services.memcached.listen #76667
[ ] services.memcached.maxConnections #76667
[ ] services.memcached.maxMemory #76667
[ ] services.memcached.port #76667
[ ] services.memcached.user #76667
[ ] services.mongodb.bind_ip #76667
[ ] services.mongodb.dbpath #76667
[ ] services.mongodb.enable #76667
[ ] services.mongodb.extraConfig #76667
[ ] services.mongodb.pidFile #76667
[ ] services.mongodb.quiet #76667
[ ] services.mongodb.replSetName #76667
[ ] services.mongodb.user #76667
[ ] services.mysqlBackup.databases
[ ] services.mysqlBackup.enable
[ ] services.mysqlBackup.location
[ ] services.mysqlBackup.singleTransaction
[ ] services.mysqlBackup.user
[x] services.nagios.enable #76551
[x] services.nagios.enableWebInterface #76551
[x] services.nagios.objectDefs #76551
[x] services.nagios.urlPath Dropped on master since #73113
[ ] services.netatalk.enable
[ ] services.netatalk.homes.basedirRegex
[ ] services.netatalk.homes.enable
[ ] services.netatalk.homes.path
[ ] services.netatalk.port
[ ] services.netdata.python.extraPackages
[ ] services.nginx.config
[ ] services.nginx.logError
[ ] services.nginx.stateDir
[ ] services.nsd.zones..children
[ ] services.ntp.enable
[ ] services.ntp.servers
[ ] services.oauth2_proxy.extraConfig
[ ] services.octoprint.plugins
[ ] services.openafsServer.advertisedAddresses
[ ] services.openfire.enable
[ ] services.openfire.usePostgreSQL
[ ] services.openssh.knownHosts
[ ] services.postfix.dnsBlacklistOverrides
[ ] services.postfix.enableSmtp
[ ] services.postfix.transport
[ ] services.postgresqlBackup.databases
[ ] services.postgresqlBackup.enable
[ ] services.postgresqlBackup.location
[ ] services.postgresqlBackup.startAt
[ ] services.prayer.enable
[ ] services.prayer.port
[ ] services.quassel.dataDir
[ ] services.quassel.enable
[ ] services.quassel.interfaces
[ ] services.quassel.portNumber
[ ] services.quassel.user
[ ] services.rabbitmq.enable
[ ] services.radvd.config
[ ] services.radvd.enable
[ ] services.ratbagd.enable
[ ] services.rdnssd.enable
[ ] services.redis.masterAuth #76667
[ ] services.redis.slaveOf #76667
[ ] services.resilio.sharedFolders
[ ] services.rippled.extraConfig
[ ] services.rsyncd.address
[ ] services.rsyncd.enable
[ ] services.sabnzbd.configFile
[ ] services.sabnzbd.enable
[ ] services.sabnzbd.group
[ ] services.sabnzbd.user
[ ] services.safeeyes.enable
[ ] services.shairport-sync.arguments
[ ] services.shairport-sync.enable
[ ] services.shairport-sync.user
[ ] services.spamassassin.debug
[ ] services.spamassassin.enable
[ ] services.sshd.enable
[ ] services.supybot.enable
[ ] services.supybot.stateDir
[ ] services.svnserve.enable
[ ] services.svnserve.svnBaseDir
[ ] services.synergy.client.enable
[ ] services.synergy.client.screenName
[ ] services.synergy.client.serverAddress
[ ] services.synergy.server.address
[ ] services.synergy.server.configFile
[ ] services.synergy.server.enable
[ ] services.synergy.server.screenName
[x] services.sysstat.collect-args
[x] services.sysstat.collect-frequency
[ ] services.thermald.enable
[ ] services.timesyncd.servers
[ ] services.tomcat.extraGroups
[ ] services.tor.tsocks.config
[ ] services.tor.tsocks.enable
[ ] services.tor.tsocks.server
[ ] services.unit.logDir
[ ] services.unit.stateDir
[ ] services.uptimed.enable
[ ] services.venus.feeds
[ ] services.virtuoso.config #76667
[ ] services.virtuoso.dirsAllowed #76667
[ ] services.virtuoso.enable #76667
[ ] services.virtuoso.httpListenAddress #76667
[ ] services.virtuoso.listenAddress #76667
[ ] services.virtuoso.parameters #76667
[ ] services.vsftpd.enable
[ ] services.vsftpd.userlist
[ ] services.wakeonlan.interfaces
[ ] services.weechat.binary
[ ] services.xinetd.enable
[ ] services.xserver.desktopManager.enlightenment.enable
[ ] services.xserver.desktopManager.gnome3.enable
[ ] services.xserver.desktopManager.gnome3.sessionPath
[ ] services.xserver.desktopManager.kodi.enable
[ ] services.xserver.desktopManager.pantheon.sessionPath
[ ] services.xserver.displayManager.auto.enable
[ ] services.xserver.displayManager.auto.user
[ ] services.xserver.displayManager.lightdm.greeters.gtk.cursorTheme.package
[ ] services.xserver.displayManager.session
[ ] services.xserver.displayManager.startx.enable
[ ] services.xserver.multitouch.enable
[ ] services.xserver.serverFlagsSection
[ ] services.xserver.useXFS
[ ] services.xserver.wacom.enable
[ ] services.xserver.windowManager.exwm.extraPackages
[ ] services.xserver.windowManager.xmonad.extraPackages
[ ] services.xserver.windowManager.xmonad.haskellPackages
[ ] services.xtreemfs.dir.address
[ ] services.xtreemfs.dir.enable
[ ] services.xtreemfs.dir.httpPort
[ ] services.xtreemfs.dir.port
[ ] services.xtreemfs.dir.syncMode
[ ] services.xtreemfs.dir.uuid
[ ] services.xtreemfs.homeDir
[ ] services.xtreemfs.mrc.address
[ ] services.xtreemfs.mrc.enable
[ ] services.xtreemfs.mrc.httpPort
[ ] services.xtreemfs.mrc.port
[ ] services.xtreemfs.mrc.syncMode
[ ] services.xtreemfs.mrc.uuid
[ ] services.xtreemfs.osd.address
[ ] services.xtreemfs.osd.enable
[ ] services.xtreemfs.osd.httpPort
[ ] services.xtreemfs.osd.port
[ ] services.xtreemfs.osd.uuid
[ ] services.yandex-disk.directory
[ ] services.yandex-disk.enable
[ ] services.yandex-disk.user
[ ] systemd.services..path #75510
[ ] systemd.user.services..path
[ ] users.extraGroups
[ ] users.extraUsers
[ ] users.ldap.base
[ ] users.ldap.daemon.enable
[ ] users.ldap.server
[ ] users.ldap.useTLS
[ ] virtualisation.xen.bootParams
[ ] virtualisation.xen.bridge.forwardDns
[ ] virtualisation.xen.bridge.name
[ ] virtualisation.xen.domain0MemorySize
[ ] virtualisation.xen.trace

bug nixos

Source

dasJ

👍2

All 9 comments

cc @ajs124 @Infinisil @Scriptkiddi @Ma27 @Lassulus

dasJ on 22 Dec 2019

👀2

@dasJ great! Any plan of attack, or just track it here and people can chip away at it?

BTW - I noticed services.wordpress.commonOptions but no such option exists that I'm aware of.

aanderse on 23 Dec 2019

@aanderse I'd love to attack this somehow, but as I honestly don't have any idea what most modules do, I'm too afraid to break anything. I'd love people to chip away at it, and I'll try to do as much as I can.

As for the Wordpress options: I accidentially added our company modules into the list. I'm currently regenerating it ;)

dasJ on 23 Dec 2019

👍1

I looked at some of those options to try and type them. I ran into an interesting situation with services.tor.tsocks.config: the implementation of the module sets this option by itself, which means that if the user uses it, NixOS does the default thing which appears to be to concatenate everything together without separators, in the style of types.string. (as opposed to types.str which cant be merged) I concluded that, if we want to put a type on such an option while preserving its behavior by oral contract, the deprecated types.string is what should be used. Of course every option should be looked at case-by-case. (Also I think the tsocks module should be nuked at some point.)

I'm working on my branch here. Do we want to centralize at least the trivial cases somewhere instead of opening loads of small PRs?

lourkeur on 28 Dec 2019

@aanderse I finally regenerated the list and updated the command to make it usable for everyone

dasJ on 29 Dec 2019

👍1

@lourkeur Yeah, I think that some larger PRs (like #76551 which fixes all nagios options at once) would be a lot easier to merge.

dasJ on 29 Dec 2019

Thank you for your contributions.

This has been automatically marked as stale because it has had no activity for 180 days.

If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.

Here are suggestions that might help resolve this more quickly:

Search for maintainers and people that previously touched the related code and @ mention them in a comment.
Ask on the NixOS Discourse.
Ask on the #nixos channel on irc.freenode.net.

stale[bot] on 28 Jun 2020

Updated command: curl -L https://hydra.nixos.org/job/nixos/trunk-combined/nixos.options/latest/download/1/options.json | jq -r 'to_entries[] | select(.value.type == "unspecified") | .key | "- [ ] " + .'
result: