third_party.pigweed.src/pw_software_update/docs.rst
Ali Zhang bd3ee9e471 pw_software_update: Add documentation TOC
Bug: b/231245017

Change-Id: Iddd7b67fb58f1db4e8bafcdfedf1b9bf33090c61
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/94144
Pigweed-Auto-Submit: Ali Zhang <alizhang@google.com>
Reviewed-by: Yecheng Zhao <zyecheng@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
2022-05-11 00:48:32 +00:00

70 lines
1.1 KiB
ReStructuredText

.. _module-pw_software_update:
-------------------
pw_software_update
-------------------
This module provides the building blocks for an end-to-end, trusted software
update solution.
.. warning:: Documentation is incomplete and under construction.
Overview
========
..
TODO(alizhang): Overall mental model and goals.
Threats
-------
..
TODO(alizhang): Explain the threats we mitigate and those we don't.
Security
--------
..
TODO(alizhang): Explain how trust is created, delivered, and shared between
product owner and users to achieve security and privacy goals.
Operations
----------
..
TODO(alizhang): Explain how, when used correctly, software update can
profoundly improve development, release engineering, hardware ops,
factory, metrics, and product launching workflows.
Getting started
===============
..
TODO(alizhang): Tutorials, codelabs, representative examples.
Reference
=========
Bundle format
-------------
Manifesting
-----------
Key management
--------------
Signing
-------
Building
--------
Testing
-------
Device provisioning
-------------------
Device verification flow
------------------------