Browse Source

Merge pull request #3652 from hallabro/documentation-versionparser

Update documententation for version shorthand parsing
Jordi Boggiano 10 years ago
parent
commit
f5de5a1268
2 changed files with 5 additions and 4 deletions
  1. 2 2
      doc/02-libraries.md
  2. 3 2
      doc/04-schema.md

+ 2 - 2
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
 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
 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:
 Here are a few examples of valid tag names:
 
 

+ 3 - 2
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).
 be omitted (see below).
 
 
 This must follow the format of `X.Y.Z` or `vX.Y.Z` with an optional suffix
 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:
 Examples:
 
 
@@ -67,6 +67,7 @@ Examples:
 - 1.0.0-alpha3
 - 1.0.0-alpha3
 - 1.0.0-beta2
 - 1.0.0-beta2
 - 1.0.0-RC5
 - 1.0.0-RC5
+- v2.0.4-p1
 
 
 Optional if the package repository can infer the version from somewhere, such
 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
 as the VCS tag name in the VCS repository. In that case it is also recommended