From ea3736522d4f99e93e349d6e7491a443a6aac8d3 Mon Sep 17 00:00:00 2001 From: Robin Hallabro Date: Tue, 20 Jan 2015 09:05:40 +0100 Subject: [PATCH] Update documententation for version shorthand parsing --- doc/02-libraries.md | 4 ++-- doc/04-schema.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/02-libraries.md b/doc/02-libraries.md index 561f3aa79..913f996b7 100644 --- a/doc/02-libraries.md +++ b/doc/02-libraries.md @@ -77,8 +77,8 @@ you can just add a `version` field: For every tag that looks like a version, a package version of that tag will be created. It should match 'X.Y.Z' or 'vX.Y.Z', with an optional suffix -of `-patch`, `-alpha`, `-beta` or `-RC`. The suffixes can also be followed by -a number. +of `-patch` (`-p`), `-alpha` (`-a`), `-beta` (`-b`) or `-RC`. The suffixes +can also be followed by a number. Here are a few examples of valid tag names: diff --git a/doc/04-schema.md b/doc/04-schema.md index 8662ca855..3acfef735 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -54,8 +54,8 @@ The version of the package. In most cases this is not required and should be omitted (see below). This must follow the format of `X.Y.Z` or `vX.Y.Z` with an optional suffix -of `-dev`, `-patch`, `-alpha`, `-beta` or `-RC`. The patch, alpha, beta and -RC suffixes can also be followed by a number. +of `-dev`, `-patch` (`-p`), `-alpha` (`-a`), `-beta` (`-b`) or `-RC`. +The patch, alpha, beta and RC suffixes can also be followed by a number. Examples: @@ -67,6 +67,7 @@ Examples: - 1.0.0-alpha3 - 1.0.0-beta2 - 1.0.0-RC5 +- v2.0.4-p1 Optional if the package repository can infer the version from somewhere, such as the VCS tag name in the VCS repository. In that case it is also recommended