All options should have types #76184

dasJ · 2019-12-22T19:50:18Z

Describe the bug

To make the usage of options and errors more clear, every option should have a type.
Currently, ~~more than 300 199 151 117 27 20~~ 18 options don't have a type.

To Reproduce
Steps to reproduce the behavior:

let
  config = { };
  pkgs = import ./. {};
  lib = import ./lib;

  scrubDerivations = namePrefix: pkgSet: lib.mapAttrs
    (name: value:
      let wholeName = "${namePrefix}.${name}"; in
      if lib.isAttrs value then
        scrubDerivations wholeName value
        // (lib.optionalAttrs (lib.isDerivation value) { outPath = "\${${wholeName}}"; })
      else value
    )
    pkgSet;

  scrubbedEval = lib.evalModules {
    modules = import ./nixos/modules/module-list.nix;
    specialArgs = {
      pkgs = scrubDerivations "pkgs" pkgs;
    };
  };

  manual = import ./nixos/doc/manual {
    inherit config pkgs;
    inherit (scrubbedEval) options;
    version = "master";
    revision = "master";
  };
in manual.optionsJSON

jsonFile="$(NIX_PATH='' nix-build types.nix)/share/doc/nixos/options.json"
jq -r 'to_entries[] | select(.value.type == "unspecified") | [ "`" + .key + "`", "[" + .value.declarations[0] + "](../blob/master/" + .value.declarations[0] + ")" ] | join(" - ")' < "${jsonFile}" | sed 's/^\(.*\)$/- [ ] \1/g'

Expected behavior

All options should have a type.

Additional context

Options without types:

The text was updated successfully, but these errors were encountered:

dasJ · 2019-12-22T22:53:20Z

cc @ajs124 @infinisil @Scriptkiddi @Ma27 @Lassulus

aanderse · 2019-12-23T12:50:11Z

@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.

dasJ · 2019-12-23T22:52:53Z

@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 ;)

bbjubjub2494 · 2019-12-28T21:26:40Z

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?

dasJ · 2019-12-29T22:45:55Z

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

dasJ · 2019-12-29T22:52:31Z

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

stale · 2020-06-28T16:51:01Z

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.

bbjubjub2494 · 2020-06-30T22:06:21Z

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:

