[bug#44367] [PATCH 2/2] doc: Document hg-fetch

[Christopher Baines]

Holger Peters <holger.peters@posteo.de> writes:

> * doc/guix.texi (hg-fetch): Add documentation for scheme procedure.

For the changelog for documentation, I normally put the section in the
round brackets, then describe the change after the colon. So, I changed
this to:

* doc/guix.texi (origin Reference): Add documentation for hg-fetch.

> ---
>  doc/guix.texi | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 69e7d5f85c..cb58ba85c6 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -6834,6 +6834,17 @@ commit:
>  @end lisp
>  @end deftp
>  
> +For mercurial repositories, the module @code{(guix hg-download)} defines the
> +@code{hg-fetch} origin method and @code{hg-reference} data type for support 
> of
> +the mercurial version control system.
> +
> +@deffn {Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash}

hg-fetch accepts an optional name parameter, so I added that here since
the text refers to it. Assuming you copied the git-fetch documentation,
that's maybe deficient as it doesn't mention all the parameters.

> +Return a fixed-output derivation that fetches @var{ref}, a
> +@code{<hg-reference>} object.  @code{<git-reference>} object.  The output is

There's a typo regarding git-reference here which I removed.

> +expected to have recursive hash @var{hash} of type @var{hash-algo} (a 
> symbol).
> +Use @var{name} as the file name, or a generic name if @code{#false}.
> +@end deffn
> +
>  @node Defining Package Variants
>  @section Defining Package Variants

signature.asc
Description: PGP signature