Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/virtualbox-image: format bool params to on/off #80807

Closed
wants to merge 2 commits into from
Closed

nixos/virtualbox-image: format bool params to on/off #80807

wants to merge 2 commits into from

Conversation

lukateras
Copy link
Member

@lukateras lukateras commented Feb 22, 2020

Motivation for this change

Context: #80736 (comment).

In addition to the title, this PR exposes default implementations of lib.cli.toGNUCommandLine options, which is intended to help define external mkBool/mkList mplementations that leverage the same mkOption and mkOptionName implementations.

cc @mmahut @Gabriel439 @Profpatsch

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@lukateras
Copy link
Member Author

@GrahamcOfBorg test virtualbox

@Gabriella439
Copy link
Contributor

@yegortimoshenko: Would it be possible to preserve the original inline definitions of the default arguments to toGNUCommandLine? In other words, you could still export copies of these utilities from the lib/cli.nix file, but leave the default arguments undisturbed.

The rationale is that the default arguments are set up so that overriding the behavior of one default arguments will be reflected in the behavior of other default arguments.

For example, suppose that a user wanted to remove the behavior where keys with one character are prefixed with just one hyphen. Currently, on master, they can do this:

toGNUCommandLine { mkOptionName = k: "--${k}"; } { f = [ 1 2 ]; }

= [ "--f", "1", "--f", "2" ]

... and that works because overriding mkOptionName will also override the behavior of the default implementation of mkList. However, after this change that would no longer work and it would instead produce:

toGNUCommandLine { mkOptionName = k: "--${k}"; } { f = [ 1 2 ]; }

= [ "-f", "1", "-f", "2" ]

@lukateras
Copy link
Member Author

lukateras commented Feb 22, 2020

Thank you, I didn't consider that. Let me think how to both deduplicate these utilities and keep the behavior you've referenced (probably via makeScope?). Ensuring that toGNUCommandLine { mkOptionName = k: "--${k}"; } works as expected is definitely important.

@Gabriella439
Copy link
Contributor

@yegortimoshenko: Oh yeah, using something like makeScope so that the behavior can be overridden sounds more idiomatic

@Profpatsch
Copy link
Member

Profpatsch commented Mar 2, 2020

Oh yeah, using something like makeScope so that the behavior can be overridden sounds more idiomatic

Let’s keep it simple and pass these as attributes like mkValueString here:

https://github.com/NixOS/nixpkgs/blob/bf62a76f2b0d44d2ff7922cf2c0a3f43a4a15173/lib/generators.nix#L62-L65

@mmahut
Copy link
Member

mmahut commented Mar 24, 2020

What can we do to move this change forward?

@lukateras
Copy link
Member Author

I'll take a second stab at it sometime this week. Sorry for the delay.

@lukateras
Copy link
Member Author

Let’s keep it simple and pass these as attributes like mkValueString here [...]

@Profpatsch Hm, I am probably missing something, but to me it looks like mkKeyValueDefault in snippet that you've linked to behaves the same way toGNUCommandLine does here:

nixpkgs/lib/cli.nix

Lines 86 to 90 in 1d92613

toGNUCommandLine =
{ mkBool ? mkDefaultBool,
mkList ? mkDefaultList,
mkOption ? mkDefaultOption,
mkOptionName ? mkDefaultOptionName }:

Which would imply the same issue @Gabriel439 described above.

mkDefaultOption =
k: v: if v == null
then []
else [ (mkDefaultOptionName k) (lib.generators.mkValueStringDefault {} v) ];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are referencing mkDefaultOptionName here directly from the let (definition below).

Instead, pass it as argument to the function.

mkDefaultOption = { mkOptionName ? mkDefaultOptionName }: k: v: 

@stale
Copy link

stale bot commented Sep 23, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Sep 23, 2020
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 3, 2020
@stale
Copy link

stale bot commented Jun 6, 2021

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

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 6, 2021
@Profpatsch
Copy link
Member

Closing as abandoned.

@Profpatsch Profpatsch closed this Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants