1
1
'\" t
2
2
.\" Title: shard.yml
3
3
.\" 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
6
6
.\" Manual: File Formats
7
7
.\" Source: shards 0.15.0
8
8
.\" Language: English
9
9
.\"
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"
11
11
.ie \n( .g .ds Aq \(aq
12
12
.el .ds Aq '
13
13
.ss \n[ .ss ] 0
@@ -165,13 +165,13 @@ It may contain dots and dashes but not consecutive ones.
165
165
. sp -1
166
166
. IP \(bu 2.3
167
167
.\}
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 .
169
169
.RE
170
170
.sp
171
171
Examples: \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 .
172
172
.sp
173
173
While 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" " "
175
175
or
176
176
.URL " http://calver.org/" " Calendar Versioning"
177
177
is highly recommended.
@@ -435,7 +435,7 @@ libraries:
435
435
\fB license \fP
436
436
.RS 4
437
437
An \c
438
- .URL " http://opensource.org/" " OSI license" ""
438
+ .URL " http://opensource.org/" " OSI license" " "
439
439
name or an URL to a license file
440
440
(string, recommended).
441
441
.RE
@@ -539,8 +539,8 @@ the dependency.
539
539
.RS 4
540
540
A Git repository URL (string).
541
541
.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 "
544
544
supported by Git, which includes SSH, GIT and HTTPS.
545
545
.sp
546
546
The 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.
582
582
\fB Example: \fP \fI bitbucket: tom/library \fP
583
583
.RE
584
584
.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
585
603
\fB version \fP
586
604
.RS 4
587
605
A version requirement (string).
@@ -662,17 +680,23 @@ the \fI~>\fP operator has a special meaning, best shown by example:
662
680
.sp
663
681
\fB branch \fP
664
682
.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).
666
685
.RE
667
686
.sp
668
687
\fB commit \fP
669
688
.RS 4
670
- Install the specified commit of a git dependency (string).
689
+ Install the specified commit of a git or mercurial dependency (string).
671
690
.RE
672
691
.sp
673
692
\fB tag \fP
674
693
.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).
676
700
.RE
677
701
.SH "EXAMPLE:"
678
702
.sp
@@ -684,7 +708,7 @@ with some dependencies:
684
708
.fam C
685
709
name: shards
686
710
version: 1.2.3
687
- crystal: \*( Aq >= 0.35.0\*( Aq
711
+ crystal: \( aq >= 0.35.0\( aq
688
712
689
713
authors:
690
714
\- Julien Portalier <
[email protected] >
0 commit comments