Skip to content

Commit 6471b2b

Browse files
Update manpages with mercurial information (#526)
1 parent 281f340 commit 6471b2b

File tree

3 files changed

+41
-17
lines changed

3 files changed

+41
-17
lines changed

docs/shard.yml.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ the dependency.
285285
*git*::
286286
A Git repository URL (string).
287287
+
288-
The URL may be [any protocol](https://git-scm.com/docs/git-clone#_git_urls)
288+
The URL may be https://git-scm.com/docs/git-clone#_git_urls[any protocol]
289289
supported by Git, which includes SSH, GIT and HTTPS.
290290
+
291291
The Git repository will be cloned, the list of versions (and associated
@@ -324,10 +324,10 @@ Extends the _git_ resolver, and acts exactly like it.
324324

325325
A Mercurial repository URL (string).
326326
+
327-
The URL may be [any protocol](https://www.mercurial-scm.org/repo/hg/help/clone)
327+
The URL may be https://www.mercurial-scm.org/repo/hg/help/clone[any protocol]
328328
supported by Mercurial, which includes SSH and HTTPS.
329329
+
330-
The Merurial repository will be cloned, the list of versions (and associated
330+
The Mercurial repository will be cloned, the list of versions (and associated
331331
_shard.yml_) will be extracted from Mercurial tags (e.g., _v1.2.3_).
332332
+
333333
One of the other attributes (_version_, _tag_, _branch_, _bookmark_ or _commit_) is

man/shard.yml.5

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
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 \*(Aqprerelease\*(Aq.
168+
It may contain a letter to make it a \(aqprerelease\(aq.
169169
.RE
170170
.sp
171171
Examples: \fI1.2.3\fP, \fI2.0.0.1\fP, \fI1.0.0.alpha\fP \fI2.0.0\-rc1\fP or \fI2016.09\fP.
172172
.sp
173173
While Shards doesn\(cqt enforce it, following a rational versioning scheme like
174-
.URL "http://semver.org/" "Semantic Versioning" ""
174+
.URL "http://semver.org/" "Semantic Versioning" " "
175175
or
176176
.URL "http://calver.org/" "Calendar Versioning"
177177
is highly recommended.
@@ -435,7 +435,7 @@ libraries:
435435
\fBlicense\fP
436436
.RS 4
437437
An \c
438-
.URL "http://opensource.org/" "OSI license" ""
438+
.URL "http://opensource.org/" "OSI license" " "
439439
name or an URL to a license file
440440
(string, recommended).
441441
.RE
@@ -539,8 +539,8 @@ the dependency.
539539
.RS 4
540540
A 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"
544544
supported by Git, which includes SSH, GIT and HTTPS.
545545
.sp
546546
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.
582582
\fBExample:\fP \fIbitbucket: tom/library\fP
583583
.RE
584584
.sp
585+
\fBhg\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+
\fIshard.yml\fP) will be extracted from Mercurial tags (e.g., \fIv1.2.3\fP).
595+
.sp
596+
One of the other attributes (\fIversion\fP, \fItag\fP, \fIbranch\fP, \fIbookmark\fP or \fIcommit\fP) is
597+
required. When missing, Shards will install the \fI@\fP bookmark or \fItip\fP.
598+
.sp
599+
\fBExample:\fP \fIhg: \c
600+
.URL "https://hg.example.org/crystal\-library" "" "\fP"
601+
.RE
602+
.sp
585603
\fBversion\fP
586604
.RS 4
587605
A version requirement (string).
@@ -662,17 +680,23 @@ the \fI~>\fP operator has a special meaning, best shown by example:
662680
.sp
663681
\fBbranch\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
\fBcommit\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
\fBtag\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+
\fBbookmark\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
685709
name: shards
686710
version: 1.2.3
687-
crystal: \*(Aq>= 0.35.0\*(Aq
711+
crystal: \(aq>= 0.35.0\(aq
688712

689713
authors:
690714
\- Julien Portalier <[email protected]>

man/shards.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: shards
33
.\" Author: [see the "AUTHOR(S)" section]
44
.\" Generator: Asciidoctor 2.0.12
5-
.\" Date: 2021-06-29
5+
.\" Date: 2021-10-04
66
.\" Manual: Shards Manual
77
.\" Source: shards 0.15.0
88
.\" Language: English
99
.\"
10-
.TH "SHARDS" "1" "2021-06-29" "shards 0.15.0" "Shards Manual"
10+
.TH "SHARDS" "1" "2021-10-04" "shards 0.15.0" "Shards Manual"
1111
.ie \n(.g .ds Aq \(aq
1212
.el .ds Aq '
1313
.ss \n[.ss] 0

0 commit comments

Comments
 (0)