riscv
/
skywater-pdk
mirror of https://github.com/google/skywater-pdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Fixing the verbatim in versioning.rst file. 

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
This commit is contained in:
Tim 'mithro' Ansell 2020-05-08 20:27:50 -07:00
parent 1242fab66e
commit 7a530fcf20
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/versioning.rst
View File

@ -1,30 +1,35 @@
Version Number Format
---------------------
Version numbers for both the PDK and the supplied libraries are fully specified by a 3-digit version number followed by a git commit count and a git commit short hash.
The 3-digit-number will be tagged in the associated git repository as `vX.Y.Z` and the fully specified value can be found by running `git describe` tool inside the correct git repository.
The 3-digit-number will be tagged in the associated git repository as ``vX.Y.Z`` and the fully specified value can be found by running |git-describe|_ tool inside the correct git repository.
The version number is broken down as `vX.Y.Z-AAA-gHHHHH`;
.. |git-describe| replace:: ``git describe``
.. _git-describe: https://git-scm.com/docs/git-describe
- The letter `v`.
The version number is broken down as ``vX.Y.Z-AAA-gHHHHH``;
- `X` = The "Milestone Release" Number
* The letter ``v``.
- **0** indicates **"alpha"** level. The IP has not undergone full qualification. Parts of the IP may be immature and untested.
* ``X`` = The "Milestone Release" Number
- **1** indicates **"beta"** level. The IP has undergone qualification testing but has not been hardware verified.
* **0** indicates **"alpha"** level. The IP has **not** undergone full qualification. Parts of the IP **may be immature and untested**.
- **2** indicates **production** level. The IP has passed qualification testing and has been hardware verified.
* **1** indicates **"beta"** level. The IP has undergone qualification testing but has **not** been hardware verified.
- `Y` = The "Major Release" Number
* **2** indicates **production** level. The IP has passed qualification testing and has been hardware verified.
- `Z` = The "Minor Release" Number
* ``Y`` = The "Major Release" Number
- A single hyphen character `-`
* ``Z`` = The "Minor Release" Number
- `AAA` = The git commit count since the version number was tagged.
* A single hyphen character ``-``
- A single hyphen character followed by the letter g `-g`
* ``AAA`` = The `git commit count <https://git-scm.com/docs/git-describe#_examples>`_ since the version number was tagged.
- `HHHH` = A git commit short hash which uniquely identifies a specific git commit inside the associated git repository.
* A single hyphen character followed by the letter g ``-g``
* ``HHHH`` = A `git commit short hash <https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_short_sha_1>`_ which uniquely identifies a specific git commit inside the associated git repository.