5 pseudo-code conventions, 6 typographic conventions – Intel Extensible Firmware Interface User Manual

Page 40

Advertising
background image

Extensible Firmware Interface Specification

1-14

12/01/02

Version 1.10

1.8.5

Pseudo-Code Conventions

Pseudo code is presented to describe algorithms in a more concise form. None of the algorithms in
this document are intended to be compiled directly. The code is presented at a level corresponding
to the surrounding text.

In describing variables, a list is an unordered collection of homogeneous objects. A queue is an
ordered list of homogeneous objects. Unless otherwise noted, the ordering is assumed to be FIFO.

Pseudo code is presented in a C-like format, using C conventions where appropriate. The coding
style, particularly the indentation style, is used for readability and does not necessarily comply with
an implementation of the EFI Specification.

1.8.6

Typographic Conventions

This document uses the typographic and illustrative conventions described below:

Plain text

The normal text typeface is used for the vast majority of the
descriptive text in a specification.

Plain text (blue)

In the electronic version of this specification, any

plain text

underlined and in blue indicates an active link to the cross-reference.

Bold

In text, a Bold typeface identifies a processor register name. In other
instances, a Bold typeface can be used as a running head within a
paragraph.

Italic

In text, an Italic typeface can be used as emphasis to introduce a new
term or to indicate a manual or specification name.

BOLD Monospace

Computer code, example code segments, and all prototype code
segments use a

BOLD Monospace

typeface with a dark red color.

These code listings normally appear in one or more separate
paragraphs, though words or segments can also be embedded in a
normal text paragraph.

BOLD Monospace

In the electronic version of this specification, words in a

BOLD

Monospace

typeface that is underlined and in a dark red color

indicate an active hyperlink to the definition for that function or type
definition. Click on the word to follow the hyperlink.

NOTE

Due to management and file size considerations, only the first occurrence of the reference on each
page is an active link. Subsequent references on the same page will not be actively linked to the
definition and will use the standard, nonunderlined

BOLD Monospace

typeface. Find the first

instance of the name (in the underlined

BOLD Monospace

typeface) on the page and click on the

word to jump to the function or type definition.

Italic Monospace

In code or in text, words in

Italic Monospace

indicate

placeholder names for variable information that must be supplied
(i.e., arguments).

Advertising