Skip to content

Conversation

@hyperfinitism
Copy link
Contributor

The existing documentation (README.md and docs/snpguest.1.adoc) was out of sync with the actual snpguest CLI: README.md omitted numerous subcommands, and descriptions of flags and summary lines were inaccurate (e.g., #132, #135, #138).

This pull request overhauls README.md and docs/snpguest.1.adoc to (partly) resolve these issues.

  • README.md
    • Reorganise the document structure
    • Adds full descriptions and examples for all subcommands, especially:
      • snpguest ok
      • snpguest generate measurement
      • snpguest generate ovmf-hash
      • snpguest generate id-block
      • snpguest generate key-digest
    • Sync synopsis lines and global options with current code.
  • docs/snpguest.1.adoc
    • Mirror all of the above changes in the AsciiDoc
    • Reformat sections and option lists for consistency

This commit aligns the documentation with the actual CLI implementation
and adds several previously missing subcommands.

Signed-off-by: Takuma IMAMURA <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants