diff --git a/.gitignore b/.gitignore index 73199b88ab..bbda2e1409 100644 --- a/.gitignore +++ b/.gitignore @@ -16,12 +16,13 @@ target/ /user_guides/jakartaee/src/main/jbake/content/tck-packages.inc /user_guides/jakartaee/src/main/jbake/content/title.inc /user_guides/jakartaee/src/main/jbake/content/attributes.conf -/user_guides/**/toc.adoc +**/src/main/jbake/content/toc.adoc /nbproject .idea *.iml .project /glassfish-runner/batch-tck/apitests/test.properties +/glassfish-runner/batch-tck/sigtests/test.properties .classpath .settings/ classes/ @@ -30,4 +31,5 @@ dist/ release/ el/bundle jakartaeetck-bundles/ -/tck-env.cfg \ No newline at end of file +/tck-env.cfg +.DS_Store diff --git a/jpa/docs/userguide/pom.xml b/jpa/docs/userguide/pom.xml index 94b805c18e..3e40ee04d5 100644 --- a/jpa/docs/userguide/pom.xml +++ b/jpa/docs/userguide/pom.xml @@ -1,7 +1,7 @@ - + + 4.0.0 + - org.eclipse.ee4j - project - 1.0.7 + jakarta.tck + jakarta.tck.user-guide + 11.0.0-SNAPSHOT + ../../../user_guides/parent/pom.xml - org.glassfish - tck_jpa - 3.1.0 + + jakarta.persistence + jakarta.persistence-tck-user-guide pom - Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Persistence for Jakarta EE, Release 3.1 + 3.2.0-SNAPSHOT + Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Persistence for Jakarta EE, Release 3.2 ${project.version} + + + ${project.parent.version} + + Persistence + + DRAFT + + scm:git:git@github.com:eclipse-ee4j/jakartaee-tck.git - - 2.3.0 - 3.0.0 - 2.3.13 - 2.5.11 - Jakarta-Persistence-TCK-Users-Guide.pdf - 2.3.32 - 2.7.0-rc.7 - true - true - UTF-8 - ${project.build.directory}/staging - - - + - package - - - - org.apache.maven.plugins - maven-clean-plugin - 3.1.0 - - - org.glassfish.doc - glassfish-doc-maven-plugin - 1.3 - - - org.apache.maven.plugins - maven-enforcer-plugin - 3.0.0 - - - org.apache.maven.plugins - maven-assembly-plugin - 3.3.0 - - - org.apache.maven.plugins - maven-scm-publish-plugin - 3.1.0 - - - org.jbake - jbake-maven-plugin - ${jbake.maven.plugin.version} - - - org.asciidoctor - asciidoctorj - ${asciidoctorj.version} - - - org.asciidoctor - asciidoctorj-diagram - ${asciidoctorj.diagram.version} - - - org.freemarker - freemarker - ${freemarker.version} - - - - - org.asciidoctor - asciidoctor-maven-plugin - ${asciidoctorj.maven.plugin.version} - - - org.asciidoctor - asciidoctorj-pdf - ${asciidoctorj.pdf.version} - - - - - - - com.diffplug.spotless - spotless-maven-plugin - 2.36.0 - - - - pom.xml - - - 4 - - recommended_2008_06 - - true - - true - - true - - - - - - check-spotless-poms - - check - - validate - - - org.apache.maven.plugins - maven-clean-plugin - - - - src/main/jbake/content - - toc.adoc - - - - - - - org.apache.maven.plugins - maven-enforcer-plugin + maven-assembly-plugin - enforce-versions - - enforce - - - - - [11,) - You need Java SE 11 or newer - - - + build-dist + package @@ -185,39 +65,21 @@ glassfish-doc-maven-plugin - generate-book - - book - - generate-resources + generate-toc + generate-sources - generate-toc - - toc - - generate-resources - - [A-C0-9]+\s.*,Preface.*,Part\s.* - + generate-book + generate-sources org.jbake jbake-maven-plugin - - ${site.output.dir} - - ${status} - - build-site - - generate - generate-resources @@ -225,59 +87,13 @@ org.asciidoctor asciidoctor-maven-plugin - - ${project.build.directory}/book - book.adoc - - ${project.build.directory}/staging/ - pdf - ${doc.pdf} - - ${project.basedir}/src/theme - jakartaee - book - ${status} - - - font - - - font - true - - - - true - true - - generate-pdf-doc - - process-asciidoc - generate-resources - - org.apache.maven.plugins - maven-scm-publish-plugin - - - deploy-site - - publish-scm - - deploy - - gh-pages - false - Update site - - - - diff --git a/jpa/docs/userguide/src/main/jbake/assets/css/style.css b/jpa/docs/userguide/src/main/jbake/assets/css/style.css deleted file mode 100644 index 182f7559b6..0000000000 --- a/jpa/docs/userguide/src/main/jbake/assets/css/style.css +++ /dev/null @@ -1,313 +0,0 @@ -/* CSS */ -/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ -/** 1. Set default font family to sans-serif. 2. Prevent iOS text size adjust after orientation change, without disabling user zoom. */ -html { font-family: sans-serif; /* 1 */ -ms-text-size-adjust: 100%; /* 2 */ -webkit-text-size-adjust: 100%; /* 2 */ } - -/* HTML5 display definitions ========================================================================== */ -/** Correct `block` display not defined for any HTML5 element in IE 8/9. Correct `block` display not defined for `details` or `summary` in IE 10/11 and Firefox. Correct `block` display not defined for `main` in IE 11. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, menu, nav, section, summary { display: block; } - -/** 1. Correct `inline-block` display not defined in IE 8/9. 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. */ -audio, canvas, progress, video { display: inline-block; /* 1 */ vertical-align: baseline; /* 2 */ } - -/** Prevent modern browsers from displaying `audio` without controls. Remove excess height in iOS 5 devices. */ -audio:not([controls]) { display: none; height: 0; } - -/** Address `[hidden]` styling not present in IE 8/9/10. Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. */ -[hidden], template { display: none; } - -/* Links ========================================================================== */ -/** Remove the gray background color from active links in IE 10. */ -a { background-color: transparent; } - -/** Improve readability when focused and also mouse hovered in all browsers. */ -a:active, a:hover { outline: 0; } - -/* Text-level semantics ========================================================================== */ -/** Address styling not present in IE 8/9/10/11, Safari, and Chrome. */ -abbr[title] { border-bottom: 1px dotted; } - -/** Address style set to `bolder` in Firefox 4+, Safari, and Chrome. */ -b, strong { font-weight: bold; } - -/** Address styling not present in Safari and Chrome. */ -dfn { font-style: italic; } - -/** Address variable `h1` font-size and margin within `section` and `article` contexts in Firefox 4+, Safari, and Chrome. */ -h1 { font-size: 2em; margin: 0.67em 0; } - -/** Address styling not present in IE 8/9. */ -mark { background: #ff0; color: #000; } - -/** Address inconsistent and variable font size in all browsers. */ -small { font-size: 80%; } - -/** Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } - -sup { top: -0.5em; } - -sub { bottom: -0.25em; } - -/* Embedded content ========================================================================== */ -/** Remove border when inside `a` element in IE 8/9/10. */ -img { border: 0; } - -/** Correct overflow not hidden in IE 9/10/11. */ -svg:not(:root) { overflow: hidden; } - -/* Grouping content ========================================================================== */ -/** Address margin not present in IE 8/9 and Safari. */ -figure { margin: 1em 40px; } - -/** Address differences between Firefox and other browsers. */ -hr { box-sizing: content-box; height: 0; } - -/** Contain overflow in all browsers. */ -pre { overflow: auto; } - -/** Address odd `em`-unit font size rendering in all browsers. */ -code, kbd, pre, samp { font-family: monospace, monospace; font-size: 1em; } - -/* Forms ========================================================================== */ -/** Known limitation: by default, Chrome and Safari on OS X allow very limited styling of `select`, unless a `border` property is set. */ -/** 1. Correct color not being inherited. Known issue: affects color of disabled elements. 2. Correct font properties not being inherited. 3. Address margins set differently in Firefox 4+, Safari, and Chrome. */ -button, input, optgroup, select, textarea { color: inherit; /* 1 */ font: inherit; /* 2 */ margin: 0; /* 3 */ } - -/** Address `overflow` set to `hidden` in IE 8/9/10/11. */ -button { overflow: visible; } - -/** Address inconsistent `text-transform` inheritance for `button` and `select`. All other form control elements do not inherit `text-transform` values. Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. Correct `select` style inheritance in Firefox. */ -button, select { text-transform: none; } - -/** 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` and `video` controls. 2. Correct inability to style clickable `input` types in iOS. 3. Improve usability and consistency of cursor style between image-type `input` and others. */ -button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ } - -/** Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { cursor: default; } - -/** Remove inner padding and border in Firefox 4+. */ -button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } - -/** Address Firefox 4+ setting `line-height` on `input` using `!important` in the UA stylesheet. */ -input { line-height: normal; } - -/** It's recommended that you don't attempt to style these elements. Firefox's implementation doesn't respect box-sizing, padding, or width. 1. Address box sizing set to `content-box` in IE 8/9/10. 2. Remove excess padding in IE 8/9/10. */ -input[type="checkbox"], input[type="radio"] { box-sizing: border-box; /* 1 */ padding: 0; /* 2 */ } - -/** Fix the cursor style for Chrome's increment/decrement buttons. For certain `font-size` values of the `input`, it causes the cursor style of the decrement button to change from `default` to `text`. */ -input[type="number"]::-webkit-inner-spin-button, input[type="number"]::-webkit-outer-spin-button { height: auto; } - -/** 1. Address `appearance` set to `searchfield` in Safari and Chrome. 2. Address `box-sizing` set to `border-box` in Safari and Chrome (include `-moz` to future-proof). */ -input[type="search"] { -webkit-appearance: textfield; /* 1 */ /* 2 */ box-sizing: content-box; } - -/** Remove inner padding and search cancel button in Safari and Chrome on OS X. Safari (but not Chrome) clips the cancel button when the search input has padding (and `textfield` appearance). */ -input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; } - -/** Define consistent border, margin, and padding. */ -fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; } - -/** 1. Correct `color` not being inherited in IE 8/9/10/11. 2. Remove padding so people aren't caught out if they zero out fieldsets. */ -legend { border: 0; /* 1 */ padding: 0; /* 2 */ } - -/** Remove default vertical scrollbar in IE 8/9/10/11. */ -textarea { overflow: auto; } - -/** Don't inherit the `font-weight` (applied by a rule above). NOTE: the default cannot safely be changed in Chrome and Safari on OS X. */ -optgroup { font-weight: bold; } - -/* Tables ========================================================================== */ -/** Remove most spacing between table cells. */ -table { border-collapse: collapse; border-spacing: 0; } - -td, th { padding: 0; } - -/* LAYOUT STYLES */ - -p { margin-top: 0; } - -code, pre { margin-bottom: 30px; font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; font-size: 13px; color: #222; } - -code { padding: 0 3px; background-color: #f2f8fc; border: solid 1px #dbe7f3; } - -pre { padding: 20px; overflow: auto; text-shadow: none; background: #fff; border: solid 1px #f2f2f2; } - -pre code { padding: 0; color: #2879d0; background-color: #fff; border: none; } - -ul, ol, dl { margin-bottom: 20px; } - -/* COMMON STYLES */ - -td.halign-right { text-align: right; } - -td.halign-center { text-align: center; } - -form { padding: 20px; background: #f2f2f2; } - -h2 { - font-size: 2em; - line-height: 1.2em; - font-weight: 200; - letter-spacing: 0; -} - -h3 { - font-size: 1.4em; - line-height: 1.2em; - font-weight: normal; - letter-spacing: 0; -} - -.sect1 { - margin-left: 4%; - margin-right: 4%; - font: 13px/20px Arial, Helvetica, sans-serif -} - -a:link { - text-decoration: none; - color: #09569d; -} - -#preamble hr{ - margin-left: 0%; - margin-right: 0%; -} - -#preamble .sectionbody table { - font-weight: 200; - margin-left: 4%; - margin-right: 4%; -} - -hr { - margin-bottom: 12px; -} - -table.tableblock.frame-all.grid-all.spread { - font-size: 12px; -} - -code { - font-size:.9em; - border: 1px solid #eaeaea; - background-color: #f6f6f6; - border-radius: 3px; - padding: 1px; - padding-left:2px; - padding-right:2px; -} - -pre.prettyprint.highlight { - border: 1px solid #eaeaea; - background-color: #f6f6f6; - border-radius: 4px; - padding: 8px; - padding-top:4px; - padding-bottom:4px; -} - -.language-oac_no_warn { - font-size:.9em; - color:#222; - background-color: transparent; -} - -#doc-title { - margin-left: 4%; -} - -#top-nav { - margin-left: 4%; - font-size: 12px; -} - -#bottom-nav { - margin-left: 4%; - font-size: 12px; -} - -.vector-font { - color:grey; - font-size: 20px; -} - -#copyright { - padding-top: 10px; - padding-bottom: 4px; - display: table; - margin:0 auto; - color: grey; - font-size: 12px; - vertical-align: middle; -} - -.beta {color: #FF0000} - -/* GENERAL ELEMENT TYPE STYLES */ - -/* #Media Queries -================================================== */ -/* Smaller than standard 960 (devices and browsers) */ -/* Tablet Portrait size to standard 960 (devices and browsers) */ -@media only screen and (min-width: 768px) and (max-width: 959px) { .inner { width: 740px; } - header h1, header h2 { width: 340px; } - header h1 { font-size: 60px; } - header h2 { font-size: 30px; } -} -/* All Mobile Sizes (devices and browser) */ -@media only screen and (max-width: 767px) { .inner { width: 93%; } - header { padding: 20px 0; } - header .inner { position: relative; } - header h1, header h2 { width: 100%; } - header h1 { font-size: 48px; } - header h2 { font-size: 24px; } - header a.button { position: relative; display: inline-block; width: auto; height: auto; padding: 5px 10px; margin-top: 15px; font-size: 13px; line-height: 1; color: #2879d0; text-align: center; background-color: #9ddcff; background-image: none; border-radius: 5px; -moz-border-radius: 5px; -webkit-border-radius: 5px; } - header a.button small { display: inline; font-size: 13px; } -} -/* Mobile Landscape Size to Tablet Portrait (devices and browsers) */ -/* Mobile Portrait Size to Mobile Landscape Size (devices and browsers) */ - -header h1 { padding-top: 14px; font-size: 2em; font-weight: 200; line-height: 1.4; color: #FFFFFF; letter-spacing: 0px; border-bottom: 0px; } - -header h2 { font-size: 1.2em; margin-top: 0; margin-bottom: 0; font-weight: 200; line-height: .8; color: #ec7D11; letter-spacing: 0; } - -//header a.button { background: transparent url(../images/logo.png) 0 0 no-repeat; padding-left: 32px; } - -header a:hover { text-decoration: none; } - -/* Admonition (Note) block */ -.admonitionblock > table { - border: 0; - background: none; - width: 100%; - table-layout: auto; - margin-bottom: 10.5px; -} -.admonitionblock > table td.icon { - text-align: center; - width: 60px; -} -.admonitionblock > table td.icon img { - max-width: none; -} -.admonitionblock > table td.icon .title { - text-transform: uppercase; -} -.admonitionblock > table td.content { - padding-left: 1em; - padding-right: 1em; - border-left: 3px solid #ddd; -} -.admonitionblock > table td.content > :last-child > :last-child { - margin-bottom: 0; -} -.admonitionblock td.icon [class^="fa icon-"]:before { - font-size: 2.5em; - text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); - cursor: default; -} -.admonitionblock td.icon .icon-note:before { - content: "\f05a"; - color: #5bc0de; -} diff --git a/jpa/docs/userguide/src/main/jbake/assets/img/eclipse_foundation_logo_tiny.png b/jpa/docs/userguide/src/main/jbake/assets/img/eclipse_foundation_logo_tiny.png deleted file mode 100644 index ee830aeb93..0000000000 Binary files a/jpa/docs/userguide/src/main/jbake/assets/img/eclipse_foundation_logo_tiny.png and /dev/null differ diff --git a/jpa/docs/userguide/src/main/jbake/content/config.inc b/jpa/docs/userguide/src/main/jbake/content/config.inc index b24292ab5a..08f98e8779 100644 --- a/jpa/docs/userguide/src/main/jbake/content/config.inc +++ b/jpa/docs/userguide/src/main/jbake/content/config.inc @@ -31,7 +31,6 @@ On Windows, you must escape any backslashes with an extra backslash in path separators used in any of the following properties, or use forward slashes as a path separator instead. - ======================================================================= diff --git a/jpa/docs/userguide/src/main/jbake/content/faq.adoc b/jpa/docs/userguide/src/main/jbake/content/faq.adoc index 012bd5860c..02e0514269 100644 --- a/jpa/docs/userguide/src/main/jbake/content/faq.adoc +++ b/jpa/docs/userguide/src/main/jbake/content/faq.adoc @@ -29,7 +29,6 @@ A.1 Where do I start to debug a test failure? See link:debug.html#GBFUV[Chapter 6, "Debugging Test Problems,"] for more information. - [[GBFYR]][[a.2-how-do-i-restart-a-crashed-test-run]] A.2 How do I restart a crashed test run? diff --git a/jpa/docs/userguide/src/main/jbake/content/intro.adoc b/jpa/docs/userguide/src/main/jbake/content/intro.adoc index 4aa29c3227..3baf4427e7 100644 --- a/jpa/docs/userguide/src/main/jbake/content/intro.adoc +++ b/jpa/docs/userguide/src/main/jbake/content/intro.adoc @@ -17,7 +17,7 @@ Introduction This chapter provides an overview of the principles that apply generally to all Technology Compatibility Kits (TCKs) and describes the -{TechnologyFullName} TCK ({TechnologyShortName} {TechnologyVersion} TCK). +{TechnologyFullName} TCK ({TechnologyShortName} {TechnologyVersion} TCK). It also includes a high level listing of what is needed to get up and running with the {TechnologyShortName} TCK. @@ -187,7 +187,7 @@ include::platforms.inc[] 1.2.3 TCK Compatibility Test Suite ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The test suite is the collection of tests +The test suite is the collection of tests to test a particular technology implementation. In this case, it is the collection of JUnit tests used by the {TechnologyShortName} TCK {TechnologyVersion} to test a {TechnologyShortName} {TechnologyVersion} @@ -197,7 +197,7 @@ specification. The individual tests correspond to assertions of the specification. The tests that make up the TCK compatibility test suite are precompiled -and indexed within the TCK jar directory structure. +and indexed within the TCK jar directory structure. [[GBFSH]][[exclude-lists]] @@ -205,9 +205,9 @@ and indexed within the TCK jar directory structure. ^^^^^^^^^^^^^^^^^^^ Each version of a TCK includes an Exclude List contained in a `TCK-Exclude-List.txt` -file. +file. This is a list of test file URLs that identify tests which do not -have to be run for the specific version of the TCK being used. +have to be run for the specific version of the TCK being used. Whenever tests are run, the Junit framework automatically excludes these tests from being executed as those are disabled using '@Disabled' tag in JUnit. @@ -223,7 +223,7 @@ for documentation purpose. From time to time, updates to the Exclude List are made available. The exclude list is included in the Jakarta TCK ZIP archive. -Each time an update is approved and released, the version number +Each time an update is approved and released, the version number will be incremented. You should always make sure you are using an up-to-date copy of the Exclude List before running the {TechnologyShortName} TCK to verify your diff --git a/jpa/docs/userguide/src/main/jbake/content/preface.adoc b/jpa/docs/userguide/src/main/jbake/content/preface.adoc index 352447ef28..0b33f08e57 100644 --- a/jpa/docs/userguide/src/main/jbake/content/preface.adoc +++ b/jpa/docs/userguide/src/main/jbake/content/preface.adoc @@ -37,17 +37,17 @@ the authors of this guide. ======================================================================= -Jakarta EE is a community sponsored and community run program. -Organizations contribute, along side individual contributors who use, evolve +Jakarta EE is a community sponsored and community run program. +Organizations contribute, along side individual contributors who use, evolve and assist others. Commercial support is not available through the Eclipse Foundation resources. Please refer to the Eclipse EE4J project site (https://projects.eclipse.org/projects/ee4j). -There, you will find additional details as well as a list of all the associated sub-projects -(Implementations and APIs), that make up Jakarta EE and define these specifications. +There, you will find additional details as well as a list of all the associated sub-projects +(Implementations and APIs), that make up Jakarta EE and define these specifications. If you have questions about this Specification you may -send inquiries to {SpecificationInquiryList}. -If you have questions about this TCK, you may send inquiries to +send inquiries to {SpecificationInquiryList}. +If you have questions about this TCK, you may send inquiries to {TCKInquiryList}. [[TCJRS00034]][[GBFUS]] @@ -70,9 +70,8 @@ that verifies compatibility of their implementation of the Before You Read This Book ~~~~~~~~~~~~~~~~~~~~~~~~~ - You should be familiar with the {TechnologyShortName} -{TechnologyVersion}, version {TechnologyVersion} Specification, +{TechnologyVersion}, version {TechnologyVersion} Specification, which can be found at {SpecificationURL}. [[TCJRS00036]][[GBFWF]] diff --git a/jpa/docs/userguide/src/main/jbake/content/rules.adoc b/jpa/docs/userguide/src/main/jbake/content/rules.adoc index bf3c1130d1..514e020037 100644 --- a/jpa/docs/userguide/src/main/jbake/content/rules.adoc +++ b/jpa/docs/userguide/src/main/jbake/content/rules.adoc @@ -92,8 +92,8 @@ specification and which contains configuration information for a set of Java classes, archive, or other feature defined in the specification. |Conformance Tests |All tests in the Test Suite for an indicated -Technology Under Test, as released and distributed by the -Eclipse Foundation, excluding those tests on the +Technology Under Test, as released and distributed by the +Eclipse Foundation, excluding those tests on the published Exclude List for the Technology Under Test. |Container |An implementation of the associated Libraries, as specified @@ -225,7 +225,7 @@ interview. Apart from changing such properties and other allowed modifications described in this User's Guide (if any), no source or binary code for a Conformance Test may be altered in any way without prior written permission. Any such allowed alterations to the -Conformance Tests will be provided via the Jakarta EE Specification Project +Conformance Tests will be provided via the Jakarta EE Specification Project website and apply to all vendor compatible implementations. *{techID}3* The testing tools supplied as part of the Test Suite or as diff --git a/jpa/docs/userguide/src/main/jbake/content/using-examples.inc b/jpa/docs/userguide/src/main/jbake/content/using-examples.inc index ee251f6c04..eab3d3b8bb 100644 --- a/jpa/docs/userguide/src/main/jbake/content/using-examples.inc +++ b/jpa/docs/userguide/src/main/jbake/content/using-examples.inc @@ -13,7 +13,6 @@ mvn verify ---- -- - [[GCMCU]] Example 5-1 {TechnologyShortName} TCK Signature Tests @@ -26,7 +25,6 @@ following commands: mvn verify -Dit.test=ee.jakarta.tck.persistence.signaturetest.** ---- - [[GCMBV]] @@ -39,7 +37,6 @@ To run a single test directory, enter the following commands: mvn verify -Dit.test={singleTestDirectoryExample}.** ---- - [[GCMCA]] @@ -50,4 +47,4 @@ To run a subset of test directories, enter the following commands: [source,subs="attributes"] ---- mvn verify -Dit.test={subsetTestDirectoryExample}.** ----- \ No newline at end of file +---- diff --git a/jpa/docs/userguide/src/main/jbake/content/using.adoc b/jpa/docs/userguide/src/main/jbake/content/using.adoc index d8735a3063..fda1c4b151 100644 --- a/jpa/docs/userguide/src/main/jbake/content/using.adoc +++ b/jpa/docs/userguide/src/main/jbake/content/using.adoc @@ -15,7 +15,7 @@ Executing Tests 5 Executing Tests ----------------- -The {TechnologyShortName} TCK uses the Junit and Jboss Arquillian +The {TechnologyShortName} TCK uses the Junit and Jboss Arquillian frameworks to execute the tests. This chapter includes the following topics: @@ -28,10 +28,10 @@ This chapter includes the following topics: [NOTE] ======================================================================= -The {TechnologyShortName} TCK is not depended on any particular build tool to -run the tests. It will be convenient and advisable to create a -Apache Maven project to setup and run the TCK. This chapter will -henceforth use instructions and steps to provide setup with Apache +The {TechnologyShortName} TCK is not depended on any particular build tool to +run the tests. It will be convenient and advisable to create a +Apache Maven project to setup and run the TCK. This chapter will +henceforth use instructions and steps to provide setup with Apache Maven as a build tool. ======================================================================= @@ -49,7 +49,7 @@ endif::rebuild[] 5.1 Starting Test ~~~~~~~~~~~~~~~~~ -The {TechnologyShortName} TCK can be run from the command line +The {TechnologyShortName} TCK can be run from the command line in your shell environment by executing the TCK jar. diff --git a/jpa/docs/userguide/src/main/jbake/jbake.properties b/jpa/docs/userguide/src/main/jbake/jbake.properties deleted file mode 100644 index 05c7056f0a..0000000000 --- a/jpa/docs/userguide/src/main/jbake/jbake.properties +++ /dev/null @@ -1,24 +0,0 @@ -# -# Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved. -# -# This program and the accompanying materials are made available under the -# terms of the Eclipse Public License v. 2.0, which is available at -# http://www.eclipse.org/legal/epl-2.0. -# -# This Source Code may also be made available under the following Secondary -# Licenses when the conditions for such availability set forth in the -# Eclipse Public License v. 2.0 are satisfied: GNU General Public License, -# version 2 with the GNU Classpath Exception, which is available at -# https://www.gnu.org/software/classpath/license.html. -# -# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 -# - -site.host=http://jbake.org -render.tags=false -render.sitemap=false -render.archive=false -render.feed=false -render.index=false -asciidoctor.option.safe=0 -asciidoctor.attributes.export=true \ No newline at end of file diff --git a/jpa/docs/userguide/src/main/jbake/templates/footer.ftl b/jpa/docs/userguide/src/main/jbake/templates/footer.ftl deleted file mode 100644 index cb4fbe584b..0000000000 --- a/jpa/docs/userguide/src/main/jbake/templates/footer.ftl +++ /dev/null @@ -1,44 +0,0 @@ -<#-- a footer template fragment included in the page template --> -
- - - - - - - - - <#if content.prev??> - - - - <#if content.next??> - - - - - -
- - - Previous - - - - - Next - - - - - Contents - -
- - - Eclipse Foundation Logo  - Copyright © 2017, 2022 Oracle and/or its affiliates. All rights reserved. - - - - diff --git a/jpa/docs/userguide/src/main/jbake/templates/header.ftl b/jpa/docs/userguide/src/main/jbake/templates/header.ftl deleted file mode 100644 index 50b72ae8d0..0000000000 --- a/jpa/docs/userguide/src/main/jbake/templates/header.ftl +++ /dev/null @@ -1,54 +0,0 @@ - -<#-- a header template fragment included in the page template --> - - - - <#if (content.title)??><#escape x as x?xml>${content.title}</#escape></#if> - - - - - - - - - -
- ${content.title}
-
-
- - - - - - - - - <#if content.prev??> - - - - <#if content.next??> - - - - - -
- - - Previous - - - - - Next - - - - - Contents - -
- diff --git a/jpa/docs/userguide/src/main/jbake/templates/menu.ftl b/jpa/docs/userguide/src/main/jbake/templates/menu.ftl deleted file mode 100644 index 888c03dcff..0000000000 --- a/jpa/docs/userguide/src/main/jbake/templates/menu.ftl +++ /dev/null @@ -1 +0,0 @@ -<#-- a menu bar template fragment included in the page template --> \ No newline at end of file diff --git a/jpa/docs/userguide/src/main/jbake/templates/page.ftl b/jpa/docs/userguide/src/main/jbake/templates/page.ftl deleted file mode 100644 index eca51db35d..0000000000 --- a/jpa/docs/userguide/src/main/jbake/templates/page.ftl +++ /dev/null @@ -1,8 +0,0 @@ -<#-- a top level page layout template --> - -<#include "header.ftl"> -<#include "menu.ftl"> - -${content.body} - -<#include "footer.ftl"> \ No newline at end of file diff --git a/jpa/docs/userguide/src/theme/jakartaee-theme.yml b/jpa/docs/userguide/src/theme/jakartaee-theme.yml deleted file mode 100644 index 6092a2f5c9..0000000000 --- a/jpa/docs/userguide/src/theme/jakartaee-theme.yml +++ /dev/null @@ -1,299 +0,0 @@ -# -# Following is the asciidoctor-pdf default theme [1], with small -# customizations, mostly for header and footer, marked "EE". -# -# [1] https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml -# -font: - catalog: - # Noto Serif supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols - Noto Serif: - normal: notoserif-regular-subset.ttf - bold: notoserif-bold-subset.ttf - italic: notoserif-italic-subset.ttf - bold_italic: notoserif-bold_italic-subset.ttf - # M+ 1mn supports ASCII and the circled numbers used for conums - M+ 1mn: - normal: mplus1mn-regular-ascii-conums.ttf - bold: mplus1mn-bold-ascii.ttf - italic: mplus1mn-italic-ascii.ttf - bold_italic: mplus1mn-bold_italic-ascii.ttf - # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols - # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font - M+ 1p Fallback: - normal: mplus1p-regular-fallback.ttf - bold: mplus1p-regular-fallback.ttf - italic: mplus1p-regular-fallback.ttf - bold_italic: mplus1p-regular-fallback.ttf - fallbacks: - - M+ 1p Fallback -page: - background_color: ffffff - layout: portrait - margin: [0.5in, 0.67in, 0.67in, 0.67in] - # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress - margin_inner: 0.75in - margin_outer: 0.59in - #size: A4 # EE - size: Letter # EE -base: - align: justify - # color as hex string (leading # is optional) - font_color: 333333 - # color as RGB array - #font_color: [51, 51, 51] - # color as CMYK array (approximated) - #font_color: [0, 0, 0, 0.92] - #font_color: [0, 0, 0, 92%] - font_family: Noto Serif - # choose one of these font_size/line_height_length combinations - #font_size: 14 - #line_height_length: 20 - #font_size: 11.25 - #line_height_length: 18 - #font_size: 11.2 - #line_height_length: 16 - font_size: 10.5 - #line_height_length: 15 - # correct line height for Noto Serif metrics - line_height_length: 12 - #font_size: 11.25 - #line_height_length: 18 - line_height: $base_line_height_length / $base_font_size - font_size_large: round($base_font_size * 1.25) - font_size_small: round($base_font_size * 0.85) - font_size_min: $base_font_size * 0.75 - font_style: normal - border_color: eeeeee - border_radius: 4 - border_width: 0.5 -# FIXME vertical_rhythm is weird; we should think in terms of ems -#vertical_rhythm: $base_line_height_length * 2 / 3 -# correct line height for Noto Serif metrics (comes with built-in line height) -vertical_rhythm: $base_line_height_length -horizontal_rhythm: $base_line_height_length -# QUESTION should vertical_spacing be block_spacing instead? -vertical_spacing: $vertical_rhythm -link: - font_color: 428bca -# literal is currently used for inline monospaced in prose and table cells -literal: - font_color: b12146 - font_family: M+ 1mn -menu_caret_content: " \u203a " -heading: - align: left - #font_color: 181818 - font_color: $base_font_color - font_family: $base_font_family - font_style: bold - # h1 is used for part titles (book doctype) or the doctitle (article doctype) - #h1_font_size: floor($base_font_size * 2.6) # EE - h1_font_size: floor($base_font_size * 2.5) # EE, squeeze title onto one line - # h2 is used for chapter titles (book doctype only) - h2_font_size: floor($base_font_size * 2.15) - h3_font_size: round($base_font_size * 1.7) - h4_font_size: $base_font_size_large - h5_font_size: $base_font_size - h6_font_size: $base_font_size_small - #line_height: 1.4 - # correct line height for Noto Serif metrics (comes with built-in line height) - line_height: 1 - margin_top: $vertical_rhythm * 0.4 - margin_bottom: $vertical_rhythm * 0.9 -title_page: - align: right - logo: - top: 10% - title: - top: 55% - font_size: $heading_h1_font_size - font_color: 999999 - line_height: 0.9 - subtitle: - font_size: $heading_h3_font_size - font_style: bold_italic - line_height: 1 - authors: - margin_top: $base_font_size * 1.25 - font_size: $base_font_size_large - font_color: 181818 - revision: - margin_top: $base_font_size * 1.25 -block: - margin_top: 0 - margin_bottom: $vertical_rhythm -caption: - align: left - font_size: $base_font_size * 0.95 - font_style: italic - # FIXME perhaps set line_height instead of / in addition to margins? - margin_inside: $vertical_rhythm / 3 - #margin_inside: $vertical_rhythm / 4 - margin_outside: 0 -lead: - font_size: $base_font_size_large - line_height: 1.4 -abstract: - font_color: 5c6266 - font_size: $lead_font_size - line_height: $lead_line_height - font_style: italic - first_line_font_style: bold - title: - align: center - font_color: $heading_font_color - font_family: $heading_font_family - font_size: $heading_h4_font_size - font_style: $heading_font_style -admonition: - column_rule_color: $base_border_color - column_rule_width: $base_border_width - padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] - #icon: - # tip: - # name: fa-lightbulb-o - # stroke_color: 111111 - # size: 24 - label: - text_transform: uppercase - font_style: bold -blockquote: - font_color: $base_font_color - font_size: $base_font_size_large - border_color: $base_border_color - border_width: 5 - # FIXME disable negative padding bottom once margin collapsing is implemented - padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2] - cite_font_size: $base_font_size_small - cite_font_color: 999999 -# code is used for source blocks (perhaps change to source or listing?) -code: - font_color: $base_font_color - font_family: $literal_font_family - font_size: ceil($base_font_size) - padding: $code_font_size - line_height: 1.25 - # line_gap is an experimental property to control how a background color is applied to an inline block element - line_gap: 3.8 - background_color: f5f5f5 - border_color: cccccc - border_radius: $base_border_radius - border_width: 0.75 -conum: - font_family: M+ 1mn - font_color: $literal_font_color - font_size: $base_font_size - line_height: 4 / 3 -example: - border_color: $base_border_color - border_radius: $base_border_radius - border_width: 0.75 - background_color: ffffff - # FIXME reenable padding bottom once margin collapsing is implemented - padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm] -image: - align: left -prose: - margin_top: $block_margin_top - margin_bottom: $block_margin_bottom -sidebar: - background_color: eeeeee - border_color: e1e1e1 - border_radius: $base_border_radius - border_width: $base_border_width - # FIXME reenable padding bottom once margin collapsing is implemented - padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25] - title: - align: center - font_color: $heading_font_color - font_family: $heading_font_family - font_size: $heading_h4_font_size - font_style: $heading_font_style -thematic_break: - border_color: $base_border_color - border_style: solid - border_width: $base_border_width - margin_top: $vertical_rhythm * 0.5 - margin_bottom: $vertical_rhythm * 1.5 -description_list: - term_font_style: bold - term_spacing: $vertical_rhythm / 4 - description_indent: $horizontal_rhythm * 1.25 -outline_list: - indent: $horizontal_rhythm * 1.5 - #marker_font_color: 404040 - # NOTE outline_list_item_spacing applies to list items that do not have complex content - item_spacing: $vertical_rhythm / 2 -table: - background_color: $page_background_color - #head_background_color: - #head_font_color: $base_font_color - head_font_style: bold - #body_background_color: - body_stripe_background_color: f9f9f9 - foot_background_color: f0f0f0 - border_color: dddddd - border_width: $base_border_width - cell_padding: 3 -toc: - indent: $horizontal_rhythm - line_height: 1.4 - dot_leader: - #content: ". " - font_color: a9a9a9 - #levels: 2 3 -# NOTE in addition to footer, header is also supported -footer: - font_size: $base_font_size_small - # NOTE if background_color is set, background and border will span width of page - #border_color: dddddd # EE - #border_width: 0.25 # EE - height: $base_line_height_length * 2.5 - line_height: 1 - padding: [$base_line_height_length / 2, 1, 0, 1] - vertical_align: top - #image_vertical_align: or - # additional attributes for content: - # * {page-count} - # * {page-number} - # * {document-title} - # * {document-subtitle} - # * {chapter-title} - # * {section-title} - # * {section-or-chapter-title} - recto: - #columns: "<50% =0% >50%" - right: - #content: '{page-number}' # EE - #content: '{section-or-chapter-title} | {page-number}' - #content: '{document-title} | {page-number}' - content: '{document-title}{nbsp}{nbsp}{nbsp} *{page-number}*' # EE - #center: - # content: '{page-number}' - left: # EE - content: '{status}' # EE - verso: - #columns: $footer_recto_columns - left: - #content: $footer_recto_right_content # EE - #content: '{page-number} | {chapter-title}' - content: '*{page-number}* {nbsp}{nbsp}{nbsp}{document-title}' # EE - #center: - # content: '{page-number}' - right: # EE - content: '{status}' # EE -header: # EE - font_size: $base_font_size_small # EE - border_color: dddddd # EE - border_width: 0.25 # EE - height: $base_line_height_length * 2.5 # EE - line_height: 1 # EE - padding: [$base_line_height_length / 2, 1, 0, 1] # EE - vertical_align: top # EE - recto: # EE - right: # EE - content: '{section-or-chapter-title}' # EE - verso: # EE - left: # EE - content: '{section-or-chapter-title}' # EE diff --git a/user_guides/jpa/README.md b/user_guides/jpa/README.md deleted file mode 100644 index a3ec2b697b..0000000000 --- a/user_guides/jpa/README.md +++ /dev/null @@ -1,77 +0,0 @@ -# A JBake project template - -## About JBake - -JBake is a static site generator, it's inspired from jekyll and written -in java. The basic idea is to have templates for the structure of the -page, and the body generated from asciidoc content. - -## Pre requisites - -- Maven -- JDK8+ - -Deploying to Github will require password less authentication. - -This is done by exporting your SSH public key into your Github account. - -## Build the site locally - -The site is generated under target/staging. - -Open file:///PATH_TO_PROJECT_DIR/target/staging in a browser to view the site. - -``` -mvn generate-resources -``` - -Or you can invoke the JBake plugin directly. - -``` -mvn jbake:build -``` - -### Rebuild the site on changes - -``` -mvn jbake:watch -``` - -If you keep this command running, changes to the sources will be -detected and the site will be rendered incrementally. - -This is convenient when writing content. - -### Serve the site locally - -``` -mvn jbake:serve -``` - -If a webserver is required (e.g. absolute path are used), this command -will start a webserver (jetty) at http://localhost:8820. It will also -watch for changes and rebuild incrementally. - -## Deploy the site to Github Pages - -``` -mvn deploy -``` - -## Produce a zip file for download - -To produce a zip file containing the generated html files, use: - -``` -mvn package -``` - -When making a release on GitHub, this zip file should be added to the release. - -## Links - -- [JBake maven plugin documentation](https://github.com/Blazebit/jbake-maven-plugin) -- [JBake documentation](http://jbake.org/docs/2.5.1) -- [Freemarker documentation](http://freemarker.org/docs) -- [AsciiDoc User Guide](http://asciidoc.org/userguide.html) -- [Asciidoctor quick reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference) diff --git a/user_guides/jpa/pom.xml b/user_guides/jpa/pom.xml deleted file mode 100644 index 79080da643..0000000000 --- a/user_guides/jpa/pom.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - 4.0.0 - - - jakarta.tck - jakarta.tck.user-guide - 11.0.0-SNAPSHOT - ../parent/pom.xml - - - jakarta.persistence - jakarta.persistence-tck-user-guide - pom - 3.2.0-SNAPSHOT - Eclipse Foundation Technology Compatibility Kit User's Guide for Jakarta Persistence for Jakarta EE, Release 3.2 ${project.version} - - - ${project.parent.version} - - Persistence - - DRAFT - - - - - scm:git:git@github.com:eclipse-ee4j/jakartaee-tck.git - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - build-dist - package - - - - - org.glassfish.doc - glassfish-doc-maven-plugin - - - generate-toc - generate-sources - - - generate-book - generate-sources - - - - - org.jbake - jbake-maven-plugin - - - build-site - generate-resources - - - - - org.asciidoctor - asciidoctor-maven-plugin - - - generate-pdf-doc - generate-resources - - - - - - diff --git a/user_guides/jpa/src/main/jbake/assets/README.md b/user_guides/jpa/src/main/jbake/assets/README.md deleted file mode 100644 index f8f962c0ab..0000000000 --- a/user_guides/jpa/src/main/jbake/assets/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# About - -The {{site.title}} project contains the [AsciiDoc](http://asciidoc.org/) -source code for the ... diff --git a/user_guides/jpa/src/main/jbake/assets/_config.yml b/user_guides/jpa/src/main/jbake/assets/_config.yml deleted file mode 100644 index 44e4462596..0000000000 --- a/user_guides/jpa/src/main/jbake/assets/_config.yml +++ /dev/null @@ -1,14 +0,0 @@ -remote_theme: jakartaee/jekyll-theme-jakarta-ee - -title: [tck_jpa_v3_1] -description: [Jakarta EE Persistence API Technology Compatibility Kit User's Guide, Release 3.1] - -# sidebar links url -links: - source: https://github.com/eclipse-ee4j/jakartaee-tck - download: https://jakarta.ee/specifications/persistence/3.1/ - #mailinglist: https://javaee.groups.io/g/tck_jpa_v2_2 - javadocs: https://jakarta.ee/specifications/persistence/3.1/ - docs: https://jakarta.ee/specifications/persistence/3.1/ - #faq: - diff --git a/user_guides/jpa/src/main/jbake/content/README b/user_guides/jpa/src/main/jbake/content/README deleted file mode 100644 index 05fa2c27fd..0000000000 --- a/user_guides/jpa/src/main/jbake/content/README +++ /dev/null @@ -1,77 +0,0 @@ -The file attributes.conf defines several attributes (variables) that -need to be customized for each technology. - -The *.adoc files should not be modified. - -The following "include" files should be customized as necessary -for the specific technology: - -- rules.inc - - Additional compatibility rules needed by some technologies. - The rules in rules.adoc should NOT be changed. - -- defns.inc - - Additional definitions needed by additional compatibility - rules in rules.inc. - -- config.inc - - Detailed instructions for configuring the TCK, included in - Chapter 4. Unfortunately, these are sections 4.1 - 4.3, - so even if the TCK doesn't require 3 sections you need to - make up something, or else change the sections to "N/A". - -- packages.inc - - A simple list of Jakarta EE package names for the technology. - -- tck-packages.inc - - A list of additional software packages included in the TCK. - -- req-software.inc - - A list of software required in addition to the TCK and CI. - -- install-server.inc - - Steps to install the Jakarta EE CI, if needed. - For standalone technologies, no server may be required, - and this file can be empty. - This is used in install.adoc in section 3.2. - -- install-server-vi.inc - - Steps to install a Vendor's web server, if needed. - For standalone technologies, no web server may be required, - and this file can be empty. - This is used in install.adoc in section 3.2. - -- using-examples.inc - - Command line examples showing how to run the TCK. - -- using.inc - - Optional additional instructions for running the TCK. - -- debug-tips.inc - - Technology-specific troubleshooting tips for Chapter 6. - If this isn't needed, it can be an empty file, but toc.adoc - will need to be fixed. - -- rebuild.inc - - Special instructions for rebuilding the WAR files used by some TCKs. - If needed, customize it appropriately and define the "rebuild" - attribute in attributes.conf. - -- title.inc - Add acronym references as required do distinguish between legacy and - current APIs. - -Note that this template is NOT sufficient for the Jakarta EE platform -or Jakarta EE Web Profile. diff --git a/user_guides/jpa/src/main/jbake/content/attributes.conf b/user_guides/jpa/src/main/jbake/content/attributes.conf deleted file mode 100644 index ad60ec5677..0000000000 --- a/user_guides/jpa/src/main/jbake/content/attributes.conf +++ /dev/null @@ -1,37 +0,0 @@ -:TechnologyFullName: Jakarta Persistence -:TechnologyShortName: Persistence -:LegacyAcronym: JPA -:ReleaseDate: March 2022 -:CopyrightDates: 2017, 2022 -:TechnologyVersion: 3.1 -:TechnologyRI: EclipseLink 3.1 -:TechnologyRIURL: https://projects.eclipse.org/projects/ee4j.eclipselink -:SpecificationURL: https://jakarta.ee/specifications/persistence/3.1/ -:TCKInquiryList: mailto:jakartaee-tck-dev@eclipse.org[jakartaee-tck-dev@eclipse.org] -:SpecificationInquiryList: mailto:jpa-dev@eclipse.org[jpa-dev@eclipse.org] -:techID: Persistence -// Define this attribute (uncomment it) if the TCK includes no API tests. (Rare.) -// :no-api-tests: -// Define this attribute (uncomment it) if the TCK includes end-to-end tests. -// :end-to-end-tests: -// Define this attribute (uncomment it) if subsets of the API are allowed. -// (Common Annotations only) -// :subset-allowed: -// -// The environment variable used to specify the home directory -// for the technology. Used in config.inc. -:TechnologyHomeEnv: ECLIPSELINK_HOME -// Java SE version required. -:SEversion: 11 or 17 -:AntVersion: 1.10.0+ -:JakartaEEVersion: 10 -:JavaTestVersion: 5.0 -:jteFileName: /bin/ts.jte -:jtxFileName: /bin/ts.jtx -:TCKPackageName: jakarta-persistence-tck-3.1.0.zip -// Directory names used in examples in using.adoc. -:sigTestDirectoryExample: /src/com/sun/ts/tests/signaturetest/jpa -:singleTestDirectoryExample: /src/com/sun/ts/tests/jpa/core -:subsetTestDirectoryExample: /src/com/sun/ts/tests/jpa/se -// Define this attribute (uncomment it) if the TCK needs the rebuild appendix. -// :rebuild: diff --git a/user_guides/jpa/src/main/jbake/content/config.adoc b/user_guides/jpa/src/main/jbake/content/config.adoc deleted file mode 100644 index 0a78d706e3..0000000000 --- a/user_guides/jpa/src/main/jbake/content/config.adoc +++ /dev/null @@ -1,353 +0,0 @@ -type=page -status=published -title=Setup and Configuration -next=using.html -prev=install.html -~~~~~~ -include::attributes.conf[] -Setup and Configuration -======================= - -[[GBFVV]] - - - -[[setup-and-configuration]] -4 Setup and Configuration -------------------------- - - -[NOTE] -==== -The Jakarta EE Specification process provides for any number of compatible implementations. -As additional implementations become available, refer to project or product documentation from -those vendors for specific TCK setup and operational guidance. - -==== - -This chapter describes how to set up the {TechnologyShortName} TCK and -JavaTest harness software. Before proceeding with the instructions in -this chapter, be sure to install all required software, as described in -link:install.html#GBFTP[Chapter 3, "Installation."] - -After completing the instructions in this chapter, proceed to -link:using.html#GBFWO[Chapter 5, "Executing Tests,"] for instructions on -running the {TechnologyShortName} TCK. - -include::config.inc[] - -[[GHGDH]][[custom-configuration-handlers]] - -4.4 Custom Configuration Handlers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Configuration handlers are used to configure and unconfigure a -{TechnologyShortName} {TechnologyVersion} implementation during the -certification process. These are similar to deployment handlers but -used for configuration. A configuration handler is an Ant build file -that contains at least the required targets listed below: - - * `config.vi` - to configure the vendor implementation - * `clean.vi` - to unconfigure the vendor implementation - -These targets are called from the `/bin/build.xml` file and -call down into the implementation-specific configuration handlers. - -To provide your own configuration handler, create a config.vi.xml file -with the necessary configuration steps for your implementation and place -the file under the `/bin/xml/impl/` directory. - -For more information, you may wish to view `/bin/xml/impl/glassfish/config.vi.xml`, -the configuration file for Jakarta EE {JakartaEEVersion} Compatible Implementation, Eclipse GlassFish. - -[[GBFWE]][[custom-deployment-handlers]] - -4.5 Custom Deployment Handlers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Deployment handlers are used to deploy and undeploy the WAR files that -contain the tests to be run during the certification process. A deployment -handler is an Ant build file that contains at least the required targets -listed in the table below. - -The {TechnologyShortName} TCK provides these deployment handlers: - -* `/bin/xml/impl/none/deploy.xml` -* `/bin/xml/impl/glassfish/deploy.xml` -* `/bin/xml/impl/tomcat/deploy.xml` - -The `deploy.xml` files in each of these directories are used to control -deployment to a specific container (no deployment, deployment to -the Eclipse GlassFish Web container, deployment to the Tomcat Web container) -denoted by the name of the directory in which each `deploy.xml` file -resides. The primary `build.xml` file in the `/bin` directory -has a target to invoke any of the required targets (`-deploy`, `-undeploy`, -`-deploy.all`, `-undeploy.all`). - -[[GBFWF]][[create-custom-deployment-handler]] - -4.5.1 To Create a Custom Deployment Handler -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To deploy tests to another {TechnologyShortName} implementation, you -must create a custom handler. - -1. Create a new directory in the `/bin/xml/impl` directory tree. - For example, create the `/bin/xml/impl/my_deployment_handler` directory. - Replace my_deployment_handler with the value of the impl.vi - property that you set in Step 5 of the configuration procedure - described in Section 4.2, "Configuring Your Environment to Repackage - and Run the TCK Against the Vendor Implementation". - -2. Copy the deploy.xml file from the `/bin/xml/impl/none` - directory to the directory that you created. - -3. Modify the required targets in the `deploy.xml` file. This is what - the `deploy.xml` file for the "none" deployment handler looks like. - -+ -[source,oac_no_warn] ----- - - - - - - - - - - - - - - - ----- -+ -Although this example just echoes messages, it does include the four -required Ant targets (`-deploy`, `-undeploy`, `-deploy.all`, `-undeploy.all`) -that your custom `deploy.xml` file must contain. With this as your -starting point, look at the required targets in the `deploy.xml` files -in the Tomcat and Eclipse Glassfish directories for guidance as you create -the same targets for the Web container in which you will run your -implementation of {TechnologyShortName}. - -The following Ant targets can be called from anywhere under the -`/src` directory: - -* `deploy` -* `undeploy` -* `deploy.all` -* `undeploy.all` - -The `deploy.all` and `undeploy.all` targets can also be called from the -`/bin` directory. - -[NOTE] -======================================================================= -The targets in the `deploy.xml` file are never called directly. -They are called indirectly by the targets listed above. -======================================================================= - -[[GBFUY]][[using-the-javatest-harness-software]] - -4.6 Using the JavaTest Harness Software -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -There are two general ways to run the {TechnologyShortName} TCK test -suite using the JavaTest harness software: - -* Through the JavaTest GUI; if using this method, please continue on to -link:#GBFWG[Section 4.7, "Using the JavaTest Harness Configuration -GUI."] -* In JavaTest batch mode, from the command line in your shell -environment; if using this method, please proceed directly to -link:using.html#GBFWO[Chapter 5, "Executing Tests."] - -[[GBFWG]][[using-the-javatest-harness-configuration-gui]] - -4.7 Using the JavaTest Harness Configuration GUI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can use the JavaTest harness GUI to modify general test settings and -to quickly get started with the default {TechnologyShortName} TCK test -environment. This section covers the following topics: - -* link:#GBFVA[Configuration GUI Overview] -* link:#GBFVD[Starting the Configuration GUI] -* link:#GBFVX[To Configure the JavaTest Harness to Run the -{TechnologyShortName} TCK Tests] -* link:#GBFUU[Modifying the Default Test Configuration] - - -[NOTE] -======================================================================= - -It is only necessary to proceed with this section if you want to run the -JavaTest harness in GUI mode. If you plan to run the JavaTest harness in -command-line mode, skip the remainder of this chapter, and continue with -link:using.html#GBFWO[Chapter 5, "Executing Tests."] - -======================================================================= - - -[[GBFVA]][[configuration-gui-overview]] - -4.7.1 Configuration GUI Overview -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In order for the JavaTest harness to execute the test suite, it requires -information about how your computing environment is configured. The -JavaTest harness requires two types of configuration information: - -* Test environment: This is data used by the tests. For example, the -path to the Java runtime, how to start the product being tested, network -resources, and other information required by the tests in order to run. -This information does not change frequently and usually stays constant -from test run to test run. -* Test parameters: This is information used by the JavaTest harness to -run the tests. Test parameters are values used by the JavaTest harness -that determine which tests in the test suite are run, how the tests -should be run, and where the test reports are stored. This information -often changes from test run to test run. - -The first time you run the JavaTest harness software, you are asked to -specify the test suite and work directory that you want to use. (These -parameters can be changed later from within the JavaTest harness GUI.) - -Once the JavaTest harness GUI is displayed, whenever you choose Start, -then Run Tests to begin a test run, the JavaTest harness determines -whether all of the required configuration information has been supplied: - -* If the test environment and parameters have been completely -configured, the test run starts immediately. -* If any required configuration information is missing, the -configuration editor displays a series of questions asking you the -necessary information. This is called the configuration interview. When -you have entered the configuration data, you are asked if you wish to -proceed with running the test. - -[[GBFVD]][[starting-the-configuration-gui]] - -4.7.2 Starting the Configuration GUI -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Before you start the JavaTest harness software, you must have a valid -test suite and Java SE {SEversion} installed on your system. - -The {TechnologyShortName} TCK includes an Ant script that is used to execute the -JavaTest harness from the `` directory. Using this Ant script -to start the JavaTest harness is part of the procedure described in -link:#GBFVX[Section 4.7.3, "To Configure the JavaTest Harness to Run the -TCK Tests."] - -When you execute the JavaTest harness software for the first time, the -JavaTest harness displays a Welcome dialog box that guides you through -the initial startup configuration. - -* If it is able to open a test suite, the JavaTest harness displays a -Welcome to JavaTest dialog box that guides you through the process of -either opening an existing work directory or creating a new work -directory as described in the JavaTest online help. -* If the JavaTest harness is unable to open a test suite, it displays a -Welcome to JavaTest dialog box that guides you through the process of -opening both a test suite and a work directory as described in the -JavaTest documentation. - -After you specify a work directory, you can use the Test Manager to -configure and run tests as described in link:#GBFVX[Section 4.7.3, "To -Configure the JavaTest Harness to Run the TCK Tests."] - -[[GBFVX]][[to-configure-the-javatest-harness-to-run-the-tck-tests]] - -4.7.3 To Configure the JavaTest Harness to Run the TCK Tests -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The answers you give to some of the configuration interview questions -are specific to your site. For example, the name of the host on which -the JavaTest harness is running. Other configuration parameters can be -set however you wish. For example, where you want test report files to -be stored. - -Note that you only need to complete all these steps the first time you -start the JavaTest test harness. After you complete these steps, you can -either run all of the tests by completing the steps in -link:using.html#GBFUZ[Section 5.1, "Starting JavaTest,"] or run a subset -of the tests by completing the steps in link:using.html#GBFWM[Section -5.2, "Running a Subset of the Tests."] - -1. Change to the `/bin` directory and start the JavaTest test -harness: + -`cd /bin` + -`ant gui` -2. From the File menu, click *Open Quick Start Wizard*. + -The Welcome screen displays. -3. Select *Start a new test run*, and then click *Next*. + -You are prompted to create a new configuration or use a configuration -template. -4. Select *Create a new configuration*, and then click *Next*. + -You are prompted to select a test suite. -5. Accept the default suite (`/src`), and then click *Next*. + -You are prompted to specify a work directory to use to store your test -results. -6. Type a work directory name or use the *Browse* button to select a work -directory, and then click *Next*. + -You are prompted to start the configuration editor or start a test run. -At this point, the {TechnologyShortName} TCK is configured to run the -default test suite. -7. Deselect the *Start the configuration editor* option, and then click -*Finish*. -8. Click *Run Tests*, then click *Start*. + -The JavaTest harness starts running the tests. -9. To reconfigure the JavaTest test harness, do one of the following: -* Click *Configuration*, then click *New Configuration*. -* Click *Configuration*, then click *Change Configuration*. -10. Click *Report*, and then click *Create Report*. -11. Specify the directory in which the JavaTest test harness will write -the report, and then click *OK*. + -A report is created, and you are asked whether you want to view it. -12. Click *Yes* to view the report. - -[[GBFUU]][[modifying-the-default-test-configuration]] - -4.7.4 Modifying the Default Test Configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The JavaTest GUI enables you to configure numerous test options. These -options are divided into two general dialog box groups: - -* Group 1: Available from the JavaTest *Configure/Change Configuration* -submenus, the following options are displayed in a tabbed dialog box: - -** *Tests to Run* - -** *Exclude List* - -** *Keywords* - -** *Prior Status* - -** *Test Environment* - -** *Concurrency* - -** *Timeout Factor* -* Group 2: Available from the JavaTest *Configure/Change -Configuration/Other Values* submenu, or by pressing `Ctrl+E`, the following -options are displayed in a paged dialog box: - -** *Environment Files* - -** *Test Environment* - -** *Specify Tests to Run* - -** *Specify an Exclude List* - -Note that there is some overlap between the functions in these two -dialog boxes; for those functions use the dialog box that is most -convenient for you. Please refer to the JavaTest Harness documentation -or the online help for complete information about these various options. - - diff --git a/user_guides/jpa/src/main/jbake/content/config.inc b/user_guides/jpa/src/main/jbake/content/config.inc deleted file mode 100644 index 221a10428d..0000000000 --- a/user_guides/jpa/src/main/jbake/content/config.inc +++ /dev/null @@ -1,183 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -The following sections should be customized for the technology. -This text was originally from the JAX-RS TCK. Most references -to JAX-RS have been parameterized to serve as a simple starting -point for customization. There are still many details that will -need to be changed or removed. The major sections 4.1, 4.2, and -4.3 should be preserved. If their titles are changed, the links -at the top of config.adoc will need to be changed as well as well -as toc.adoc. -/////////////////////////////////////////////////////////////////////// - -[[GBFVU]][[configuring-your-environment-to-run-the-tck-against-the-reference-implementation]] - -4.1 Configuring Your Environment to Run the TCK Against the Compatible Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -After configuring your environment as described in this section, -continue with the instructions in link:#GBFUY[Section 4.6, "Using the -JavaTest Harness Software."] - - -[NOTE] -======================================================================= - -In these instructions, variables in angle brackets need to be expanded -for each platform. For example, `` becomes `$TS_HOME` on -Solaris/Linux and `%TS_HOME%` on Windows. In addition, the forward -slashes (`/`) used in all of the examples need to be replaced with -backslashes (`\`) for Windows. Finally, be sure to use the appropriate -separator for your operating system when specifying multiple path -entries (`;` on Windows, `:` on UNIX/Linux). - -On Windows, you must escape any backslashes with an extra backslash in -path separators used in any of the following properties, or use forward -slashes as a path separator instead. - -======================================================================= - - -1. Set the following environment variables in your shell environment: - a. `JAVA_HOME` to the directory in which Java SE 8 is installed - b. `TS_HOME` to the directory in which the {TechnologyShortName} TCK - {TechnologyVersion} software is installed - c. `PATH` to include the following directories: `JAVA_HOME/bin`, - +{TechnologyHomeEnv}/bin+, and `ANT_HOME/bin` -2. Copy /bin/ts.jte.jdk11 as /bin/ts.jte if JAVA_HOME is Java SE 11. -Edit your `/bin/ts.jte` file and set the following -environment variables: - a. Set `jpa.classes` to include all of the necessary JAR files that - pertain to your implementation. - b. Set `jdbc.lib.classpath` to the location where the JDBC drivers are - installed. - c. Set `jdbc.db` to the name of the database under test. Valid values - include: -+ --- -[source,oac_no_warn] ----- -derby -mysql -sybase -db2 -mssqlserver -oracle -postgresql ----- --- -+ - d. Set `jakarta.persistence.provider`, `jakarta.persistence.jdbc.driver`, - `jakarta.persistence.jdbc.url`, `jakarta.persistence.jdbc.user`, and - `jakarta.persistence.jdbc.password` to the appropriate values for the - database and persistence provider under test. + - These properties are passed to the Persistence provider during the - creation of the `EntityManagerFactory`. Any additional values, for - example setting an implementation's logging level, must be set by - following the instructions in Step 2e. - e. Set the `jpa.provider.implementation.specific.properties` property - to include any implementation-specific settings that need to be passed - to the provider when the `EntityManagerFactory` is created. - f. Set `sigTestClasspath` to include any additional classes not - specified with the `jpa.classes` property. - g. Set `work.dir` to the default directory in which JavaTest writes - temporary files that are created during test execution. The default - location is /tmp/JTwork. + - This property is required for the TCK Ant targets. - h. Set `report.dir` to the default directory in which JavaTest creates - a test report for the most recent test run. The default location is - /tmp/JTreport. + - This property is a required property for the TCK Ant targets; it must be - set. To disable reporting, set the `report.dir` property to `"none"`. - i. Set db.supports.sequence to false if the database does not support - the use of SEQUENCE. + - The default value is true. - j. Set `persistence.second.level.caching.supported` to false if your - persistence provider does not support second level caching. + - The default value is true. -+ -3. If you are using MySQL or MS SQL Server, do the following: - a. If you are using MySQL, see link:#GJLIB[Section 4.3.1, "Setup - Considerations for MySQL,"] and proceed to Step 4. - b. If you are using MS SQL Server, see link:#GJLHU[Section 4.3.2, "Setup - Considerations for MS SQL Server,"] and proceed to Step 4. -+ -4. Start the database under test. -5. Initialize the database under test. + -The `init.database` target initializes the database tables. + -Change to the `/bin` directory and execute the following -command: -+ --- -[source,oac_no_warn] ----- -ant -f initdb.xml ----- --- - - -[[GCLHU]][[configuring-your-environment-to-repackage-and-run-the-tck-against-the-vendor-implementation]] - -4.2 Configuring Your Environment to Repackage and Run the TCK Against the Vendor Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -After configuring your environment as described in this section, -continue with the instructions in link:#GBFUY[Section 4.4, "Using the -JavaTest Harness Software."] - - -[NOTE] -======================================================================= - -In these instructions, variables in angle brackets need to be expanded -for each platform. For example, `` becomes `$TS_HOME` on -Solaris/Linux and `%TS_HOME%` on Windows. In addition, the forward -slashes (`/`) used in all of the examples need to be replaced with -backslashes (`\`) for Windows. Finally, be sure to use the appropriate -separator for your operating system when specifying multiple path -entries (`;` on Windows, `:` on UNIX/Linux). - -On Windows, you must escape any backslashes with an extra backslash in -path separators used in any of the following properties, or use forward -slashes as a path separator instead. - -======================================================================= - -Adapt the instructions above as appropriate for your implementation. - - -[[GHGDG]][[setup-considerations]] - -4.3 Setup Considerations -~~~~~~~~~~~~~~~~~~~~~~~~ - - -[[GJLIB]][[setup-considerations-for-mysql]] - -=== 4.3.1 Setup Considerations for MySQL - -The {TechnologyFullName} tests require delimited identifiers for -the native query tests. If you are using delimited identifiers on MySQL, -modify the `sql-mode` setting in the `my.cnf` file to set the -ANSI_QUOTES option. After setting this option, reboot the MySQL server. -Set the option as shown in this example: - -[source,oac_no_warn] ----- -sql-mode= - "STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION,ANSI_QUOTES" ----- - -[[GJLHU]][[setup-considerations-for-ms-sql-server]] - -=== 4.3.2 Setup Considerations for MS SQL Server - -If your database already exists and if you use a case-sensitive -collation on MS SQL Server, execute the following command to modify the -database and avert errors caused by case-sensitive collation: - -[source,oac_no_warn] ----- -ALTER DATABASE ctsdb COLLATE Latin1_General_CS_AS ; ----- - diff --git a/user_guides/jpa/src/main/jbake/content/debug-tips.inc b/user_guides/jpa/src/main/jbake/content/debug-tips.inc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/user_guides/jpa/src/main/jbake/content/debug.adoc b/user_guides/jpa/src/main/jbake/content/debug.adoc deleted file mode 100644 index 5208c401a6..0000000000 --- a/user_guides/jpa/src/main/jbake/content/debug.adoc +++ /dev/null @@ -1,174 +0,0 @@ -type=page -status=published -title=Debugging Test Problems -next=faq.html -prev=using.html -~~~~~~ -include::attributes.conf[] -Debugging Test Problems -======================= - -[[GBFUV]] - - -[[debugging-test-problems]] -6 Debugging Test Problems -------------------------- - -There are a number of reasons that tests can fail to execute properly. -This chapter provides some approaches for dealing with these failures. -Please note that most of these suggestions are only relevant when -running the test harness in GUI mode. - -This chapter includes the following topics: - -* link:#GBFYP[Overview] -* link:#GBFVF[Test Tree] -* link:#GBFWI[Folder Information] -* link:#GBFVP[Test Information] -* link:#GBFVZ[Report Files] -* link:#GBFYF[Configuration Failures] - -[[GBFYP]][[overview]] - -6.1 Overview -~~~~~~~~~~~~ - -The goal of a test run is for all tests in the test suite that are not -filtered out to have passing results. If the root test suite folder -contains tests with errors or failing results, you must troubleshoot and -correct the cause to satisfactorily complete the test run. - -* Errors: Tests with errors could not be executed by the JavaTest -harness. These errors usually occur because the test environment is not -properly configured. -* Failures: Tests that fail were executed but had failing results. - -The Test Manager GUI provides you with a number of tools for effectively -troubleshooting a test run. See the JavaTest User's Guide and JavaTest -online help for detailed descriptions of the tools described in this -chapter. Ant test execution tasks provide command-line users with -immediate test execution feedback to the display. Available JTR report -files and log files can also help command-line users troubleshoot test -run problems. - -For every test run, the JavaTest harness creates a set of report files -in the reports directory, which you specified by setting the -`report.dir` property in the +{jteFileName}+ file. The report files contain -information about the test description, environment, messages, -properties used by the test, status of the test, and test result. After -a test run is completed, the JavaTest harness writes HTML reports for -the test run. You can view these files in the JavaTest ReportBrowser -when running in GUI mode, or in the Web browser of your choice outside -the JavaTest interface. To see all of the HTML report files, enter the -URL of the `report.html` file. This file is the root file that links to -all of the other HTML reports. - -The JavaTest harness also creates a `summary.txt` file in the report -directory that you can open in any text editor. The `summary.txt` file -contains a list of all tests that were run, their test results, and -their status messages. - -The work directory, which you specified by setting the `work.dir` -property in the +{jteFileName}+ file, contains several files that were -deposited there during test execution: `harness.trace`, `log.txt`, -`lastRun.txt`, and `testsuite`. Most of these files provide information -about the harness and environment in which the tests were executed. - -[NOTE] -======================================================================= - -You can set `harness.log.traceflag=true` in +{jteFileName}+ to -get more debugging information. - -======================================================================= - -If a large number of tests failed, you should read -link:#GBFYF[Configuration Failures] to see if a -configuration issue is the cause of the failures. - - -[[GBFVF]][[test-tree]] - -6.2 Test Tree -~~~~~~~~~~~~~ - -Use the test tree in the JavaTest GUI to identify specific folders and -tests that had errors or failing results. Color codes are used to -indicate status as follows: - -* Green: Passed -* Blue: Test Error -* Red: Failed to pass test -* White: Test not run -* Gray: Test filtered out (not run) - -[[GBFWI]][[folder-information]] - -6.3 Folder Information -~~~~~~~~~~~~~~~~~~~~~~ - -Click a folder in the test tree in the JavaTest GUI to display its tabs. - -Choose the Error and the Failed tabs to view the lists of all tests in -and under a folder that were not successfully run. You can double-click -a test in the lists to view its test information. - -[[GBFVP]][[test-information]] - -6.4 Test Information -~~~~~~~~~~~~~~~~~~~~ - -To display information about a test in the JavaTest GUI, click its icon -in the test tree or double-click its name in a folder status tab. The -tab contains detailed information about the test run and, at the bottom -of the window, a brief status message identifying the type of failure or -error. This message may be sufficient for you to identify the cause of -the error or failure. - -If you need more information to identify the cause of the error or -failure, use the following tabs listed in order of importance: - -* Test Run Messages contains a Message list and a Message section that -display the messages produced during the test run. -* Test Run Details contains a two-column table of name/value pairs -recorded when the test was run. -* Configuration contains a two-column table of the test environment -name/value pairs derived from the configuration data actually used to -run the test. - - -[NOTE] -======================================================================= - -You can set `harness.log.traceflag=true` in +{jteFileName}+ to -get more debugging information. - -======================================================================= - - -[[GBFVZ]][[report-files]] - -6.5 Report Files -~~~~~~~~~~~~~~~~ - -Report files are another good source of troubleshooting information. You -may view the individual test results of a batch run in the JavaTest -Summary window, but there are also a wide range of HTML report files -that you can view in the JavaTest ReportBrowser or in the external -browser or your choice following a test run. See -link:using.html#GBFVK[Section 5.5, "Test Reports,"] for more information. - -[[GBFYF]][[configuration-failures]] - -6.6 Configuration Failures -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Configuration failures are easily recognized because many tests fail the -same way. When all your tests begin to fail, you may want to stop the -run immediately and start viewing individual test output. However, in -the case of full-scale launching problems where no tests are actually -processed, report files are usually not created (though sometimes a -small `harness.trace` file in the report directory is written). - -include::debug-tips.inc[] diff --git a/user_guides/jpa/src/main/jbake/content/defns.inc b/user_guides/jpa/src/main/jbake/content/defns.inc deleted file mode 100644 index 038db2dda3..0000000000 --- a/user_guides/jpa/src/main/jbake/content/defns.inc +++ /dev/null @@ -1,46 +0,0 @@ -// NOTE TO WRITERS: -// Most technologies will only need the compatibility rules in rules.adoc. -// Some technologies will need additional definitions to go with additional -// rules. If they're needed, remove the comment characters below -// and update the definitions as appropriate. -// -// The first block below is additional definitions needed by -// Jakarta XML Web Services. -// -// The second block below is additional defintions needed by -// Jakarta Server Pages. -// -// NOTE: This set of examples is NOT complete, but should be. -// -// -// Jakarta XML Web Services -// -// |Development Kit |A software product that implements or incorporates a -// Compiler, a Schema Compiler, a Schema Generator, a Java-to-WSDL Tool, a -// WSDL-to-Java Tool, and/or an RMI Compiler. -// -// |Java-to-WSDL Output |Output of a Java-to-WSDL Tool that is required for -// Web service deployment and invocation. -// -// |Java-to-WSDL Tool |A software development tool that implements or -// incorporates a function that generates web service endpoint descriptions -// in WSDL and XML schema format from Source Code as specified by the -// Jakarta XML Web Services Specification. -// -// |WSDL-to-Java Output |Output of a WSDL-to-Java tool that is required for -// Web service deployment and invocation. -// -// |WSDL-to-Java Tool |A software development tool that implements or -// incorporates a function that generates web service interfaces for -// clients and endpoints from a WSDL description as specified by the -// Jakarta XML Web Services Specification. -// -// -// Jakarta Server Pages -// -// |Jakarta Server Page |A text-based document that uses Jakarta Server -// Pages technology. -// -// |Jakarta Server Page Implementation Class |A program constructed by -// transforming the Jakarta Server Page text into a Java language program -// using the transformation rules described in the Specifications. diff --git a/user_guides/jpa/src/main/jbake/content/faq.adoc b/user_guides/jpa/src/main/jbake/content/faq.adoc deleted file mode 100644 index 97ca394c55..0000000000 --- a/user_guides/jpa/src/main/jbake/content/faq.adoc +++ /dev/null @@ -1,62 +0,0 @@ -type=page -status=published -title=Appendix A: Frequently Asked Questions -next=rebuild.html -prev=debug.html -~~~~~~ -include::attributes.conf[] -Appendix A: Frequently Asked Questions -====================================== - -[[GBFYD]] - - -[[a-frequently-asked-questions]] -A Frequently Asked Questions ----------------------------- - -This appendix contains the following questions. - -* link:#GBFYQ[Where do I start to debug a test failure?] -* link:#GBFYR[How do I restart a crashed test run?] -* link:#GBFWU[What would cause tests be added to the exclude list?] - -[[GBFYQ]][[a.1-where-do-i-start-to-debug-a-test-failure]] - -A.1 Where do I start to debug a test failure? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -From the JavaTest GUI, you can view recently run tests using the Test -Results Summary, by selecting the red Failed tab or the blue Error tab. -See link:debug.html#GBFUV[Chapter 6, "Debugging Test Problems,"] for more -information. - -[[GBFYR]][[a.2-how-do-i-restart-a-crashed-test-run]] - -A.2 How do I restart a crashed test run? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you need to restart a test run, you can figure out which test crashed -the test suite by looking at the `harness.trace` file. The -`harness.trace` file is in the report directory that you supplied to the -JavaTest GUI or parameter file. Examine this trace file, then change the -JavaTest GUI initial files to that location or to a directory location -below that file, and restart. This will overwrite only `.jtr` files that -you rerun. As long as you do not change the value of the GUI work -directory, you can continue testing and then later compile a complete -report to include results from all such partial runs. - -[[GBFWU]][[a.3-what-would-cause-tests-be-added-to-the-exclude-list]] - -A.3 What would cause tests be added to the exclude list? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The JavaTest exclude file (+{jtxFileName}+) contains all tests that are not -required to be run. The following is a list of reasons for a test to be -included in the Exclude List: - -* An error in a Compatible Implementation that does not allow the test to -execute properly has been discovered. -* An error in the specification that was used as the basis of the test -has been discovered. -* An error in the test has been discovered. diff --git a/user_guides/jpa/src/main/jbake/content/install-server-vi.inc b/user_guides/jpa/src/main/jbake/content/install-server-vi.inc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/user_guides/jpa/src/main/jbake/content/install-server.inc b/user_guides/jpa/src/main/jbake/content/install-server.inc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/user_guides/jpa/src/main/jbake/content/install.adoc b/user_guides/jpa/src/main/jbake/content/install.adoc deleted file mode 100644 index a3b93e73ac..0000000000 --- a/user_guides/jpa/src/main/jbake/content/install.adoc +++ /dev/null @@ -1,86 +0,0 @@ -type=page -status=published -title=Installation -next=config.html -prev=rules.html -~~~~~~ -include::attributes.conf[] -Installation -============ - -[[GBFTP]] - - -[[installation]] -3 Installation --------------- - -This chapter explains how to install the {TechnologyFullName} TCK software. - -After installing the software according to the instructions in this -chapter, proceed to link:config.html#GBFVV[Chapter 4, "Setup and -Configuration,"] for instructions on configuring your test environment. - -[[GBFUD]][[obtaining-the-reference-implementation]] - -3.1 Obtaining a Compatible Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Each compatible implementation (CI) will provide instructions for obtaining -their implementation. -{TechnologyRI} is a compatible implementation which may be obtained -from {TechnologyRIURL} - -[[GBFTS]][[installing-the-software]] - -3.2 Installing the Software -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Before you can run the {TechnologyShortName} TCK tests, you must -install and set up the following software components: - -include::req-software.inc[] -* Java SE {SEversion} -* Apache Ant {AntVersion} -* A CI for {TechnologyShortName} {TechnologyVersion}, one example is {TechnologyRI} -* {TechnologyShortName} TCK version {TechnologyVersion}, which includes: -include::tck-packages.inc[] -* The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) - -Follow these steps: - -. Install the Java SE {SEversion} software, if it is not already installed. + -Download and install the Java SE {SEversion} software from -http://www.oracle.com/technetwork/java/javase/downloads/index.html. -Refer to the installation instructions that accompany the software for -additional information. -. Install the Apache Ant {AntVersion} software, if it is not already installed. + -Download and install Apache Ant {AntVersion} software from Apache Ant -Project. For complete information about Ant, refer to the extensive documentation -on the Apache Ant Project site. The Apache Ant Manual is available at -`http://ant.apache.org/manual/index.html`. -Apache Ant is protected under the Apache Software, License 2.0, which is -is available on the Apache Ant Project license page at -`http://ant.apache.org/license.html`. -. Install the {TechnologyShortName} TCK {TechnologyVersion} software. - a. Copy or download the {TechnologyShortName} TCK software to your - local system. + - You can obtain the {TechnologyShortName} TCK software from the - Jakarta EE site {SpecificationURL}. - b. Use the `unzip` command to extract the bundle in the directory of - your choice: + - +unzip {TCKPackageName}+ + - This creates the TCK directory. The TCK is the test suite home, - ``. -include::install-server.inc[] -. Install a {TechnologyShortName} {TechnologyVersion} Compatible -Implementation. + -A Compatible Implementation is used to validate your initial -configuration and setup of the {TechnologyShortName} TCK -{TechnologyVersion} tests, which are explained further in -link:config.html#GBFVV[Chapter 4, "Setup and Configuration."] + -The Compatible Implementations for {TechnologyShortName} are listed on -the Jakarta EE Specifications web site: {SpecificationURL}. -include::install-server-vi.inc[] -. Install the {TechnologyShortName} VI to be tested. + -Follow the installation instructions for the particular VI under test. diff --git a/user_guides/jpa/src/main/jbake/content/intro.adoc b/user_guides/jpa/src/main/jbake/content/intro.adoc deleted file mode 100644 index 774adfd371..0000000000 --- a/user_guides/jpa/src/main/jbake/content/intro.adoc +++ /dev/null @@ -1,349 +0,0 @@ -type=page -status=published -title=Introduction -next=rules.html -prev=preface.html -~~~~~~ -include::attributes.conf[] -Introduction -============ - -[[GBFOW]] - - -[[introduction]] -1 Introduction --------------- - -This chapter provides an overview of the principles that apply -generally to all Technology Compatibility Kits (TCKs) and describes the -{TechnologyFullName} TCK ({TechnologyShortName} {TechnologyVersion} TCK). -It also includes a high level listing -of what is needed to get up and running with the {TechnologyShortName} -TCK. - -This chapter includes the following topics: - -* link:#GBFTK[Compatibility Testing] -* link:#GBFQR[About the TCK] -* link:#GBFQW[Getting Started With the TCK] - -[[GBFTK]][[compatibility-testing]] - -1.1 Compatibility Testing -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Compatibility testing differs from traditional product testing in a -number of ways. The focus of compatibility testing is to test those -features and areas of an implementation that are likely to differ across -other implementations, such as those features that: - -* Rely on hardware or operating system-specific behavior -* Are difficult to port -* Mask or abstract hardware or operating system behavior - -Compatibility test development for a given feature relies on a complete -specification and compatible implementation (CI) for that feature. -Compatibility testing is not primarily concerned with robustness, -performance, nor ease of use. - -[[GBFQN]][[why-compatibility-testing-is-important]] - -1.1.1 Why Compatibility Testing is Important -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Jakarta platform compatibility is important to different groups involved -with Jakarta technologies for different reasons: - -* Compatibility testing ensures that the Jakarta platform does not become -fragmented as it is ported to different operating systems and hardware -environments. -* Compatibility testing benefits developers working in the Jakarta -programming language, allowing them to write applications once and then -to deploy them across heterogeneous computing environments without -porting. -* Compatibility testing allows application users to obtain applications -from disparate sources and deploy them with confidence. -* Conformance testing benefits Jakarta platform implementors by ensuring a -level playing field for all Jakarta platform ports. - -[[GBFPR]][[tck-compatibility-rules]] - -1.1.2 TCK Compatibility Rules -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Compatibility criteria for all technology implementations are embodied -in the TCK Compatibility Rules that apply to a specified technology. -Each TCK tests for adherence to these Rules as described in -link:rules.html#GBFSN[Chapter 2, "Procedure for Certification."] - -[[GBFPW]][[tck-overview]] - -1.1.3 TCK Overview -^^^^^^^^^^^^^^^^^^ - -A TCK is a set of tools and tests used to verify that a vendor's compatible -implementation of a Jakarta EE technology conforms to the applicable -specification. All tests in the TCK are based on the written -specifications for the Jakarta EE platform. A TCK tests compatibility of a -vendor's compatible implementation of the technology to the applicable -specification of the technology. Compatibility testing is a means of -ensuring correctness, completeness, and consistency across all -implementations developed by technology licensees. - -The set of tests included with each TCK is called the test suite. Most -tests in a TCK's test suite are self-checking, but some tests may -require tester interaction. Most tests return either a Pass or Fail -status. For a given platform to be certified, all of the required tests -must pass. The definition of required tests may change from platform to -platform. - -The definition of required tests will change over time. Before your -final certification test pass, be sure to download the latest version -of this TCK. - -[[GBFPB]][[java-community-process-jcp-program-and-compatibility-testing]] - -1.1.4 Jakarta EE Specification Process (JESP) Program and Compatibility Testing -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The Jakarta EE Specification Process (JESP) program is the formalization of the -open process that has been used since 2019 to develop and revise Jakarta EE -technology specifications in cooperation with the international Jakarta EE -community. The JESP program specifies that the following three major -components must be included as deliverables in a final Jakarta EE technology -release under the direction of the responsible Expert Group: - -* Technology Specification -* Compatible Implementation (CI) -* Technology Compatibility Kit (TCK) - -For further information about the JESP program, go to Jakarta EE Specification -Process community page https://jakarta.ee/specifications. - -[[GBFQR]][[about-the-tck]] - -1.2 About the TCK -~~~~~~~~~~~~~~~~~ - -The {TechnologyShortName} TCK {TechnologyVersion} is designed as a -portable, configurable, automated test suite for verifying the -compatibility of a vendor's implementation of the -{TechnologyShortName} {TechnologyVersion} Specification. - -[[GBFQV]][[tck-specifications-and-requirements]] - -1.2.1 TCK Specifications and Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This section lists the applicable requirements and specifications. - -* Specification Requirements: Software requirements for a -{TechnologyShortName} implementation are described in detail in the -{TechnologyShortName} {TechnologyVersion} Specification. Links to the -{TechnologyShortName} specification and other product information can -be found at {SpecificationURL}. -* {TechnologyShortName} Version: The {TechnologyShortName} {TechnologyVersion} TCK -is based on the {TechnologyShortName} -Specification, Version {TechnologyVersion}. -* Compatible Implementation: One {TechnologyShortName} -{TechnologyVersion} Compatible Implementation, {TechnologyRI} is -available from the Eclipse EE4J project -(https://projects.eclipse.org/projects/ee4j). See the CI documentation page at -{TechnologyRIURL} for more information. - -See the {TechnologyShortName} TCK Release Notes for more specific -information about Java SE version requirements, supported platforms, -restrictions, and so on. - -[[GBFSQ]][[tck-components]] - -1.2.2 TCK Components -^^^^^^^^^^^^^^^^^^^^ - -The {TechnologyShortName} TCK {TechnologyVersion} includes the -following components: - -* JavaTest harness version {JavaTestVersion} and related documentation. See -link:https://wiki.openjdk.java.net/display/CodeTools/JT+Harness[JT Harness web site] -for additional information. -* {TechnologyShortName} TCK signature tests; check that all public APIs -are supported and/or defined as specified in the {TechnologyShortName} -Version {TechnologyVersion} implementation under test. -* If applicable, an exclude list, which provides a list of tests that your -implementation is not required to pass. -ifndef::no-api-tests[] -* API tests for all of the {TechnologyShortName} API in all related packages: -include::packages.inc[] -endif::no-api-tests[] -ifdef::end-to-end-tests[] -* End-to-end tests that demonstrate compliance with the {TechnologyFullName} -Specification. -endif::end-to-end-tests[] - -The {TechnologyShortName} TCK tests run on the following platforms: - -include::platforms.inc[] - -[[GBFSA]][[javatest-harness]] - -1.2.3 JavaTest Harness -^^^^^^^^^^^^^^^^^^^^^^ - -The JavaTest harness version {JavaTestVersion} is a set of tools -designed to run and manage test suites on different Java platforms. -To JavaTest, Jakarta EE can be considered another platform. -The JavaTest harness can be described as both a Java application and a set -of compatibility testing tools. It can run tests on different kinds of -Java platforms and it allows the results to be browsed online within -the JavaTest GUI, or offline in the HTML reports that the JavaTest -harness generates. - -The JavaTest harness includes the applications and tools that are used -for test execution and test suite management. It supports the following -features: - -* Sequencing of tests, allowing them to be loaded and executed automatically -* Graphic user interface (GUI) for ease of use -* Automated reporting capability to minimize manual errors -* Failure analysis -* Test result auditing and auditable test specification framework -* Distributed testing environment support - -To run tests using the JavaTest harness, you specify which tests in the -test suite to run, how to run them, and where to put the results as -described in link:config.html#GBFVV[Chapter 4, "Setup and -Configuration."] - -[[GBFRA]][[tck-compatibility-test-suite]] - -1.2.4 TCK Compatibility Test Suite -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The test suite is the collection of tests used by the JavaTest harness -to test a particular technology implementation. In this case, it is the -collection of tests used by the {TechnologyShortName} TCK -{TechnologyVersion} to test a {TechnologyShortName} {TechnologyVersion} -implementation. The tests are designed to verify that a vendor's -runtime implementation of the technology complies with the appropriate -specification. The individual tests correspond to assertions of the -specification. - -The tests that make up the TCK compatibility test suite are precompiled -and indexed within the TCK test directory structure. When a test run is -started, the JavaTest harness scans through the set of tests that are -located under the directories that have been selected. While scanning, -the JavaTest harness selects the appropriate tests according to any -matches with the filters you are using and queues them up for execution. - -[[GBFSH]][[exclude-lists]] - -1.2.5 Exclude Lists -^^^^^^^^^^^^^^^^^^^ - -Each version of a TCK includes an Exclude List contained in a `.jtx` -file. -This is a list of test file URLs that identify tests which do not -have to be run for the specific version of the TCK being used. -Whenever tests are run, the JavaTest harness automatically excludes -any test on the Exclude List from being executed. - -A vendor's compatible implementation is not required to pass or run any test on the Exclude List. -The Exclude List file, +{jtxFileName}+, is included in the -{TechnologyShortName} TCK. - - -[NOTE] -======================================================================= - -From time to time, updates to the Exclude List are made available. -The exclude list is included in the Jakarta TCK ZIP archive. -Each time an update is approved and released, the version number -will be incremented. -You should always make sure you are using an up-to-date copy of the -Exclude List before running the {TechnologyShortName} TCK to verify your -implementation. - -======================================================================= - - -A test might be in the Exclude List for reasons such as: - -* An error in an underlying implementation API has been discovered which -does not allow the test to execute properly. -* An error in the specification that was used as the basis of the test -has been discovered. -* An error in the test itself has been discovered. -* The test fails due to a bug in the tools (such as the JavaTest -harness, for example). - -In addition, all tests are run against the compatible implementations. -Any tests that fail when run on a compatible Jakarta platform are put on the -Exclude List. Any test that is not specification-based, or for which the -specification is vague, may be excluded. Any test that is found to be -implementation dependent (based on a particular thread scheduling model, -based on a particular file system behavior, and so on) may be excluded. - - -[NOTE] -======================================================================= - -Vendors are not permitted to alter or modify Exclude Lists. Changes to -an Exclude List can only be made by using the procedure described in -link:rules.html#CJAJEAEI[Section 2.3.1, "TCK Test Appeals Steps."] - -======================================================================= - - -[[GBFRR]][[tck-configuration]] - -1.2.6 TCK Configuration -^^^^^^^^^^^^^^^^^^^^^^^ - -You need to set several variables in your test environment, modify -properties in the +{jteFileName}+ file, and then use the JavaTest -harness to configure and run the {TechnologyShortName} tests, as described in -link:config.html#GBFVV[Chapter 4, "Setup and Configuration."] - -include::intro.inc[] - -[[GBFQW]][[getting-started-with-the-tck]] - -[NOTE] -==== -The Jakarta EE Specification Process support multiple compatible implementations. -These instructions explain how to get started with the {TechnologyRI} CI. -If you are using another compatible implementation, refer to material provided -by that implementation for specific instructions and procedures. - -==== - -1.3 Getting Started With the TCK -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section provides an general overview of what needs to be done to -install, set up, test, and use the {TechnologyShortName} TCK. These -steps are explained in more detail in subsequent chapters of this -guide. - -1. Make sure that the following software has been correctly installed -on the system hosting the JavaTest harness: -include::req-software.inc[] -* Java SE {SEversion} -* Apache Ant {AntVersion} -* A CI for {TechnologyShortName} {TechnologyVersion}. One example is {TechnologyRI}. -* {TechnologyShortName} TCK version {TechnologyVersion}, which includes: -include::tck-packages.inc[] -* The {TechnologyShortName} {TechnologyVersion} Vendor Implementation (VI) + -See the documentation for each of these software applications for -installation instructions. See link:install.html#GBFTP[Chapter 3, -"Installation,"] for instructions on installing the {TechnologyShortName} TCK. -2. Set up the {TechnologyShortName} TCK software. + -See link:config.html#GBFVV[Chapter 4, "Setup and Configuration,"] for -details about the following steps. - a. Set up your shell environment. - b. Modify the required properties in the +{jteFileName}+ file. - c. Configure the JavaTest harness. -3. Test the {TechnologyShortName} {TechnologyVersion} implementation. + -Test the {TechnologyShortName} implementation installation by running -the test suite. See link:using.html#GBFWO[Chapter 5, "Executing Tests."] diff --git a/user_guides/jpa/src/main/jbake/content/intro.inc b/user_guides/jpa/src/main/jbake/content/intro.inc deleted file mode 100644 index 94840b5113..0000000000 --- a/user_guides/jpa/src/main/jbake/content/intro.inc +++ /dev/null @@ -1,20 +0,0 @@ - -[[GEQNJ]][[additional-jpa-notes]] - -1.2.7 Additional {TechnologyShortName} Notes -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In addition to the usual signature, API, and end-to-end tests, -the {TechnologyShortName} TCK also includes pluggability tests verify that the -implementation under test can use third-party persistence providers -instead of the one provided by the implementation. - -[NOTE] -======================================================================= - -The following may be useful to users of previous TCK versions: - -No significant changes were made to how tests are run. - -======================================================================= - diff --git a/user_guides/jpa/src/main/jbake/content/packages.inc b/user_guides/jpa/src/main/jbake/content/packages.inc deleted file mode 100644 index c3b95243e1..0000000000 --- a/user_guides/jpa/src/main/jbake/content/packages.inc +++ /dev/null @@ -1,7 +0,0 @@ -** `jakarta.persistence` - -** `jakarta.persistence.criteria` - -** `jakarta.persistence.metamodel` - -** `jakarta.persistence.spi` diff --git a/user_guides/jpa/src/main/jbake/content/platforms.inc b/user_guides/jpa/src/main/jbake/content/platforms.inc deleted file mode 100644 index 3f54158cb4..0000000000 --- a/user_guides/jpa/src/main/jbake/content/platforms.inc +++ /dev/null @@ -1,4 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -List tested operating environments here -/////////////////////////////////////////////////////////////////////// -* CentOS Linux 7 \ No newline at end of file diff --git a/user_guides/jpa/src/main/jbake/content/preface.adoc b/user_guides/jpa/src/main/jbake/content/preface.adoc deleted file mode 100644 index ea10c28728..0000000000 --- a/user_guides/jpa/src/main/jbake/content/preface.adoc +++ /dev/null @@ -1,147 +0,0 @@ -type=page -status=published -title=Preface -next=intro.html -prev=title.html -~~~~~~ -include::attributes.conf[] -Preface -======= - -[[TCJRS00001]][[GBFTI]] - - -[[preface]] -Preface -------- - -This guide describes how to install, configure, and run the Technology -Compatibility Kit (TCK) that is used to test the {TechnologyFullName} -({TechnologyShortName} {TechnologyVersion}) technology. - -The {TechnologyShortName} TCK is a portable, configurable automated -test suite for verifying the compatibility of a vendor's -implementation of the {TechnologyShortName} {TechnologyVersion} -Specification (hereafter referred to as the vendor implementation or VI). -The {TechnologyShortName} TCK uses the JavaTest harness version -{JavaTestVersion} to run the test suite - - -[NOTE] -======================================================================= - -Note All references to specific Web URLs are given for the sake of your -convenience in locating the resources quickly. These references are -always subject to changes that are in many cases beyond the control of -the authors of this guide. - -======================================================================= - -Jakarta EE is a community sponsored and community run program. -Organizations contribute, along side individual contributors who use, evolve -and assist others. -Commercial support is not available through the Eclipse Foundation resources. -Please refer to the Eclipse EE4J project site -(https://projects.eclipse.org/projects/ee4j). -There, you will find additional details as well as a list of all the associated sub-projects -(Implementations and APIs), that make up Jakarta EE and define these specifications. -If you have questions about this Specification you may -send inquiries to {SpecificationInquiryList}. -If you have questions about this TCK, you may send inquiries to -{TCKInquiryList}. - -[[TCJRS00034]][[GBFUS]] - - -[[who-should-use-this-book]] -Who Should Use This Book -~~~~~~~~~~~~~~~~~~~~~~~~ - -This guide is for vendors that implement the {TechnologyShortName} -{TechnologyVersion} technology to assist them in running the test suite -that verifies compatibility of their implementation of the -{TechnologyShortName} {TechnologyVersion} Specification. - - -[[TCJRS00035]][[GBFPO]] - - -[[before-you-read-this-book]] -Before You Read This Book -~~~~~~~~~~~~~~~~~~~~~~~~~ - -You should be familiar with the {TechnologyShortName} -{TechnologyVersion}, version {TechnologyVersion} Specification, -which can be found at {SpecificationURL}. - -Before running the tests in the {TechnologyShortName} TCK, you should -familiarize yourself with the JavaTest documentation which can be -accessed at the -link:https://wiki.openjdk.java.net/display/CodeTools/JT+Harness[JT Harness web site]. - -[[TCJRS00036]][[GBFWF]] - - -[[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. - -`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_. - -|======================================================================= - - -[[TCJRS00037]][[FWBSD]] - - -[[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. - -[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#` -|===================================================== - - - diff --git a/user_guides/jpa/src/main/jbake/content/rebuild.adoc b/user_guides/jpa/src/main/jbake/content/rebuild.adoc deleted file mode 100644 index e4021cfa19..0000000000 --- a/user_guides/jpa/src/main/jbake/content/rebuild.adoc +++ /dev/null @@ -1,20 +0,0 @@ -type=page -status=published -title=Appendix B: Rebuild Rules -prev=faq.html -~~~~~~ -include::attributes.conf[] - -Appendix B: Rebuild Rules -========================= - - -ifdef::rebuild[] -include::rebuild.inc[] -endif::rebuild[] -ifndef::rebuild[] - -<<< -Appendix B is not used for the {TechnologyShortName} TCK. - -endif::rebuild[] diff --git a/user_guides/jpa/src/main/jbake/content/rebuild.inc b/user_guides/jpa/src/main/jbake/content/rebuild.inc deleted file mode 100644 index 6f4297bb1b..0000000000 --- a/user_guides/jpa/src/main/jbake/content/rebuild.inc +++ /dev/null @@ -1,7 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -The following sections should be customized for the technology. -See JAXRS user guide for an example of this include file. -/////////////////////////////////////////////////////////////////////// - -[[GCLIZ]] diff --git a/user_guides/jpa/src/main/jbake/content/req-software.inc b/user_guides/jpa/src/main/jbake/content/req-software.inc deleted file mode 100644 index 48014f56ee..0000000000 --- a/user_guides/jpa/src/main/jbake/content/req-software.inc +++ /dev/null @@ -1,10 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -This is a list of software required in addition to the TCK and the RI. -For many Java EE APIs, the Java EE RI will be required, as described below. -For standalone technologies, no other software may be required, and the -below line can be removed. - -This is used in intro.adoc in section 1.3 and install.adoc in section 3.2. -/////////////////////////////////////////////////////////////////////// - diff --git a/user_guides/jpa/src/main/jbake/content/rules.adoc b/user_guides/jpa/src/main/jbake/content/rules.adoc deleted file mode 100644 index 03b8b50481..0000000000 --- a/user_guides/jpa/src/main/jbake/content/rules.adoc +++ /dev/null @@ -1,379 +0,0 @@ -type=page -status=published -title=Procedure for Certification -next=install.html -prev=intro.html -~~~~~~ -include::attributes.conf[] -Procedure for Certification -=========================== - -[[GBFSN]] - - -[[procedure-for-certification]] -2 Procedure for Certification ------------------------------ - -This chapter describes the compatibility testing procedure and -compatibility requirements for {TechnologyFullName}. -This chapter contains the following sections: - -* link:#CJAFFDGI[Certification Overview] -* link:#CJAFGIGG[Compatibility Requirements] -* link:#CJAIIBDJ[Test Appeals Process] -* link:#CJAJECIE[Specifications for {TechnologyFullName}] -* link:#CJABAHGI[Libraries for {TechnologyFullName}] - -[[CJAFFDGI]][[certification-overview]] - -2.1 Certification Overview -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The certification process for {technologyShortName} {TechnologyVersion} -consists of the following activities: - -* Install the appropriate version of the Technology Compatibility Kit -(TCK) and execute it in accordance with the instructions in this User's -Guide. -* Ensure that you meet the requirements outlined in -link:#CJAFGIGG[Compatibility Requirements] below. -* Certify to the Eclipse Foundation that you have finished -testing and that you meet all of the compatibility requirements, -as required by the Eclipse Foundation TCK License. - -[[CJAFGIGG]][[compatibility-requirements]] - -2.2 Compatibility Requirements -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The compatibility requirements for {TechnologyShortName} -{TechnologyVersion} consist of meeting the requirements set forth by -the rules and associated definitions contained in this section. - -[[sthref4]][[definitions]] - -2.2.1 Definitions -^^^^^^^^^^^^^^^^^ - -These definitions are for use only with these compatibility requirements -and are not intended for any other purpose. - -[[sthref5]][[sthref6]] - -Table 2-1 Definitions  - -[width="100%",cols="25%,75%",options="header",] -|======================================================================= -|Term |Definition -|API Definition Product |A Product for which the only Java class files -contained in the product are those corresponding to the application -programming interfaces defined by the Specifications, and which is -intended only as a means for formally specifying the application -programming interfaces defined by the Specifications. - -|Computational Resource a| -A piece of hardware or software that may vary in quantity, existence, or -version, which may be required to exist in a minimum quantity and/or at -a specific or minimum revision level so as to satisfy the requirements -of the Test Suite. - -Examples of computational resources that may vary in quantity are RAM -and file descriptors. - -Examples of computational resources that may vary in existence (that is, -may or may not exist) are graphics cards and device drivers. - -Examples of computational resources that may vary in version are -operating systems and device drivers. - -|Configuration Descriptor |Any file whose format is well defined by a -specification and which contains configuration information for a set of -Java classes, archive, or other feature defined in the specification. - -|Conformance Tests |All tests in the Test Suite for an indicated -Technology Under Test, as released and distributed by the -Eclipse Foundation, excluding those tests on the -published Exclude List for the Technology Under Test. - -|Container |An implementation of the associated Libraries, as specified -in the Specifications, and a version of a Java Platform, Standard -Edition Runtime Product, as specified in the Specifications, or a later -version of a Java Platform, Standard Edition Runtime Product that also -meets these compatibility requirements. - -|Documented |Made technically accessible and made known to users, -typically by means such as marketing materials, product documentation, -usage messages, or developer support programs. - -|Exclude List |The most current list of tests, released and distributed by the -Eclipse Foundation, that are not required to be passed to certify -conformance. The Jakarta EE Specification Committee may add to the Exclude List for that -Test Suite as needed at any time, in which case the updated TCK version -supplants any previous Exclude Lists for that Test Suite. - -|Libraries a| -The class libraries, as specified through the Jakarta EE Specification Process -(JESP), for the Technology Under Test. - -The Libraries for {TechnologyFullName} are listed at the end of this chapter. - -|Location Resource a| -A location of classes or native libraries that are components of the -test tools or tests, such that these classes or libraries may be -required to exist in a certain location in order to satisfy the -requirements of the test suite. - -For example, classes may be required to exist in directories named in a -CLASSPATH variable, or native libraries may be required to exist in -directories named in a PATH variable. - -|Maintenance Lead |The corresponding Jakarta EE Specification Project -is responsible for maintaining the Specification, and the TCK for the -Technology. The Specification Project Team will propose revisions and -updates to the Jakarta EE Specification Committee which will approve -and release new versions of the specification and TCK. - -|Operating Mode a| -Any Documented option of a Product that can be changed by a user in -order to modify the behavior of the Product. - -For example, an Operating Mode can be binary (enable/disable -optimization), an enumeration (select from a list of protocols), or a -range (set the maximum number of active threads). - -Note that an Operating Mode may be selected by a command line switch, an -environment variable, a GUI user interface element, a configuration or -control file, etc. - -|Product |A vendor's product in which the Technology Under Test is -implemented or incorporated, and that is subject to compatibility -testing. - -|Product Configuration a| -A specific setting or instantiation of an Operating Mode. - -For example, a Product supporting an Operating Mode that permits user -selection of an external encryption package may have a Product -Configuration that links the Product to that encryption package. - -|Rebuildable Tests |Tests that must be built using an -implementation-specific mechanism. This mechanism must produce -specification-defined artifacts. Rebuilding and running these tests -against a known compatible implementation verifies that the mechanism generates -compatible artifacts. - -|Resource |A Computational Resource, a Location Resource, or a Security -Resource. - -|Rules |These definitions and rules in this Compatibility Requirements -section of this User's Guide. - -|Runtime |The Containers specified in the Specifications. - -|Security Resource a| -A security privilege or policy necessary for the proper execution of the -Test Suite. - -For example, the user executing the Test Suite will need the privilege -to access the files and network resources necessary for use of the -Product. - -|Specifications a| -The documents produced through the Jakarta EE Specification Process (JESP) -that define a particular Version of a Technology. - -The Specifications for the Technology Under Test are referenced later in -this chapter. - -|Technology |Specifications and one or more compatible implementations produced -through the Jakarta EE Specification Process (JESP). - -|Technology Under Test |Specifications and a compatible implementation -for {TechnologyFullName} Version {TechnologyVersion}. - -|Test Suite |The requirements, tests, and testing tools distributed by -the Maintenance Lead as applicable to a given Version of the Technology. - -|Version |A release of the Technology, as produced through the -Jakarta EE Specification Process (JESP). - -include::defns.inc[] -|======================================================================= - - -[[sthref7]][[rules-for-products]] - -2.2.2 Rules for {TechnologyFullName} Products -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The following rules apply for each implementation: - -*{techID}1* The implementation must be able to satisfy compatibility -requirements, including passing all required TCK Tests. - -*{techID}1.1* Each implementation must have at least one configuration that can be used to pass -all required TCK Tests, although such configuration may need adjustment (e.g. whether statically -or via administrative tooling). - -*{techID}1.2* An API Definition Product is exempt from all functional -testing requirements defined here, except the signature tests. - -*{techID}2* Some Conformance Tests may have properties that may be changed. -Properties that can be changed are identified in the configuration -interview. Properties that can be changed are identified in the JavaTest -Environment (.jte) files in the Test Suite -installation. Apart from changing such properties and other allowed -modifications described in this User's Guide (if any), no source or -binary code for a Conformance Test may be altered in any way without -prior written permission. Any such allowed alterations to the -Conformance Tests will be provided via the Jakarta EE Specification Project -website and apply to all vendor compatible implementations. - -*{techID}3* The testing tools supplied as part of the Test Suite or as -updated by the Maintenance Lead must be used to certify compliance. - -*{techID}4* The Exclude List associated with the Test Suite cannot be -modified. - -*{techID}5* The Maintenance Lead can define exceptions to these Rules. Such -exceptions would be made available as above, and will apply to all vendor implementations. - -*{techID}6* All hardware and software component additions, deletions, and -modifications to a Documented supporting hardware/software platform, -that are not part of the Product but required for the Product to satisfy -the compatibility requirements, must be Documented and available to -users of the Product. - -*{techID}7* The Product must contain the full set of public and protected -classes and interfaces for all the Libraries. Those classes and -interfaces must contain exactly the set of public and protected methods, -constructors, and fields defined by the Specifications for those -Libraries. No subsetting, supersetting, or modifications of the public -and protected API of the Libraries are allowed except only as -specifically exempted by these Rules. - -*{techID}7.1* If a Product includes Jakarta EE Technologies in addition to the -Technology Under Test, then it must contain the full set of combined -public and protected classes and interfaces. The API of the Product -must contain the union of the included Technologies. No further -modifications to the APIs of the included Technologies are allowed. - -ifdef::subset-allowed[] -*{techID}7.2* The Product may contain a subset of the classes and -interfaces for the Libraries. -endif::subset-allowed[] - -*{techID}8* Except for tests specifically required by this TCK to be rebuilt -(if any), the binary Conformance Tests supplied as part of the Test -Suite or as updated by the Maintenance Lead must be used to certify -compliance. - -*{techID}9* The functional programmatic behavior of any binary class or -interface must be that defined by the Specifications. - -include::rules.inc[] - -[[CJAIIBDJ]][[test-appeals-process]] - -2.3 Test Appeals Process -~~~~~~~~~~~~~~~~~~~~~~~~ - -Refer to https://jakarta.ee/committees/specification/tckprocess (version 1.2) as the definitive source for -the TCK rules. - -Jakarta has a well established process for managing challenges to its -TCKs. Any implementor may submit a challenge to one or more tests in the -{TechnologyShortName} TCK as it relates to their implementation. Implementor -means the entity as a whole in charge of producing the final certified release. -*Challenges filed should represent the consensus of that entity*. - -2.3.1 Valid Challenges -^^^^^^^^^^^^^^^^^^^^^^ -Any test case (e.g., test class, @Test method), test case configuration (e.g., deployment descriptor), test beans, annotations, and other resources considered part of the TCK may be challenged. - -The following scenarios are considered in scope for test challenges: - -* Claims that a test assertion conflicts with the specification. -* Claims that a test asserts requirements over and above that of the specification. -* Claims that an assertion of the specification is not sufficiently implementable. -* Claims that a test is not portable or depends on a particular implementation. - -2.3.2 Invalid Challenges -^^^^^^^^^^^^^^^^^^^^^^^^ -The following scenarios are considered out of scope for test challenges and will be immediately closed if filed: - -* Challenging an implementation’s claim of passing a test. Certification is an honor system and these issues must be raised directly with the implementation. -* Challenging the usefulness of a specification requirement. The challenge process cannot be used to bypass the specification process and raise in question the need or relevance of a specification requirement. -* Claims the TCK is inadequate or missing assertions required by the specification. See the Improvement section, which is outside the scope of test challenges. -* Challenges that do not represent a consensus of the implementing community will be closed until such time that the community does agree or agreement cannot be made. The test challenge process is not the place for implementations to initiate their own internal discussions. -* Challenges to tests that are already excluded for any reason. -* Challenges that an excluded test should not have been excluded and should be re-added should be opened as a new enhancement request - -Test challenges must be made in writing via the {TechnologyShortName} specification project issue tracker -as described in link:#CJAJEAEI[Section 2.3.3, "TCK Test Appeals Steps."] - -All tests found to be invalid will be placed on the Exclude List -for that version of the {TechnologyShortName} TCK. - - -[[CJAJEAEI]][[tck-test-appeals-steps]] - -2.3.3 TCK Test Appeals Steps -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. Challenges should be filed via the {TechnologyFullName} specification project’s issue tracker using the label `challenge` and include the following information: -* The relevant specification version and section number(s) -* The coordinates of the challenged test(s) -* The exact TCK and exclude list versions -* The implementation being tested, including name and company -* The full test name -* A full description of why the test is invalid and what the correct behavior is believed to be -* Any supporting material; debug logs, test output, test logs, run scripts, etc. - - - -2. Specification project evaluates the challenge. + -Challenges can be resolved by a specification project lead, or a project challenge triage team, after a consensus of the specification project committers is reached or attempts to gain consensus fails. -Specification projects may exercise lazy consensus, voting or any practice that follows the principles of Eclipse Foundation Development Process. -The expected timeframe for a response is two weeks or less. -If consensus cannot be reached by the specification project for a prolonged period of time, the default recommendation is to exclude the tests and address the dispute in a future revision of the specification. - -3. Accepted Challenges. + -A consensus that a test produces invalid results will result in the exclusion of that test from certification requirements, and an immediate update and release of an official distribution of the TCK including the new exclude list. The associated `challenge` issue must be closed with an `accepted` label to indicate it has been resolved. - -4. Rejected Challenges and Remedy. + -When a`challenge` issue is rejected, it must be closed with a label of `invalid` to indicate it has been rejected. -There appeal process for challenges rejected on technical terms is outlined in Escalation Appeal. -If, however, an implementer feels the TCK challenge process was not followed, an appeal issue should be filed with specification project’s TCK issue tracker using the label `challenge-appeal`. -A project lead should escalate the issue with the Jakarta EE Specification Committee via email (jakarta.ee-spec@eclipse.org). -The committee will evaluate the matter purely in terms of due process. -If the appeal is accepted, the original TCK challenge issue will be reopened and a label of `appealed-challenge` added, along with a discussion of the appeal decision, and the `challenge-appeal` issue with be closed. -If the appeal is rejected, the `challenge-appeal` issue should closed with a label of `invalid`. - -5. Escalation Appeal. + -If there is a concern that a TCK process issue has not been resolved satisfactorily, the -https://www.eclipse.org/projects/dev_process/#6_5_Grievance_Handling[Eclipse Development Process Grievance Handling] procedure should be followed to escalate the resolution. Note that this is not a mechanism to attempt to handle implementation specific issues. - - -[[CJAJECIE]][[specifications-for-technology]] - -2.4 Specifications for {TechnologyFullName} -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The {TechnologyFullName} specification is available from the specification -project web-site: {SpecificationURL}. - -[[CJABAHGI]][[libraries-for-technology]] - -2.5 Libraries for {TechnologyFullName} -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following is a list of the packages comprising the required class -libraries for {TechnologyShortName} {TechnologyVersion}: - -include::packages.inc[] - -For the latest list of packages, also see: - -{SpecificationURL} diff --git a/user_guides/jpa/src/main/jbake/content/rules.inc b/user_guides/jpa/src/main/jbake/content/rules.inc deleted file mode 100644 index 0bd49dc945..0000000000 --- a/user_guides/jpa/src/main/jbake/content/rules.inc +++ /dev/null @@ -1,19 +0,0 @@ - -*{techID}10* The presence of an XML comment in a Configuration -Descriptor, when processed by a Deployment Tool, must not cause the -functional programmatic behavior of the Deployment Tool to vary from -the functional programmatic behavior of the Deployment Tool in the -absence of that comment. - -*{techID}11* The Runtime must report an error when processing a -Configuration Descriptor that does not conform to the Specifications. - -*{techID}12* The presence of an XML comment in a Configuration -Descriptor, when processed by the Runtime, must not cause the -functional programmatic behavior of the Runtime to vary from -the functional programmatic behavior of the Runtime in the -absence of that comment. - -*{techID}13* An error must be reported when processing a configuration -descriptor that includes a {TechnologyFullName} QL expression that does not -conform to the Specifications. diff --git a/user_guides/jpa/src/main/jbake/content/tck-packages.inc b/user_guides/jpa/src/main/jbake/content/tck-packages.inc deleted file mode 100644 index 5ca50031cc..0000000000 --- a/user_guides/jpa/src/main/jbake/content/tck-packages.inc +++ /dev/null @@ -1,7 +0,0 @@ -** JDOM 1.1.3 - -** Apache Commons HTTP Client 3.1 - -** Apache Commons Logging 1.1.3 - -** Apache Commons Codec 1.9 diff --git a/user_guides/jpa/src/main/jbake/content/title.adoc b/user_guides/jpa/src/main/jbake/content/title.adoc deleted file mode 100644 index 232172d727..0000000000 --- a/user_guides/jpa/src/main/jbake/content/title.adoc +++ /dev/null @@ -1,42 +0,0 @@ -type=page -status=published -title=TCK User's Guide for Technology Implementors -next=preface.html -prev=toc.html -~~~~~~ -include::attributes.conf[] - -TCK User's Guide for {TechnologyFullName}, Release {TechnologyVersion} for Jakarta EE -===================================================================================== - -[[eclipse-foundation]] -Eclipse Foundation ------------------- - -Technology Compatibility Kit User's Guide for {TechnologyFullName} - -Release {TechnologyVersion} for Jakarta EE - -{ReleaseDate} - -[[sthref1]] - -''''' - -Technology Compatibility Kit User's Guide for {TechnologyFullName}, -Release {TechnologyVersion} for Jakarta EE - -Copyright © {CopyrightDates} Oracle and/or its affiliates. All rights reserved. - -This program and the accompanying materials are made available under -the terms of the Eclipse Public License v. 2.0, which is available at -http://www.eclipse.org/legal/epl-2.0. - -SPDX-License-Identifier: EPL-2.0 - -Oracle and Java are registered trademarks of Oracle and/or its -affiliates. Other names may be trademarks of their respective owners. - -include::title.inc[] - - diff --git a/user_guides/jpa/src/main/jbake/content/title.inc b/user_guides/jpa/src/main/jbake/content/title.inc deleted file mode 100644 index 25bf47e08d..0000000000 --- a/user_guides/jpa/src/main/jbake/content/title.inc +++ /dev/null @@ -1,11 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -This is included at the tail end of the Title page. -The following section should be customized for the technology. -This is provided to allow each technology to customize legacy acronym names -that are used in this TCK. -Be sure to customize LegacyAcronym in attributes.conf -Add additional lines as needed for acronyms found in your TCK user guide. -/////////////////////////////////////////////////////////////////////// - -References in this document to {LegacyAcronym} refer to the {TechnologyFullName} unless otherwise noted. diff --git a/user_guides/jpa/src/main/jbake/content/using-examples.inc b/user_guides/jpa/src/main/jbake/content/using-examples.inc deleted file mode 100644 index b47962f035..0000000000 --- a/user_guides/jpa/src/main/jbake/content/using-examples.inc +++ /dev/null @@ -1,53 +0,0 @@ -/////////////////////////////////////////////////////////////////////// -NOTE TO WRITERS: -These CLI examples can be customized as necessary. -/////////////////////////////////////////////////////////////////////// - -1. Change to any subdirectory under `/src/com/sun/ts/tests`. -2. Start JavaTest using the following command: -+ --- -[source,oac_no_warn] ----- -ant runclient ----- --- - -[[GCMCU]] - -Example 5-1 {TechnologyShortName} TCK Signature Tests - -To run the {TechnologyShortName} TCK signature tests, enter the -following commands: - -[source,subs="attributes"] ----- -cd {sigTestDirectoryExample} -ant runclient ----- - -[[GCMBV]] - - -Example 5-2 Single Test Directory - -To run a single test directory, enter the following commands: - -[source,subs="attributes"] ----- -cd {singleTestDirectoryExample} -ant runclient ----- - -[[GCMCA]] - - -Example 5-3 Subset of Test Directories - -To run a subset of test directories, enter the following commands: - -[source,subs="attributes"] ----- -cd {subsetTestDirectoryExample} -ant runclient ----- diff --git a/user_guides/jpa/src/main/jbake/content/using.adoc b/user_guides/jpa/src/main/jbake/content/using.adoc deleted file mode 100644 index b0a41c51e1..0000000000 --- a/user_guides/jpa/src/main/jbake/content/using.adoc +++ /dev/null @@ -1,323 +0,0 @@ -type=page -status=published -title=Executing Tests -next=debug.html -prev=config.html -~~~~~~ -include::attributes.conf[] -Executing Tests -=============== - -[[GBFWO]] - - -[[executing-tests]] -5 Executing Tests ------------------ - -The {TechnologyShortName} TCK uses the JavaTest harness to execute the -tests in the test suite. For detailed instructions that explain how to -run and use JavaTest, see the JavaTest User's Guide and Reference in -the documentation bundle. - -This chapter includes the following topics: - -* link:#GBFUZ[Starting JavaTest] -* link:#GBFWM[Running a Subset of the Tests] -* link:#GCLRR[Running the TCK Against your selected CI] -* link:#GCLRZ[Running the TCK Against a Vendor's Implementation] -* link:#GBFVK[Test Reports] - - -[NOTE] -======================================================================= - -The instructions in this chapter assume that you have installed and -configured your test environment as described in -link:install.html#GBFTP[Chapter 3, "Installation,"] and -link:config.html#GBFVV[Chapter 4, "Setup and Configuration,"], -respectively. - -======================================================================= - -ifdef::rebuild[] -As explained in link:rebuild.html#GCLIZ[Appendix B, "Packaging the -Test Applications in Servlet-Compliant WAR -Files With VI-Specific Information,"] the {TechnologyShortName} TCK -introduces the concept of repackaging the TCK tests. -endif::rebuild[] - - -[[GBFUZ]][[starting-javatest]] - -5.1 Starting JavaTest -~~~~~~~~~~~~~~~~~~~~~ - -There are two general ways to run the {TechnologyShortName} TCK using -the JavaTest harness software: - -* Through the JavaTest GUI -* From the command line in your shell environment - - -[NOTE] -======================================================================= - -The `ant` command referenced in the following -two procedures and elsewhere in this guide is the Apache Ant -build tool, which will need to be downloaded separately. -The `build.xml` file in `/bin` contains the various Ant -targets for the {TechnologyShortName} TCK test suite. - -======================================================================= - - -[[GBFWH]][[to-start-javatest-in-gui-mode]] - -5.1.1 To Start JavaTest in GUI Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Execute the following commands: - -[source,oac_no_warn] ----- -cd /bin -ant gui ----- - -[[GBFVW]][[to-start-javatest-in-command-line-mode]] - -5.1.2 To Start JavaTest in Command-Line Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -include::using-examples.inc[] - -[[GBFWM]][[running-a-subset-of-the-tests]] - -5.2 Running a Subset of the Tests -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Use the following modes to run a subset of the tests: - -* link:#GBFVT[Section 5.2.1, "To Run a Subset of Tests in GUI Mode"] -* link:#GBFWK[Section 5.2.2, "To Run a Subset of Tests in Command-Line Mode"] -* link:#GBFVL[Section 5.2.3, "To Run a Subset of Tests in Batch Mode -Based on Prior Result Status"] - -[[GBFVT]][[to-run-a-subset-of-tests-in-gui-mode]] - -5.2.1 To Run a Subset of Tests in GUI Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. From the JavaTest main menu, click *Configure*, then click *Change -Configuration*, and then click *Tests to Run*. + -The tabbed Configuration Editor dialog box is displayed. -2. Click *Specify* from the option list on the left. -3. Select the tests you want to run from the displayed test tree, and -then click *Done*. + -You can select entire branches of the test tree, or use `Ctrl+Click` or -`Shift+Click` to select multiple tests or ranges of tests, respectively, -or select just a single test. -4. Click *Save File*. -5. Click *Run Tests*, and then click *Start* to run the tests you selected. + -Alternatively, you can `right-click` the test you want from the test tree -in the left section of the JavaTest main window, and choose *Execute -These Tests* from the menu. -6. Click *Report*, and then click *Create Report*. -7. Specify the directory in which the JavaTest test harness will write -the report, and then click *OK* + -A report is created, and you are asked whether you want to view it. -8. Click *Yes* to view the report. - -[[GBFWK]][[to-run-a-subset-of-tests-in-command-line-mode]] - -5.2.2 To Run a Subset of Tests in Command-Line Mode -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -1. Change to the directory containing the tests you want to run. -2. Start the test run by executing the following command: + -+ -[source] ----- -ant runclient ----- -+ -The tests in the directory and its subdirectories are run. - -[[GBFVL]][[to-run-a-subset-of-tests-in-batch-mode-based-on-prior-result-status]] - -5.2.3 To Run a Subset of Tests in Batch Mode Based on Prior Result Status -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can run certain tests in batch mode based on the test's prior run -status by specifying the `priorStatus` system property when invoking -`ant` - -Invoke `ant` with the `priorStatus` property. - -The accepted values for the `priorStatus` property are any combination -of the following: - -* `fail` -* `pass` -* `error` -* `notRun` - -For example, you could run all the {TechnologyShortName} tests with a -status of failed and error by invoking the following commands: - -[source,oac_no_warn] ----- -ant -DpriorStatus="fail,error" runclient ----- - -Note that multiple `priorStatus` values must be separated by commas. - -[[GCLRR]][[running-the-tck-against-the-ri]] - -5.3 Running the TCK Against another CI -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some test scenarios are designed to ensure that the configuration and deployment of -all the prebuilt {TechnologyShortName} TCK tests against one Compatible -Implementation are successful operating with other compatible implementations, and that the TCK is ready for -compatibility testing against the Vendor and Compatible Implementations. - -1. Verify that you have followed the configuration instructions in -link:config.html#GBFVU[Section 4.1, "Configuring Your Environment to Run -the TCK Against the Compatible Implementation."] -2. If required, verify that you have completed the steps in -link:config.html#GCLIW[Section 4.3.2, "Deploying the Prebuilt Archives."] -3. Run the tests, as described in link:#GBFUZ[Section 5.1, "Starting -JavaTest,"] and, if desired, link:#GBFWM[Section 5.2, "Running a Subset -of the Tests."] - -[[GCLRZ]][[running-the-tck-against-a-vendors-implementation]] - -5.4 Running the TCK Against a Vendor's Implementation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This test scenario is one of the compatibility test phases that all -Vendors must pass. - -1. Verify that you have followed the configuration instructions in -link:config.html#GCLHU[Section 4.2, "Configuring Your Environment to -Repackage and Run the TCK Against the Vendor Implementation."] -2. If required, verify that you have completed the steps in -link:config.html#GCLIL[Section 4.3.3, "Deploying the -Test Applications Against the Vendor Implementation."] -3. Run the tests, as described in link:#GBFUZ[Section 5.1, "Starting -JavaTest,"] and, if desired, link:#GBFWM[Section 5.2, "Running a Subset -of the Tests."] - -[[GBFVK]][[test-reports]] - -5.5 Test Reports -~~~~~~~~~~~~~~~~ - -A set of report files is created for every test run. These report files -can be found in the report directory you specify. After a test run is -completed, the JavaTest harness writes HTML reports for the test run. -You can view these files in the JavaTest ReportBrowser when running in -GUI mode, or in the web browser of your choice outside the JavaTest -interface. - -To see all of the HTML report files, enter the URL of the `report.html` -file. This file is the root file that links to all of the other HTML -reports. - -The JavaTest harness also creates a `summary.txt` file in the report -directory that you can open in any text editor. The `summary.txt` file -contains a list of all tests that were run, their test results, and -their status messages. - -[[GBFWD]][[creating-test-reports]] - -5.5.1 Creating Test Reports -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the following modes to create test reports: - -* link:#GBFVH[Section 5.5.1.1, "To Create a Test Report in GUI Mode"] -* link:#GBFVC[Section 5.5.1.2, "To Create a Test Report in Command-Line Mode"] - -[[GBFVH]][[to-create-a-test-report-in-gui-mode]] - -5.5.1.1 To Create a Test Report in GUI Mode -+++++++++++++++++++++++++++++++++++++++++++ - -1. From the JavaTest main menu, click *Report*, then click *Create Report*. + -You are prompted to specify a directory to use for your test reports. -2. Specify the directory you want to use for your reports, and then -click *OK*. + -Use the Filter list to specify whether you want to generate reports for -the current configuration, all tests, or a custom set of tests. + -You are asked whether you want to view report now. -3. Click *Yes* to display the new report in the JavaTest ReportBrowser. - -[[GBFVC]][[to-create-a-test-report-in-command-line-mode]] - -5.5.1.2 To Create a Test Report in Command-Line Mode -++++++++++++++++++++++++++++++++++++++++++++++++++++ - -1. Specify where you want to create the test report. -a. To specify the report directory from the command line at runtime, -use: -+ -[source] ----- -ant -Dreport.dir="report_dir" ----- -+ -Reports are written for the last test run to the directory you specify. -2. To specify the default report directory, set the `report.dir` -property in +{jteFileName}+. + -For example: -+ -[source] ----- -report.dir="/home/josephine/reports" ----- -+ -3. To disable reporting, set the `report.dir` property to `"none"`, -either on the command line or in +{jteFileName}+. + -For example: -+ -[source] ----- -ant -Dreport.dir="none" ----- -+ - -[[GBFVB]][[viewing-an-existing-test-report]] - -5.5.2 Viewing an Existing Test Report -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Use the following modes to view an existing test report: - -* link:#GBFVO[Section 5.5.2.1, "To View an Existing Report in GUI Mode"] -* link:#GBFWB[Section 5.5.2.2, "To View an Existing Report in -Command-Line Mode"] - -[[GBFVO]][[to-view-an-existing-report-in-gui-mode]] - -5.5.2.1 To View an Existing Report in GUI Mode -++++++++++++++++++++++++++++++++++++++++++++++ - -1. From the JavaTest main menu, click *Report*, then click *Open Report*. + -You are prompted to specify the directory containing the report you want -to open. -2. Select the report directory you want to open, and then click *Open*. + -The selected report set is opened in the JavaTest ReportBrowser. - -[[GBFWB]][[to-view-an-existing-report-in-command-line-mode]] - -5.5.2.2 To View an Existing Report in Command-Line Mode -+++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -Use the Web browser of your choice to view the `report.html` file in the -report directory you specified from the command line or in +{jteFileName}+. - -include::using.inc[] - diff --git a/user_guides/jpa/src/main/jbake/content/using.inc b/user_guides/jpa/src/main/jbake/content/using.inc deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/user_guides/parent/pom.xml b/user_guides/parent/pom.xml index 8377e81232..f67407e692 100644 --- a/user_guides/parent/pom.xml +++ b/user_guides/parent/pom.xml @@ -272,8 +272,8 @@ ${doc.pdf} ${ug.staging.dir} - ${project.build.commonResourcesDirectory}/theme - jakartaee + ${project.build.commonResourcesDirectory}/theme/jakartaee-theme.yml + image:${project.build.commonResourcesDirectory}/theme/jakarta_ee_logo_schooner_color_stacked_default.png[pdfwidth=4.25in,align=right] book ${status} diff --git a/user_guides/parent/src/main/resources/theme/jakarta_ee_logo_schooner_color_stacked_default.png b/user_guides/parent/src/main/resources/theme/jakarta_ee_logo_schooner_color_stacked_default.png new file mode 100644 index 0000000000..97b46ce3e1 Binary files /dev/null and b/user_guides/parent/src/main/resources/theme/jakarta_ee_logo_schooner_color_stacked_default.png differ diff --git a/user_guides/parent/src/main/resources/theme/jakartaee-theme.yml b/user_guides/parent/src/main/resources/theme/jakartaee-theme.yml index 6092a2f5c9..f15f8652e7 100644 --- a/user_guides/parent/src/main/resources/theme/jakartaee-theme.yml +++ b/user_guides/parent/src/main/resources/theme/jakartaee-theme.yml @@ -1,299 +1,134 @@ -# -# Following is the asciidoctor-pdf default theme [1], with small -# customizations, mostly for header and footer, marked "EE". -# -# [1] https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml -# +extends: base +page: + margin: [30,50,30,50] + size: Letter font: catalog: # Noto Serif supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols Noto Serif: - normal: notoserif-regular-subset.ttf - bold: notoserif-bold-subset.ttf - italic: notoserif-italic-subset.ttf - bold_italic: notoserif-bold_italic-subset.ttf + normal: GEM_FONTS_DIR/notoserif-regular-subset.ttf + bold: GEM_FONTS_DIR/notoserif-bold-subset.ttf + italic: GEM_FONTS_DIR/notoserif-italic-subset.ttf + bold_italic: GEM_FONTS_DIR/notoserif-bold_italic-subset.ttf # M+ 1mn supports ASCII and the circled numbers used for conums M+ 1mn: - normal: mplus1mn-regular-ascii-conums.ttf - bold: mplus1mn-bold-ascii.ttf - italic: mplus1mn-italic-ascii.ttf - bold_italic: mplus1mn-bold_italic-ascii.ttf + normal: GEM_FONTS_DIR/mplus1mn-regular-subset.ttf + bold: GEM_FONTS_DIR/mplus1mn-bold-subset.ttf + italic: GEM_FONTS_DIR/mplus1mn-italic-subset.ttf + bold_italic: GEM_FONTS_DIR/mplus1mn-bold_italic-subset.ttf # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font M+ 1p Fallback: - normal: mplus1p-regular-fallback.ttf - bold: mplus1p-regular-fallback.ttf - italic: mplus1p-regular-fallback.ttf - bold_italic: mplus1p-regular-fallback.ttf + normal: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf + bold: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf + italic: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf + bold_italic: GEM_FONTS_DIR/mplus1p-regular-fallback.ttf fallbacks: - M+ 1p Fallback -page: - background_color: ffffff - layout: portrait - margin: [0.5in, 0.67in, 0.67in, 0.67in] - # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress - margin_inner: 0.75in - margin_outer: 0.59in - #size: A4 # EE - size: Letter # EE base: - align: justify - # color as hex string (leading # is optional) - font_color: 333333 - # color as RGB array - #font_color: [51, 51, 51] - # color as CMYK array (approximated) - #font_color: [0, 0, 0, 0.92] - #font_color: [0, 0, 0, 92%] - font_family: Noto Serif - # choose one of these font_size/line_height_length combinations - #font_size: 14 - #line_height_length: 20 - #font_size: 11.25 - #line_height_length: 18 - #font_size: 11.2 - #line_height_length: 16 - font_size: 10.5 - #line_height_length: 15 - # correct line height for Noto Serif metrics - line_height_length: 12 - #font_size: 11.25 - #line_height_length: 18 - line_height: $base_line_height_length / $base_font_size - font_size_large: round($base_font_size * 1.25) - font_size_small: round($base_font_size * 0.85) - font_size_min: $base_font_size * 0.75 - font_style: normal - border_color: eeeeee - border_radius: 4 - border_width: 0.5 -# FIXME vertical_rhythm is weird; we should think in terms of ems -#vertical_rhythm: $base_line_height_length * 2 / 3 -# correct line height for Noto Serif metrics (comes with built-in line height) -vertical_rhythm: $base_line_height_length -horizontal_rhythm: $base_line_height_length -# QUESTION should vertical_spacing be block_spacing instead? -vertical_spacing: $vertical_rhythm -link: - font_color: 428bca -# literal is currently used for inline monospaced in prose and table cells -literal: - font_color: b12146 - font_family: M+ 1mn -menu_caret_content: " \u203a " + font: + color: #151e3d + family: Noto Serif + size: 9 + line-height-length: 11.5 + line-height: $base-line-height-length / $base-font-size +prose: + margin-bottom: 8 +image: + width: 70% + align: center +codespan: + font: + size: 0.94em + family: M+ 1mn + color: #281e5d +code: + font: + size: 0.94em + color: #281e5d + family: M+ 1mn + border-width: 0 + padding: [4,4,4,20] +# background-color: #f7f7f7 +sidebar: + border-width: 0 + title: + align: center +admonition: + label: + vertical-align: top + padding: [4, 8, 4, 8] + column-rule: + style: solid + width: 1 + color: #f0f0f0 + icon: + tip: + stroke-color: #FFC300 + warning: + stroke-color: #FF5733 + caution: + stroke-color: #FF5733 heading: - align: left - #font_color: 181818 - font_color: $base_font_color - font_family: $base_font_family - font_style: bold - # h1 is used for part titles (book doctype) or the doctitle (article doctype) - #h1_font_size: floor($base_font_size * 2.6) # EE - h1_font_size: floor($base_font_size * 2.5) # EE, squeeze title onto one line - # h2 is used for chapter titles (book doctype only) - h2_font_size: floor($base_font_size * 2.15) - h3_font_size: round($base_font_size * 1.7) - h4_font_size: $base_font_size_large - h5_font_size: $base_font_size - h6_font_size: $base_font_size_small - #line_height: 1.4 - # correct line height for Noto Serif metrics (comes with built-in line height) - line_height: 1 - margin_top: $vertical_rhythm * 0.4 - margin_bottom: $vertical_rhythm * 0.9 + font: + color: #001861 + size: 11 + style: bold + line-height: 1.2 + h2-font-size: $base-font-size * 1.3 + h3-font-size: $base-font-size * 1.2 + h4-font-size: $base-font-size * 1.1 + h5-font-size: $base-font-size * 1.0 + margin-bottom: $base-line-height-length +link: + font-color: #002FA7 +list: + indent: $base-font-size * 1.5 + item-spacing: 2 +table: + font-size: 0.94em + caption: + text-align: center + side: top + font-size: 0.94em + grid: + color: #f0f0f0 + style: solid + width: 1 + border: + width: 1 + color: #f0f0f0 + head: + background-color: #f0f0f0 + cell: + padding: 6 +footer: + border-width: 0 +quote: + font-style: italic + font-color: #001861 + font-size: 1.1em + # background-color: #f1f1f1 + border-color: #000000 + border-radius: 2 + border-style: dotted + padding: [10,20,10,25] title_page: align: right logo: top: 10% title: top: 55% - font_size: $heading_h1_font_size + font_size: $heading-h1-font-size font_color: 999999 line_height: 0.9 subtitle: - font_size: $heading_h3_font_size + font_size: $heading-h3-font-size font_style: bold_italic line_height: 1 authors: - margin_top: $base_font_size * 1.25 - font_size: $base_font_size_large + margin_top: $base-font-size * 1.25 + font_size: $base-font-size * 1.25 font_color: 181818 revision: margin_top: $base_font_size * 1.25 -block: - margin_top: 0 - margin_bottom: $vertical_rhythm -caption: - align: left - font_size: $base_font_size * 0.95 - font_style: italic - # FIXME perhaps set line_height instead of / in addition to margins? - margin_inside: $vertical_rhythm / 3 - #margin_inside: $vertical_rhythm / 4 - margin_outside: 0 -lead: - font_size: $base_font_size_large - line_height: 1.4 -abstract: - font_color: 5c6266 - font_size: $lead_font_size - line_height: $lead_line_height - font_style: italic - first_line_font_style: bold - title: - align: center - font_color: $heading_font_color - font_family: $heading_font_family - font_size: $heading_h4_font_size - font_style: $heading_font_style -admonition: - column_rule_color: $base_border_color - column_rule_width: $base_border_width - padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] - #icon: - # tip: - # name: fa-lightbulb-o - # stroke_color: 111111 - # size: 24 - label: - text_transform: uppercase - font_style: bold -blockquote: - font_color: $base_font_color - font_size: $base_font_size_large - border_color: $base_border_color - border_width: 5 - # FIXME disable negative padding bottom once margin collapsing is implemented - padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2] - cite_font_size: $base_font_size_small - cite_font_color: 999999 -# code is used for source blocks (perhaps change to source or listing?) -code: - font_color: $base_font_color - font_family: $literal_font_family - font_size: ceil($base_font_size) - padding: $code_font_size - line_height: 1.25 - # line_gap is an experimental property to control how a background color is applied to an inline block element - line_gap: 3.8 - background_color: f5f5f5 - border_color: cccccc - border_radius: $base_border_radius - border_width: 0.75 -conum: - font_family: M+ 1mn - font_color: $literal_font_color - font_size: $base_font_size - line_height: 4 / 3 -example: - border_color: $base_border_color - border_radius: $base_border_radius - border_width: 0.75 - background_color: ffffff - # FIXME reenable padding bottom once margin collapsing is implemented - padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm] -image: - align: left -prose: - margin_top: $block_margin_top - margin_bottom: $block_margin_bottom -sidebar: - background_color: eeeeee - border_color: e1e1e1 - border_radius: $base_border_radius - border_width: $base_border_width - # FIXME reenable padding bottom once margin collapsing is implemented - padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25] - title: - align: center - font_color: $heading_font_color - font_family: $heading_font_family - font_size: $heading_h4_font_size - font_style: $heading_font_style -thematic_break: - border_color: $base_border_color - border_style: solid - border_width: $base_border_width - margin_top: $vertical_rhythm * 0.5 - margin_bottom: $vertical_rhythm * 1.5 -description_list: - term_font_style: bold - term_spacing: $vertical_rhythm / 4 - description_indent: $horizontal_rhythm * 1.25 -outline_list: - indent: $horizontal_rhythm * 1.5 - #marker_font_color: 404040 - # NOTE outline_list_item_spacing applies to list items that do not have complex content - item_spacing: $vertical_rhythm / 2 -table: - background_color: $page_background_color - #head_background_color: - #head_font_color: $base_font_color - head_font_style: bold - #body_background_color: - body_stripe_background_color: f9f9f9 - foot_background_color: f0f0f0 - border_color: dddddd - border_width: $base_border_width - cell_padding: 3 -toc: - indent: $horizontal_rhythm - line_height: 1.4 - dot_leader: - #content: ". " - font_color: a9a9a9 - #levels: 2 3 -# NOTE in addition to footer, header is also supported -footer: - font_size: $base_font_size_small - # NOTE if background_color is set, background and border will span width of page - #border_color: dddddd # EE - #border_width: 0.25 # EE - height: $base_line_height_length * 2.5 - line_height: 1 - padding: [$base_line_height_length / 2, 1, 0, 1] - vertical_align: top - #image_vertical_align: or - # additional attributes for content: - # * {page-count} - # * {page-number} - # * {document-title} - # * {document-subtitle} - # * {chapter-title} - # * {section-title} - # * {section-or-chapter-title} - recto: - #columns: "<50% =0% >50%" - right: - #content: '{page-number}' # EE - #content: '{section-or-chapter-title} | {page-number}' - #content: '{document-title} | {page-number}' - content: '{document-title}{nbsp}{nbsp}{nbsp} *{page-number}*' # EE - #center: - # content: '{page-number}' - left: # EE - content: '{status}' # EE - verso: - #columns: $footer_recto_columns - left: - #content: $footer_recto_right_content # EE - #content: '{page-number} | {chapter-title}' - content: '*{page-number}* {nbsp}{nbsp}{nbsp}{document-title}' # EE - #center: - # content: '{page-number}' - right: # EE - content: '{status}' # EE -header: # EE - font_size: $base_font_size_small # EE - border_color: dddddd # EE - border_width: 0.25 # EE - height: $base_line_height_length * 2.5 # EE - line_height: 1 # EE - padding: [$base_line_height_length / 2, 1, 0, 1] # EE - vertical_align: top # EE - recto: # EE - right: # EE - content: '{section-or-chapter-title}' # EE - verso: # EE - left: # EE - content: '{section-or-chapter-title}' # EE diff --git a/user_guides/platform/pom.xml b/user_guides/platform/pom.xml index eba86327fd..05c681aa09 100644 --- a/user_guides/platform/pom.xml +++ b/user_guides/platform/pom.xml @@ -37,7 +37,7 @@ ${project.parent.version} - EE + Platform DRAFT diff --git a/user_guides/pom.xml b/user_guides/pom.xml index 1938cdde27..0e93a58f1b 100644 --- a/user_guides/pom.xml +++ b/user_guides/pom.xml @@ -36,7 +36,6 @@ jacc jaxws jms - jpa jsp jstl jta