From: Christopher Baines <mail@cbaines.net>
To: Holger Peters <holger.peters@posteo.de>
Cc: 44367@debbugs.gnu.org
Subject: [bug#44367] [PATCH 2/2] doc: Document hg-fetch
Date: Sat, 14 Nov 2020 10:33:44 +0000 [thread overview]
Message-ID: <87lff4cjnb.fsf@cbaines.net> (raw)
In-Reply-To: <868c2aabcc8f55684c02e337ae288b43d5c98844.1604223741.git.holger.peters@posteo.de>
[-- Attachment #1: Type: text/plain, Size: 1601 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 987 bytes --]
next prev parent reply other threads:[~2020-11-14 10:34 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-01 9:47 [bug#44367] [PATCH 0/2] hg-predicate Holger Peters
2020-11-01 9:50 ` [bug#44367] [PATCH 1/2] guix: hg-download: Add hg-predicate Holger Peters
2020-11-01 9:50 ` [bug#44367] [PATCH 2/2] doc: Document hg-fetch Holger Peters
2020-11-14 10:33 ` Christopher Baines [this message]
2020-11-14 10:31 ` [bug#44367] [PATCH 1/2] guix: hg-download: Add hg-predicate Christopher Baines
2020-11-07 22:16 ` [bug#44367] Rationale for hg-predicate Dr. Arne Babenhauserheide
2020-11-13 18:02 ` Holger Peters
2020-11-14 10:29 ` bug#44367: " Christopher Baines
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87lff4cjnb.fsf@cbaines.net \
--to=mail@cbaines.net \
--cc=44367@debbugs.gnu.org \
--cc=holger.peters@posteo.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).