Browse Source

Describe tag names more consistently, fixes #2170

Jordi Boggiano 11 years ago
parent
commit
eb331cbcbe
2 changed files with 8 additions and 5 deletions
  1. 3 2
      doc/02-libraries.md
  2. 5 3
      doc/04-schema.md

+ 3 - 2
doc/02-libraries.md

@@ -69,8 +69,9 @@ you can just add a `version` field:
 ### Tags
 
 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 for RC,
-beta, alpha or patch.
+created. It should match '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.
 
 Here are a few examples of valid tag names:
 

+ 5 - 3
doc/04-schema.md

@@ -50,10 +50,12 @@ Required for published packages (libraries).
 
 ### version
 
-The version of the package.
+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` with an optional suffix of `-dev`,
-`-alphaN`, `-betaN` or `-RCN`.
+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.
 
 Examples: