ntfs2btrfs: init at 20240115

[j1nxie]

Description of changes

Ntfs2btrfs is a tool which does in-place conversion of Microsoft's NTFS filesystem to the open-source filesystem Btrfs, much as btrfs-convert does for ext2.

(original GitHub page: https://github.com/maharmstone/ntfs2btrfs)

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[DerRockWolf]

Reviewed points

• package path fits guidelines
• package name fits guidelines
• package version fits guidelines
• package builds on x86_64-linux
• executables tested (just run, no FS conversion tested) on x86_64-linux
• meta.description is set and fits guidelines
• meta.license fits upstream license
• meta.platforms is set
• meta.maintainers is set
• build time only dependencies are declared in nativeBuildInputs
• source is fetched using the appropriate function
• the list of phases is not overridden

Possible improvements

• Can you please squash the last two (package related) commits, and use the PR title as the commit message.
• Please make sure that meta.description follows: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#meta-attributes.
• Please ad meta.platforms, otherwise binaries aren't prebuilt.

Comments

I did this review because of the recommendation in the PR template. If you want to and find some time you could also look at my PR: #297245

[j1nxie]

squashed the two commits, and changed the commit message to the PR title!

i also changed a bit of the wording, please tell me if meta.description fits better now!

added meta.platforms and excluded darwin as i don't believe this builds on darwin - or at least the original repository does not mention anything about darwin.

thanks for the review, please tell me if there is anything else i need to fix.

[DerRockWolf]

See my above comments

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review/3032/3661

[j1nxie]

See my above comments

also added meta.platforms if you missed it, according to the guidelines i'm supposed to set it to lib.platforms.all and tag badPlatforms for platforms that won't build - i pre-emptively tagged all darwin platforms as meta.badPlatforms since the original repo does not mention building on darwin and i don't have a machine to test sadly.

[DerRockWolf]

See my above comments

also added meta.platforms if you missed it, according to the guidelines i'm supposed to set it to lib.platforms.all and tag badPlatforms for platforms that won't build - i pre-emptively tagged all darwin platforms as meta.badPlatforms since the original repo does not mention building on darwin and i don't have a machine to test sadly.

Yes, I've seen it :)
Do you mind pointing me to the guidelines about platforms? I could only find this and "Platforms should be set (or the package will not get binary substitutes)." from here.

[j1nxie]

See my above comments

also added meta.platforms if you missed it, according to the guidelines i'm supposed to set it to lib.platforms.all and tag badPlatforms for platforms that won't build - i pre-emptively tagged all darwin platforms as meta.badPlatforms since the original repo does not mention building on darwin and i don't have a machine to test sadly.

Yes, I've seen it :) Do you mind pointing me to the guidelines about platforms? I could only find this and "Platforms should be set (or the package will not get binary substitutes)." from here.

In general it is preferable to set meta.platforms = lib.platforms.all and then exclude any platforms on which the package is known not to build. For example, a package which requires dynamic linking and cannot be linked statically could use this.

this is quoted straight from the first link you sent!

[DerRockWolf]

In general it is preferable to set meta.platforms = lib.platforms.all and then exclude any platforms on which the package is known not to build. For example, a package which requires dynamic linking and cannot be linked statically could use this.

this is quoted straight from the first link you sent!

Ah, you're right, my bad 😅

[lolbinarycat]

built successfully. looks pretty good!

it does output to /sbin also, maybe that should be deleted in a postInstall hook?

[j1nxie]

built successfully. looks pretty good!

it does output to /sbin also, maybe that should be deleted in a postInstall hook?

ideally (at least, in my own testing) you probably should invoke ntfs2btrfs with su permissions, at least with sudo ntfs2btrfs, so i'm unsure whether or not i should remove the /sbin output.