Skip to main content

IAR Embedded Workbench for RISC-V 3.40

Typographic conventions

In this section:

The IAR documentation set uses the following typographic conventions:

Style

Used for

computer

• Source code examples and file paths.

• Text on the command line.

• Binary, hexadecimal, and octal numbers.

parameter

A placeholder for an actual value used as a parameter, for example filename.h where filename represents the name of the file.

[option]

An optional part of a linker or stack usage control directive, where [ and ] are not part of the actual directive, but any [, ], {, or } are part of the directive syntax.

{option}

A mandatory part of a linker or stack usage control directive, where { and } are not part of the actual directive, but any [, ], {, or } are part of the directive syntax.

[option]

An optional part of a command line option, pragma directive, or library filename.

[a|b|c]

An optional part of a command line option, pragma directive, or library filename with alternatives.

{a|b|c}

A mandatory part of a command line option, pragma directive, or library filename with alternatives.

bold

Names of menus, menu commands, buttons, and dialog boxes that appear on the screen.

italic

• Emphasis.

An ellipsis indicates that the previous item can be repeated an arbitrary number of times.

f0db_IDE_icon.png

Identifies instructions specific to the IAR Embedded Workbench® IDE interface.

f120_CLI_icon.png

Identifies instructions specific to the command line interface.

Bulb 40percent.png

Identifies helpful tips and programming hints.

Warning.png

Identifies warnings.

Table 50. Typographic conventions used in IAR documentation