From 13ce3df4034c75d5949b229c85b1f3a28ba3c8ae Mon Sep 17 00:00:00 2001 From: Abdessattar Sassi <457645+abdes@users.noreply.github.com> Date: Fri, 9 Dec 2022 23:27:53 +0400 Subject: [PATCH] doc: update versioning guidelines to use numbers for patch tags --- CONTRIBUTING.md | 4 ++-- README.md | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96d9a14..b09b9fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,8 +67,8 @@ git tag -a CRYPTOPP_M_m_p -m "Blah blah blah..." > :warning: **Pay attention to the format of the tag**: the version uses `_` and > not `.`! -> Also note that *patch tags* will also have a letter suffix (e.g. -> CRYPTOPP_8_7_0_a). +> Also note that *patch tags* will also have a sequential number suffix (e.g. +> CRYPTOPP_8_7_0_1). Push with the following command: diff --git a/README.md b/README.md index ec92555..e097eaf 100644 --- a/README.md +++ b/README.md @@ -96,9 +96,10 @@ the criticality of the defects, an additional release tag may be made. These *patch tags* will never introduce any additional changes in `crypto++` itself. Main release tags will have the format: `CRYPTOPP_M_m_p`, while *patch tags* -will have the format `CRYPTOPP_M_m_p_l`, where `M.m.p` represents the `crypto++` -version and `l` is a suffix letter incremented each time a *patch tag* is -created. +will have the format `CRYPTOPP_M_m_p_f`, where `M.m.p` represents the `crypto++` +version and `f` is a suffix number incremented each time a *patch tag* is +created. *Patch tags* will keep the same `crypto++` version as the main release +tag. > As always, if you want to get the latest and greatest, always track the master branch.