boot.crashDump.reservedMemory
boot.kernelPackages
dysnomia.components
dysnomia.containers
dysnomia.extraContainerPaths
dysnomia.extraContainerProperties
dysnomia.extraModulePaths
dysnomia.properties
hardware.pcmcia.config
networking.timeServers
nix.registry..flake
programs.cdemu.group
programs.cdemu.gui
programs.cdemu.image-analyzer
security.pam.loginLimits
security.pam.services.<name?>.limits
services.activemq.configurationDir
services.amule.dataDir
services.amule.user
services.autofs.timeout
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.forwarders
services.bind.ipv4Only
services.bind.zones
services.bitlbee.extraDefaults
services.bitlbee.extraSettings
services.bitlbee.interface
services.bitlbee.portNumber
services.buildbot-master.pythonPackages
services.cgminer.config
services.cgminer.hardware
services.cgminer.pools
services.cgminer.user
services.chrony.initstepslew
services.chrony.servers
services.cntlm.domain
services.cntlm.noproxy
services.cntlm.port
services.cntlm.proxy
services.cntlm.username
services.compton
services.consul.extraConfig
services.deluge.openFilesLimit
services.elasticsearch-curator.actionYAML
services.felix.group
services.felix.user
services.firebird.baseDir
services.firebird.port
services.firebird.user
services.flashpolicyd.policy
services.fprot.updater.frequency
services.fprot.updater.licenseKeyfile
services.fprot.updater.productData
services.gale.setuidWrapper
services.gocd-agent.extraOptions
services.gocd-agent.startupOptions
services.gocd-server.extraGroups
services.gocd-server.extraOptions
services.gocd-server.startupOptions
services.gogoclient.server
services.gogoclient.username
services.gvpe.configFile
services.gvpe.configText
services.gvpe.customIFSetup
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.interface
services.ihaskell.extraPackages
services.ircdHybrid.adminEmail
services.ircdHybrid.certificate
services.ircdHybrid.description
services.ircdHybrid.extraIPs
services.ircdHybrid.extraPort
services.ircdHybrid.rsaKey
services.ircdHybrid.serverName
services.ircdHybrid.sid
services.jboss.deployDir
services.jboss.libUrl
services.jboss.logDir
services.jboss.serverDir
services.jboss.tempDir
services.jboss.user
services.k3s.extraFlags
services.lshd.hostKey
services.lshd.interfaces
services.lshd.loginShell
services.lshd.portNumber
services.lshd.srpKeyExchange
services.lshd.subsystems
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.extraOptions
services.memcached.listen
services.memcached.maxConnections
services.memcached.maxMemory
services.memcached.port
services.memcached.user
services.mongodb.bind_ip
services.mongodb.dbpath
services.mongodb.extraConfig
services.mongodb.pidFile
services.mongodb.quiet
services.mongodb.replSetName
services.mongodb.user
services.mysqlBackup.databases
services.mysqlBackup.location
services.mysqlBackup.singleTransaction
services.mysqlBackup.user
services.netatalk.homes.basedirRegex
services.netatalk.homes.path
services.netatalk.port
services.netdata.python.extraPackages
services.nginx.config
services.nginx.logError
services.nsd.zones..children
services.ntp.servers
services.oauth2_proxy.extraConfig
services.octoprint.plugins
services.openafsServer.advertisedAddresses
services.postfix.dnsBlacklistOverrides
services.postfix.transport
services.postgresqlBackup.databases
services.postgresqlBackup.location
services.postgresqlBackup.startAt
services.prayer.port
services.quassel.dataDir
services.quassel.interfaces
services.quassel.portNumber
services.quassel.user
services.radvd.config
services.redis.masterAuth
services.redis.slaveOf
services.resilio.sharedFolders
services.rippled.extraConfig
services.rsyncd.address
services.sabnzbd.configFile
services.sabnzbd.group
services.sabnzbd.user
services.shairport-sync.arguments
services.shairport-sync.user
services.supybot.extraPackages
services.svnserve.svnBaseDir
services.synergy.client.screenName
services.synergy.client.serverAddress
services.synergy.server.address
services.synergy.server.configFile
services.synergy.server.screenName
services.timesyncd.servers
services.tomcat.extraGroups
services.unit.logDir
services.unit.stateDir
services.venus.feeds
services.virtuoso.config
services.virtuoso.dirsAllowed
services.virtuoso.httpListenAddress
services.virtuoso.listenAddress
services.virtuoso.parameters
services.vsftpd.userlist
services.wakeonlan.interfaces
services.weechat.binary
services.xserver.desktopManager.gnome3.sessionPath
services.xserver.desktopManager.pantheon.sessionPath
services.xserver.displayManager.lightdm.greeters.gtk.cursorTheme.package
services.xserver.displayManager.session
services.xserver.serverFlagsSection
services.xserver.useXFS
services.xserver.windowManager.exwm.extraPackages
services.xserver.windowManager.xmonad.extraPackages
services.xserver.windowManager.xmonad.haskellPackages
services.xtreemfs.dir.address
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.httpPort
services.xtreemfs.mrc.port
services.xtreemfs.mrc.syncMode
services.xtreemfs.mrc.uuid
services.xtreemfs.osd.address
services.xtreemfs.osd.httpPort
services.xtreemfs.osd.port
services.xtreemfs.osd.uuid
services.yandex-disk.directory
services.yandex-disk.user
specialisation..configuration
users.ldap.base
users.ldap.server
virtualisation.xen.bootParams
virtualisation.xen.bridge.name
virtualisation.xen.domain0MemorySize

That's good progress but it's not all done.

bbjubjub2494 · 2020-07-25T17:53:19Z

Related: #91813

xaverdh · 2020-11-23T13:43:12Z

was this closed intentionally or by accident?

dasJ · 2021-01-19T09:39:56Z

Thanks to some newfound motivation for this issue (and procrastination from my regular work 👀) I chose to redo my generation code (goes from master instead of the release branch now) and reopen this. Good news is that a lot of the items are already fixed so I'm going to just replace the list above.

Update: List now includes clickable links

stale · 2021-08-05T15:11:58Z

I marked this as stale due to inactivity. → More info

infinisil · 2021-08-05T17:16:07Z

Still relevant, and my #132448 should help with this

Scriptkiddi · 2021-10-15T07:05:06Z

@dasJ could you regenerate the list? some things are out of date

dasJ · 2021-10-15T08:28:27Z

Done

See NixOS#76184

This is a follow-up to NixOS#76184 Co-Authored-By: Silvan Mosberger <[email protected]>

Makes all options rendered in the manual throw an error if they don't have a type specified. This is a follow-up to NixOS#76184 Co-Authored-By: Silvan Mosberger <[email protected]>

dasJ added the 0.kind: bug Something is broken label Dec 22, 2019

veprbl added the 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS label Dec 22, 2019

symphorien mentioned this issue Dec 26, 2019

nagios: various improvements #76551

Merged

10 tasks

This was referenced Dec 29, 2019

