= Preface
:doctype: book

[NOTE]
========================================================================

The Jakarta Enterprise Edition documentation is part of the Jakarta Enterprise 
Edition contribution to the Eclipse Foundation and is not intended for 
use in relation to Java Enterprise Edition or Java Licensee 
requirements. This documentation is in the process of being revised to 
reflect the new Jakarta EE requirements and branding. 
Additional changes will be made as requirements and procedures evolve 
for Jakarta EE. Where applicable, references to Java EE or Java 
Enterprise Edition should be considered references to Jakarta EE. 

Please see the Title page for additional license information.
========================================================================

This book introduces the Test Compatibility Kit (TCK) for the Jakarta
Platform, Enterprise Edition 11 (Jakarta EE {tck_version}) and Jakarta Platform, Enterprise
Edition 11 Web Profile (Jakarta EE {tck_version} Web Profile), and explains how to
configure and run the test suite. It also provides information for
troubleshooting problems you may encounter as you run the test suite.

The Jakarta Platform, Enterprise Edition 11 Test Compatibility Kit (Jakarta
EE {tck_version} TCK) is a portable, configurable automated test suite for verifying
the compatibility of an implementer's compliance with the Jakarta EE {tck_version}
Specification (hereafter referred to as the implementer's implementation, or VI).
The Jakarta EE {tck_version} Platform TCK uses the JavaTest harness version 5.0 to run the
test suite.


[NOTE]
========

URLs are provided so you can locate resources quickly. However, these
URLs are subject to changes that are beyond the control of the authors
of this guide.

========


[[who-should-use-this-book]]
= Who Should Use This Book

This guide is for developers of the Jakarta EE {tck_version} technology to assist them
in running the test suite that verifies compatibility of their
implementation of the Jakarta EE {tck_version} Specification.


[[before-you-read-this-book]]
= Before You Read This Book

Before reading this guide, you should familiarize yourself with the Java
programming language, the Jakarta Platform, Enterprise Edition {tck_version} Specification, and the JavaTest documentation.

The Jakarta Platform, Enterprise Edition {tck_version} Specification can be downloaded from https://jakarta.ee/specifications/{tck_version}.

For documentation on the test harness used for running the Jakarta EE {tck_version} Platform TCK test suite, see:

* https://github.com/arquillian/arquillian-core[Arquillian]
* https://junit.org/junit5/[Junit5]

[[typographic-conventions]]
= Typographic Conventions

The following table describes the typographic conventions that are used
in this book.

[width="100%",cols="15%,40%,45%",options="header",]
|=======================================================================
|Convention |Meaning |Example
|Boldface |Boldface type indicates graphical user interface elements
associated with an action, terms defined in text, or what you type,
contrasted with onscreen computer output. a|
From the File menu, select Open Project.

A cache is a copy that is stored locally.

[source,bash]
----
machine_name% su
Password:
----

|`Monospace` |Monospace type indicates the names of files and
directories, commands within a paragraph, URLs, code in examples, text
that appears on the screen, or text that you enter. a|
Edit your `.login` file.

Use `ls` `-a` to list all files.

`machine_name% you have mail.`

|Italic |Italic type indicates book titles, emphasis, or placeholder
variables for which you supply particular values. a|
Read Chapter 6 in the User's Guide.

Do not save the file.

The command to remove a file is `rm` filename.

|=======================================================================


[[shell-prompts-in-command-examples]]
= Shell Prompts in Command Examples

The following table shows the default UNIX system prompt and superuser
prompt for the C shell, Bourne shell, and Korn shell.

.Shell Prompts
[width="100%",cols="50%,50%",options="header",]
|=====================================================
|Shell |Prompt
|C shell |`machine_name%`
|C shell for superuser |`machine_name#`
|Bourne shell and Korn shell |`$` +
|Bourne shell and Korn shell for superuser |`#` +
|Bash shell |`shell_name-shell_version$`
|Bash shell for superuser |`shell_name-shell_version#`
|=====================================================
