Skip to content

README.md

Latest commit

 

History

History
46 lines (33 loc) · 1.59 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.59 KB
Raw

Build Status Daily Status Release Version

This repository contains the Transfer Entry definitions that are project-specific. This is an auxiliary document to theFirmware Handoff specification, which defines a data structure to transfer essential configuration information between firmware stages during platform initialization.

The documentation is generated using the Sphinx framework. A version of this specification, rendered in HTML, is available here.

Project dependencies

For an Ubuntu development machine, install the following packages to build the specification:

  • librsvg2-bin
  • python3-sphinx
  • python3-sphinxcontrib.svg2pdfconverter
  • python3-sphinx-rtd-theme
  • sphinx-multiversion
  • latexmk
  • texlive-latex-extra

Note: This list has been tested on Ubuntu 22.04 LTS and 24.04 LTS running on AArch64 and AMD64.

Building the document

The following are use to generate the specification:

  • pdf:
make latexpdf
  • html:
make html

The output of these build commands goes into subdirectory build.