tpm2sh 0.12.2

TPM 2.0 shell
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# tpm2sh

`tpm2sh` is a command-line tool for accessing TPM 2.0 chips.

## Overview

* Git: https://git.kernel.org/pub/scm/linux/kernel/git/jarkko/tpm2sh.git
* Contributions: patches can be submitted to `tpm-protocol@lists.linux.dev`.
* Commits follow the
  [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
  specification.
* New commits must include a `Signed-off-by` trailer.
* Versioning scheme uses [Semantic Versioning](https://semver.org/).

## Development

### Documentation

Inline comments (`//`) are not allowed. Take advantage of either `///` or `//!`
when something needs to be documented to the source code.

Errors are documented with a convention stolen from
[Project Mu](https://microsoft.github.io/mu/CodeDevelopment/rust_documentation_conventions/#errors)::::

```
/// # Errors
///
/// Returns [ErrorName1](crate::module::ErrorEnum::Error1) when <this> happens
/// Returns [ErrorName2](crate::module::ErrorEnum::Error2) when <this> happens
///
```

## Licensing

`tpm2sh` is licensed under the `GPL-3.0-or-later` license.