OpenPOWER Library

 Preface

 1. Conventions

The OpenPOWER Foundation documentation uses several typesetting conventions.

 Notices

Notices take these forms:

[Note]Note

A handy tip or reminder.

[Important]Important

Something you must be aware of before proceeding.

[Warning]Warning

Critical information about the risk of data loss or security issues.

 Changes

At certain points in the document lifecycle, knowing what changed in a document is important. In these situations, the following conventions will used.

  • New text will appear like this. Text marked in this way is completely new.

  • Deleted text will appear like this. Text marked in this way was removed from the previous version and will not appear in the final, published document.

  • Changed text will appear like this. Text marked in this way appeared in previous versions but has been modified.

 Command prompts

In general, examples use commands from the Linux operating system. Many of these are also common with Mac OS, but may differ greatly from the Windows operating system equivalents.

For the Linux-based commands referenced, the following conventions will be followed:

$ prompt

Any user, including the root user, can run commands that are prefixed with the $ prompt.

# prompt

The root user must run commands that are prefixed with the # prompt. You can also prefix these commands with the sudo command, if available, to run them.

 Document links

Document links frequently appear throughout the documents. Generally, these links include a text for the link, followed by a page number in parenthesis. For example, this link, Preface, references the Preface chapter on page .

 2. Document change history

This version of the guide replaces and obsoletes all earlier versions.

The following table describes the most recent changes:

Revision DateSummary of Changes

March 29, 2019

  • Start from the original Word document