nixos/*: Add types to the database module options #76667

Closed

nixos/lib: Inherit type for doRename options #76670

Closed

aanderse mentioned this issue Dec 30, 2019

nixos/sysstat: provide a type for each module option #76706

Merged

10 tasks

This was referenced Jan 4, 2020

nixos/gnunet: Add types to the options #76938

Merged

nixos/tsocks: Add types to the options #76939

Merged

nixos/activation: add types to options #77090

Closed

ajs124 mentioned this issue Apr 22, 2020

treewide: add bool type to enable options, or make use of mkEnableOption #85628

Merged

xaverdh mentioned this issue Apr 27, 2020

treewide: add types to boolean / enable options #86104

Merged

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 28, 2020

xaverdh mentioned this issue Jul 15, 2020

nixos/xserver: clean up the useXFS option #86111

Merged

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jul 25, 2020

Stunkymonkey mentioned this issue Nov 18, 2020

octoprint: add plugin option-type #104111

Closed

10 tasks

dasJ closed this as completed Nov 21, 2020

aanderse mentioned this issue Jan 15, 2021

redis: make masterAuth option optional #109417

Merged

10 tasks

dasJ reopened this Jan 19, 2021

Scriptkiddi mentioned this issue Jan 20, 2021

networking, chrony, ntpd, timesyncd: add timeServers option type #110122

Merged

10 tasks

dasJ mentioned this issue Jun 16, 2021

lib/options: Warn about options without type #127066

Closed

11 tasks

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 5, 2021

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 5, 2021

Scriptkiddi mentioned this issue Oct 15, 2021

nixos/unbound: add stateDir type #141730

Closed

12 tasks

dasJ mentioned this issue Oct 15, 2021

nixos/specialisation: Add type for configuration #141733

Closed

dasJ added a commit to helsinki-systems/nixpkgs that referenced this issue Oct 15, 2021

nixos/specialisation: Add type for configuration

4994a54

See NixOS#76184

Scriptkiddi mentioned this issue Oct 15, 2021

nixos/x11/display-managers: add session type #141760

Closed

12 tasks

infinisil added a commit to infinisil/nixpkgs that referenced this issue Nov 30, 2021

lib/options: Warn about options without type

9c498a1

This is a follow-up to NixOS#76184 Co-Authored-By: Silvan Mosberger <[email protected]>

This was referenced Dec 7, 2021

nixos/pam: Type all limit options #149412

Merged

nixos/displayManagers: type the last option #149413

Closed

nixos: Type some more options #149415

Merged

nixos/dysnomia: Type all options #149416

Merged

dasJ added a commit to helsinki-systems/nixpkgs that referenced this issue Dec 10, 2021

lib/options: Warn about options without type

feadddc

This is a follow-up to NixOS#76184 Co-Authored-By: Silvan Mosberger <[email protected]>

infinisil mentioned this issue Feb 28, 2022

Throw an error for options without a type #162271

Merged

13 tasks

roberth closed this as completed in #162271 Mar 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

All options should have types #76184

All options should have types #76184

dasJ commented Dec 22, 2019 •

edited

Loading

dasJ commented Dec 22, 2019 •

edited

Loading

aanderse commented Dec 23, 2019

dasJ commented Dec 23, 2019

bbjubjub2494 commented Dec 28, 2019

dasJ commented Dec 29, 2019

dasJ commented Dec 29, 2019

stale bot commented Jun 28, 2020

bbjubjub2494 commented Jun 30, 2020

bbjubjub2494 commented Jul 25, 2020

xaverdh commented Nov 23, 2020

dasJ commented Jan 19, 2021 •

edited

Loading

stale bot commented Aug 5, 2021

infinisil commented Aug 5, 2021

Scriptkiddi commented Oct 15, 2021

dasJ commented Oct 15, 2021

All options should have types #76184

All options should have types #76184

Comments

dasJ commented Dec 22, 2019 • edited Loading

dasJ commented Dec 22, 2019 • edited Loading

aanderse commented Dec 23, 2019

dasJ commented Dec 23, 2019

bbjubjub2494 commented Dec 28, 2019

dasJ commented Dec 29, 2019

dasJ commented Dec 29, 2019

stale bot commented Jun 28, 2020

bbjubjub2494 commented Jun 30, 2020

bbjubjub2494 commented Jul 25, 2020

xaverdh commented Nov 23, 2020

dasJ commented Jan 19, 2021 • edited Loading

stale bot commented Aug 5, 2021

infinisil commented Aug 5, 2021

Scriptkiddi commented Oct 15, 2021

dasJ commented Oct 15, 2021

dasJ commented Dec 22, 2019 •

edited

Loading

dasJ commented Dec 22, 2019 •

edited

Loading

dasJ commented Jan 19, 2021 •

edited

Loading