From eb331cbcbe88b20f3350630cec584b3039a34a56 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Tue, 13 Aug 2013 14:46:43 +0200 Subject: [PATCH] Describe tag names more consistently, fixes #2170 --- doc/02-libraries.md | 5 +++-- doc/04-schema.md | 8 +++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/02-libraries.md b/doc/02-libraries.md index a0797569a..a2cee3a97 100644 --- a/doc/02-libraries.md +++ b/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: diff --git a/doc/04-schema.md b/doc/04-schema.md index 5afed65f3..dc8360cd7 100644 --- a/doc/04-schema.md +++ b/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: