lib.path.splitRoot: init

[infinisil]

Description of changes

Creates a new function:

• lib.path.splitRoot :: Path -> { root :: Path, subpath :: String }: Split a path into its parts.

  lib.path.splitRoot /foo/bar
  -> { root = /.; subpath = "./foo/bar"; }

This is part of the path library effort and needed for the implementation of file set combinators.

This work is sponsored by Antithesis ✨

Things done

• Tests
• Docs

[roberth]

You know I like parts, but I was kind of expecting this to do the splitting between / thing.
I'd frame this as making the path relative or splitting it from its root.
lib.path.splitRoot?

[infinisil]

I like it, applied!

[roberth]

It's unfortunate that this concept does not have Nix documentation yet.

• Describe a notion of root (or similar) for source tree abstraction paths nix#8718

(no action required now)

[infinisil]

I fixed the bug in nixdoc that removed all indentation: nix-community/nixdoc#62

That was just too annoying when we're trying to have some nice formatting in the docs!

[roberth]

Reader will wonder what's the problem with this? Surely / is the root.

I think it might be sensible to treat all "${storeDir}/${x}" as roots, but that's a discussion for another time.

[infinisil]

That feels like something that should be supported by lib.strings.* instead. The error could even redirect the user to that

[infinisil]

I think this is ready to be merged

[roberth]

Scoping out per-sublibrary and per-type docs.

[infinisil]

Scoping out per-sublibrary and per-type docs.

Not sure what you mean with that, but thanks for the merge :)