Skip to content

Commit

Permalink
doc: update versioning guidelines to use numbers for patch tags
Browse files Browse the repository at this point in the history
  • Loading branch information
abdes committed Dec 9, 2022
1 parent 57d9f3b commit 13ce3df
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 13ce3df

Please sign in to comment.