Commit 1e5ca4ea authored by Matt Sturgeon's avatar Matt Sturgeon Committed by Yueh-Shun Li
Browse files

fetchurl: add doc-comment for fetchurl.resolveUrl

parent ca050c53

pkgs/build-support/fetchurl/default.nix

+22 −0
Original line number Diff line number Diff line
@@ -35,6 +35,28 @@ let 
  # "gnu", etc.).

  sites = builtins.attrNames mirrors;



  /**

    Resolve a URL against the available mirrors.



    If the input is a `"mirror://"` URL, it is normalized.

    Otherwise, the URL is returned unmodified in a singleton list.



    Mirror URLs should be formatted as:

    ```

    mirror://{mirror_name}/{path}

    ```



    The specified `mirror_name` must correspond to an entry in `pkgs/build-support/fetchurl/mirrors.nix`, otherwise an error is thrown.



    # Inputs



    `url` (String)

    : A (possibly `"mirror://"`) URL to resolve.



    # Output



    A list of resolved URLs.

  */

  resolveUrl =

    url:

    let