Skip to content

Commit ee5fa8e

Browse files
committed
Update docs
1 parent db430e6 commit ee5fa8e

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

docs/_plugins/jdoc_namespace_tag.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ def self.parse_fqcn(fqcn, var_ctx, allow_sym = true)
102102
RESERVED_NSPACES = ['apex', 'core', 'cpp', 'cs', 'dart', 'dist', 'doc', 'fortran', 'go', 'groovy', 'java',
103103
'javascript', 'jsp',
104104
'kotlin', 'lua', 'matlab', 'objectivec', 'perl', 'php', 'plsql', 'python', 'ruby', 'scala', 'swift',
105-
'test', 'ui',
105+
'test', 'test-schema', 'ui',
106106
'modelica', 'visualforce', 'vm', 'xml'].flat_map {|m| [m, "pmd-" + m]}
107107

108108
def self.make_base_namespaces

docs/pages/pmd/userdocs/extending/testing.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,18 @@ between different test cases.
135135

136136
The `<test-code>` elements understands the following optional attributes:
137137

138-
* **reinitializeRule**: By default, it's `true`, so each test case starts with a fresh instantiated rule. Set it
139-
to `false` to reproduce cases, where the previous run has influences.
138+
* **disabled**: By default, it's `false`. Set it to `true`, to ignore and skip a test case.
140139

141-
* **disabled**: By default, it's `false`. Set ti to `true`, to ignore and skip a test case.
140+
* **focused**: By default, it's `false`. Set it to `true`, to ignore all other test cases.
142141

143-
* **useAuxClasspath**: By default, it's `true`. Set it to `false` to reproduce issues which only
142+
* **useAuxClasspath**: _deprecated since PMD 6.48.0: assumed true, has no effect anymore._
143+
By default, it's `true`. Set it to `false` to reproduce issues which only
144144
appear without type resolution.
145145

146+
* **reinitializeRule**: _deprecated since PMD 6.48.0: assumed true, has no effect anymore._
147+
By default, it's `true`, so each test case starts with a fresh instantiated rule. Set it
148+
to `false` to reproduce cases, where the previous run has influences.
149+
146150
* **regressionTest**: _deprecated since PMD 6.48.0: Use `disabled` instead. Note: It has the opposite boolean
147151
semantic._ By default, it's `true`. Set it to `false`, to ignore and skip a test case.
148152

docs/pages/release_notes.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Being based on a proper Antlr grammar, CPD can:
5454
* java-performance
5555
* [#3625](https://github.com/pmd/pmd/issues/3625): \[java] AddEmptyString - false negative with empty var
5656
* test
57+
* [#3302](https://github.com/pmd/pmd/pull/3302): \[test] Improve xml test schema
5758
* [#3758](https://github.com/pmd/pmd/issues/3758): \[test] Move pmd-test to java 8
5859
* [#3976](https://github.com/pmd/pmd/pull/3976): \[test] Extract xml schema module
5960

@@ -65,8 +66,12 @@ Being based on a proper Antlr grammar, CPD can:
6566
this module for testing your own custom rules, you'll need to make sure to use at least Java 8.
6667
* The new module "pmd-test-schema" contains now the XSD schema and the code to parse the rule test XML files. The
6768
schema has been extracted in order to easily share it with other tools like the Rule Designer or IDE plugins.
68-
* The attribute `isRegressionTest` is deprecated and the new attribute `disabled` should be used instead for
69-
defining whether a rule test should be skipped or not.
69+
* Test schema changes:
70+
* The attribute `isRegressionTest` of `test-code` is deprecated. The new
71+
attribute `disabled` should be used instead for defining whether a rule test should be skipped or not.
72+
* The attributes `reinitializeRule` and `useAuxClasspath` of `test-code` are deprecated and assumed true.
73+
They will not be replaced.
74+
* The new attribute `focused` of `test-code` allows disabling all tests except the focused one temporarily.
7075
* More information about the rule test framework can be found in the documentation:
7176
[Testing your rules](pmd_userdocs_extending_testing.html)
7277

@@ -77,6 +82,8 @@ Being based on a proper Antlr grammar, CPD can:
7782
but it is no longer supported with Java 19 Preview.
7883
* The interface {% jdoc core::cpd.renderer.CPDRenderer %} is deprecated. For custom CPD renderers
7984
the new interface {% jdoc core::cpd.renderer.CPDReportRenderer %} should be used.
85+
* The class {% jdoc test::testframework.TestDescriptor %} is deprecated, replaced with {% jdoc test-schema::testframework.RuleTestDescriptor %}.
86+
* Many methods of {% jdoc test::testframework.RuleTst %} have been deprecated as internal API.
8087

8188
#### Experimental APIs
8289

0 commit comments

Comments
 (0)