11'\" t
22.\" Title: shard.yml
33.\" Author: [see the "AUTHOR(S)" section]
4- .\" Generator: Asciidoctor 2.0.16
5- .\" Date: 2021-08-14
4+ .\" Generator: Asciidoctor 2.0.12
5+ .\" Date: 2021-10-04
66.\" Manual: File Formats
77.\" Source: shards 0.15.0
88.\" Language: English
99.\"
10- .TH "SHARD.YML" "5" "2021-08-14 " "shards 0.15.0" "File Formats"
10+ .TH "SHARD.YML" "5" "2021-10-04 " "shards 0.15.0" "File Formats"
1111.ie \n( .g .ds Aq \(aq
1212.el .ds Aq '
1313.ss \n[ .ss ] 0
@@ -165,13 +165,13 @@ It may contain dots and dashes but not consecutive ones.
165165. sp -1
166166. IP \(bu 2.3
167167.\}
168- It may contain a letter to make it a \*( Aq prerelease \*( Aq .
168+ It may contain a letter to make it a \( aq prerelease \( aq .
169169.RE
170170.sp
171171Examples: \fI 1.2.3 \fP , \fI 2.0.0.1 \fP , \fI 1.0.0.alpha \fP \fI 2.0.0 \- rc1 \fP or \fI 2016.09 \fP .
172172.sp
173173While Shards doesn\(cq t enforce it, following a rational versioning scheme like
174- .URL " http://semver.org/" " Semantic Versioning" ""
174+ .URL " http://semver.org/" " Semantic Versioning" " "
175175or
176176.URL " http://calver.org/" " Calendar Versioning"
177177is highly recommended.
@@ -435,7 +435,7 @@ libraries:
435435\fB license \fP
436436.RS 4
437437 An \c
438- .URL " http://opensource.org/" " OSI license" ""
438+ .URL " http://opensource.org/" " OSI license" " "
439439name or an URL to a license file
440440(string, recommended).
441441.RE
@@ -539,8 +539,8 @@ the dependency.
539539.RS 4
540540A Git repository URL (string).
541541.sp
542- The URL may be [any protocol]( \c
543- .URL " https://git\- scm.com/docs/git\- clone#_git_urls" "" " ) "
542+ The URL may be \c
543+ .URL " https://git\- scm.com/docs/git\- clone#_git_urls" " any protocol "
544544supported by Git, which includes SSH, GIT and HTTPS.
545545.sp
546546The Git repository will be cloned, the list of versions (and associated
@@ -582,6 +582,24 @@ Extends the \fIgit\fP resolver, and acts exactly like it.
582582\fB Example: \fP \fI bitbucket: tom/library \fP
583583.RE
584584.sp
585+ \fB hg \fP
586+ .RS 4
587+ A Mercurial repository URL (string).
588+ .sp
589+ The URL may be \c
590+ .URL " https://www.mercurial\- scm.org/repo/hg/help/clone" " any protocol"
591+ supported by Mercurial, which includes SSH and HTTPS.
592+ .sp
593+ The Mercurial repository will be cloned, the list of versions (and associated
594+ \fI shard.yml \fP ) will be extracted from Mercurial tags (e.g., \fI v1.2.3 \fP ).
595+ .sp
596+ One of the other attributes (\fI version \fP , \fI tag \fP , \fI branch \fP , \fI bookmark \fP or \fI commit \fP ) is
597+ required. When missing, Shards will install the \fI @ \fP bookmark or \fI tip \fP .
598+ .sp
599+ \fB Example: \fP \fI hg: \c
600+ .URL " https://hg.example.org/crystal\- library" "" " \fP "
601+ .RE
602+ .sp
585603\fB version \fP
586604.RS 4
587605A version requirement (string).
@@ -662,17 +680,23 @@ the \fI~>\fP operator has a special meaning, best shown by example:
662680.sp
663681\fB branch \fP
664682.RS 4
665- Install the specified branch of a git dependency (string).
683+ Install the specified branch of a git dependency or the named branch
684+ of a mercurial dependency (string).
666685.RE
667686.sp
668687\fB commit \fP
669688.RS 4
670- Install the specified commit of a git dependency (string).
689+ Install the specified commit of a git or mercurial dependency (string).
671690.RE
672691.sp
673692\fB tag \fP
674693.RS 4
675- Install the specified tag of a git dependency (string).
694+ Install the specified tag of a git or mercurial dependency (string).
695+ .RE
696+ .sp
697+ \fB bookmark \fP
698+ .RS 4
699+ Install the specified bookmark of a mercurial dependency (string).
676700.RE
677701.SH "EXAMPLE:"
678702.sp
@@ -684,7 +708,7 @@ with some dependencies:
684708.fam C
685709name: shards
686710version: 1.2.3
687- crystal: \*( Aq >= 0.35.0\*( Aq
711+ crystal: \( aq >= 0.35.0\( aq
688712
689713authors:
690714\- Julien Portalier <
[email protected] >
0 commit comments