# ipxactlint

> Lint IP-XACT (IEEE 1685-2009/2014/2022) documents against the Semantic Consistency Rules of IEEE 1685 Annex B and the schema identity constraints XSD validation does not enforce; every finding names the file, line, SCR and a fix, with waiver files and CI exit codes.

- Catalog id: `Ipxactlint`; bundle: `ipxactlint`; latest version 20261018
- Documentation page: https://edautils.com/ipxactlint.html
- Keywords: IP-XACT lint, IEEE 1685 semantic consistency rules, SCR checker, IP-XACT 2009 2014 2022, register map checker
- Terms: as stated on edautils.com, EDAUtils tools are free for commercial and academic use, with no license server. The bundle's own metadata says: "Free to evaluate with the bundled licence; commercial licences from help@edautils.com". Licence prerequisites per tool are under "How an agent runs it".
- This file: https://edautils.com/capabilities/ipxactlint.md

## Downloads

- EDAUtils download site: https://edautils.ai/download/Ipxactlint (latest file `ipxactlint-20261018.tar.gz`)
- SourceForge: https://sourceforge.net/projects/ip-xact-tools/files/ipxactlint/
- SourceForge: https://sourceforge.net/projects/edautils-free-utilities/files/ipxactlint/
- GitHub Releases: https://github.com/edautils/releases/releases/download/RELEASE_20261018/ipxactlint-20261018.tar.gz (release `RELEASE_20261018`; all releases: https://github.com/edautils/releases/releases)

## How an agent runs it

The following is the AGENTS.md shipped at the root of the bundle.

IP-XACT linter. Checks IP-XACT XML documents of IEEE 1685-2009, 1685-2014 and 1685-2022 --
component, design, design configuration, bus definition, abstraction definition, abstractor,
catalog, generator chain -- against the semantic consistency rules (SCRs) of IEEE 1685 Annex B,
plus the schemas' name-uniqueness and local-reference constraints, which an XSD or JAXB load does
not check, plus (1685-2022 documents only) the EDAUtils `EU-2022-*` rules on what 1685-2022 added. Every finding names the file, line, rule number and rule name, what is wrong (the
elements and values involved) and how to fix it. Violations can be waived with a reason through
waiver files; waived violations are listed in a waiver report, and a waiver file for the next run
can be generated.

It is the `-lint` mode of validateipxact (see its AGENTS.md) as a tool of its own: own log
(`ipxactlint.log`), banner and exit status, `-lint` implied, lint options only.

Main class: `com.eu.miscedautils.ipxactlint.ipxactlint` (jar `lib/validateipxact.jar`).

### Where it ships

Its own bundle, `ipxactlint.tar.gz` (flow `ipxactlint`; release tree
`release_scripts/ipxactlint/1.0`), and as a point tool in the **ipxact-shell** and
**designplayer-shell** bundles (`bin/ipxactlint` running the shell's jar; this guide as
`tools/ipxactlint/AGENTS.md`, examples under `tools/ipxactlint/examples/`).

### Prerequisites

- Java 11 or newer on `PATH` (Java 21 recommended); `source setup_env.sh` (or `setup_env.csh`,
  `setup_env.bat`) from the bundle root finds or offers to install one.
- `EDAUTILS_ROOT` = the unpacked bundle directory (must contain `bin/` and `lib/`); the launcher
  exits 1 with "Environment variable EDAUTILS_ROOT is not set" otherwise. `setup_env` sets it,
  `EDAUTILS_LICENSE_FILE=$EDAUTILS_ROOT/edautils.lic`, and prepends `bin/` to `PATH`.
- Licence feature `IPXACTLINT`, also granted by an ipxact-shell (`IPXACTBACKBONE`) or designplayer-shell
  (`DESIGNPLAYERBACKBONE`) licence. The licence file is searched in
  this order: `$EDAUTILS_LICENSE_FILE`, `./edautils.lic`, `$HOME/edautils.lic`,
  `$EDAUTILS_ROOT/edautils.lic`. No licence for the feature: exit status 10.
- Optional environment: `JAVA_FLAGS` (JVM options, e.g. `-Xmx8g`; with no heap option in it
  the launcher adds `-Xmx` sized to the machine: `bin/eu_heap.sh`, the largest of 64/32/16/12/8/4 GB
  within 3/4 of physical or cgroup memory, else 2 GB; `EDAUTILS_MAX_HEAP_GB` caps it), `EDAUTILS_LOG_FILE` / `EDAUTILS_APPEND_LOG_FILE`,
  `EDAUTILS_DISABLE_USAGE_TRACKING=true`, `EDAUTILS_PRINT_STACK_TRACE`.
- No schemas, no network, no external tools.

### Invocation

```
ipxactlint -in <file.xml | directory> [-lib <file | directory>]...
           [-waiver <file>]... [-waive_all] [-waiver_report <file>] [-gen_waivers <file>]
           [-nobanner] [-quiet] [-user <email>]
ipxactlint -lint_rules
ipxactlint -help
```

| Option | Meaning |
|---|---|
| `-in <file or dir>` | Required. The document to lint, or a directory: every IP-XACT `.xml` under it is linted (non-IP-XACT `.xml` files are skipped), and the directory also serves as the library |
| `-lib <file or dir>` | Repeatable: IP-XACT documents the input references (bus/abstraction definitions, components, designs, abstractors), searched recursively for `.xml`. Enables the cross-document rules |
| `-waiver <file>` | Repeatable: waiver file (see "Waivers"). A covered violation becomes a `Waived` Note, is not counted, and is listed in the waiver report |
| `-waive_all` | Waive every violation; all go to the waiver report, and a waiver file covering them is written (`ipxactlint.waivers` unless `-gen_waivers` names it) |
| `-waiver_report <file>` | Waiver report path (default `ipxactlint_waived.rpt`; written when a waiver file is given or with `-waive_all`) |
| `-gen_waivers <file>` | Write a waiver file with one waiver per violation of this run (waived or not), for `-waiver` next time |
| `-lint_rules` | Print every rule: its number in 1685-2014 (also used for 2022), in 1685-2009 (`-` = not in that standard), its name and how to fix a violation; then the `EU-2022-*` rules with id, name, fix and source; then exit |
| `-nobanner` | No banner and no completion summary |
| `-quiet` | Silence every later message (log included) |
| `-user <email>` | Usage-tracking user id |
| `-help` | Usage; exit status 1 |

### Exit status

| Status | Meaning |
|---|---|
| 0 | No lint errors (warnings and waived violations do not fail) |
| 2 | Lint errors found |
| 1 | Usage error (unknown option, no `-in`), an input, library or waiver file that does not exist or cannot be read, a malformed waiver line, or an internal error |
| 10 | No licence for `IPXACTLINT` (nor an ipxact-shell or designplayer-shell licence) |

### Outputs

- `ipxactlint.log` in the current directory: the findings and the summary
  `Found N error(s) and M warning(s)` (N counts errors not waived, including input errors).
- The waiver report and generated waiver file, when asked for (above).

### What it checks

ipxactlint reads documents as plain XML (no JAXB binding), so one rule implementation serves every
revision. Each rule carries its number in each standard, and is reported under the number of the
document's own standard; a rule that one standard does not have is not applied to its documents.

- **1685-2009** (`spirit` 1685-2009 namespace; SPIRIT 1.4/1.5 documents are treated the same):
  the 1685-2009 Annex B rules, 2009 numbering (e.g. `SCR 6.26 CantDriveOutputPort`).
- **1685-2014**: the 1685-2014 Annex B rules, 2014 numbering (`SCR 6.24 CantDriveOutputPort`).
- **1685-2022**: the 2022 standard's own Annex B is not available to this tool (the reference used
  is the 2022 User Guide and release notes), so 2022 documents get the 1685-2014 rules under 2014
  numbers, with the 2022 renames mapped (initiator/target, `accessPolicies`/`fieldAccessPolicies`,
  `array/dim`, `componentInstanceRef`, `initiatorRef`, clearbox for whitebox) and the 2022 value
  types (e.g. `dim` and memory `width` positive, `clockPulseValue` a bit). The access restriction
  rules SCR 8.3-8.15 are not applied: 2022 filters a child's access by its parents' instead (2022
  release notes). On top, the `EU-2022-*` rules below check what 2022 added. A Note says so for
  every 2022 document.
- **K.1 uniqueNames / K.2 localRefExists**: the schemas' identity constraints (names unique in
  their scope; `memoryMapRef`, `addressSpaceRef`, `masterRef`, port, view, fileSet, choice,
  remapState/mode, resetType ... references resolve). A JAXB load does not check these.

#### 1685-2022 rules (`EU-2022-*`)

The 1685-2022 Annex B (its SCRs) is not available to this tool -- it is behind the IEEE login -- so
no IEEE SCR number is ever invented for 2022. What 1685-2022 added is checked by EDAUtils rules
**derived from the 1685-2022 schema, the Accellera IP-XACT 2022 User Guide and the IP-XACT 2022
release notes, pending Annex B**. They have ids `EU-2022-<area>-<n>` that cannot be mistaken for an
IEEE number, apply to 1685-2022 documents only, and are reported as
`EU-2022-<area>-<n> <ruleName>: ...` (no `SCR`). `-lint_rules` lists each with its fix and source.
When Annex B becomes available each one is replaced by the SCR it corresponds to (the code marks
where: `Rules2022.java`, `IPXACTLint.RULES_2022`). Sources: XSD = `1685-2022/*.xsd`; UG = User
Guide, printed page; RN = release notes, by heading.

| Id | Rule name | Checks | Source |
|---|---|---|---|
| EU-2022-MODE-1 | modeConditionRefsExist | `$ipxact_port_value(x)`/`$ipxact_field_value(x)` in a mode condition name a portSlice/fieldSlice of that mode; `$ipxact_mode_condition(m)` names a mode of the component | UG 3.2.4 p.53; RN "Operating mode specific register access", "Expression" |
| EU-2022-MODE-2 | sliceRefsExist | portSlice `portRef` (and `subPortReference` path), fieldSlice path, `modeReference/@modeRef` resolve in the component | XSD keyrefs portSlicePortRef, componentModeLinkModeRef; fieldSliceReferenceGroup |
| EU-2022-ACC-1 | modeRefPriorityUnique | modeRef priorities unique within accessPolicies, fieldAccessPolicies, accessRestrictions, memoryRemap, alternateRegister | UG 3.2.4 p.54; XSD *PriorityUnique |
| EU-2022-ACC-2 | singleDefaultAccessPolicy | at most one accessPolicy (fieldAccessPolicy) without modeRef | UG 3.2.4 p.54 |
| EU-2022-ACC-3 | accessFilteredByParent | **Warning**: a declared access that a container's access narrows (2022 applies the containers' accesses as filters), per mode and with no mode active -- what SCR 8.3-8.15 made an error in 2014 | RN "Operating mode specific register access", "Register file access" |
| EU-2022-ACC-4 | readResponseNeedsRead | a readResponse only in a readable access policy | RN "No access and read response" |
| EU-2022-PWR-1 | powerDomainRefExists | `powerDomainRef`, `subDomainOf`, `isPowerEn/@powerDomainRef` name a powerDomain of the component | RN "Power"; XSD keyrefs powerDomainRef, powerEnQualifierPowerDomainRef |
| EU-2022-PWR-2 | powerDomainLinkRefsExist | design: an instance links each of its power domains once, to a domain its component declares, and (with `-lib`) to a domain of the hierarchical component | RN "Power"; XSD componentInstanceInternalPowerDomainReferenceUnique |
| EU-2022-PORT-1 | subPortNamesUnique | subPort names unique within a structured port | XSD structuredPortUnique |
| EU-2022-PORT-2 | portMapLeafWire | a port map reaches a leaf wire subPort of a structured port, through existing subPorts | RN "SystemVerilog interface connectivity ..."; UG 3.2.5 p.56 |
| EU-2022-PORT-3 | typeDefViewRefUnique | one domainTypeDef / signalTypeDef per view | XSD domainTypeDefsKey, signalTypeDefsKey |
| EU-2022-PKT-1 | packetFieldValueRefsExist | `$ipxact_absdefport_value(p)` names a logical port of the abstraction definition, `$ipxact_packetfield_value(f)` a packetField of the same logical port | RN "Serial and multiplexed protocols", "Expression" |
| EU-2022-ARR-1 | strideCoversElement | an array's stride (bitStride) is at least one element long | RN "Arrays and strides" |
| EU-2022-ARR-2 | indexVarUnique | the dims of one array have distinct indexVar names | XSD *DimIndexVarUnique |
| EU-2022-ARR-3 | indexVarRefExists | `$ipxact_index_value(v)` names an indexVar of the element's array or an enclosing one | RN "Index variables", "Access handles" |
| EU-2022-EXPR-1 | ipxactFunctionContext | the `$ipxact_*()` functions only where allowed (mode condition; packetField value; displayName, shortDescription, description, pathSegment), and no unknown `$ipxact_` function | RN "Expression", "Index variables", "Access handles" |
| EU-2022-MAP-1 | allBitsMapped2022 | every bit of a logical port whose width has `allBits="true"` is mapped | UG 3.1.3 p.18; RN "Connectivity rules" |
| EU-2022-MAP-2 | matchLogicalBits | a `match=true` logical port is mapped, with the same logical bits, on every end of an interconnection that uses its abstraction (needs `-lib`) | UG 5.2 p.67; RN "Connectivity rules"; XSD port/match |
| EU-2022-CPU-1 | regionWithinCpu | a cpu region lies inside the cpu's range | RN "CPU memory map" |
| EU-2022-FLD-1 | fieldAliasRefExists | aliasOf / broadcastTo reach an existing field | RN "Field aliasing and broadcasting" |
| EU-2022-DOC-1 | shortDescriptionCompact | **Warning**: a shortDescription not shorter than its description | RN "Short description and top-level displayName" |
| EU-2022-TD-1 | typeDefinitionsRefExists | a `typeDefinitions` attribute names an externalTypeDefinitions of the component | XSD keyref componentTypeDefinitionsRef |

A modeRef that names no mode is K.2 (localRefExists), as in 2014. Not checked: `$sformatf`
contexts, the contents of `typeDefinitions` documents and `...DefinitionRef`s, power-domain
hierarchy cycles, mode conditions' satisfiability.

#### Rule coverage

`-lint_rules` lists every rule with its fix hint. Implemented: all 224 SCRs of 1685-2014 and all
175 of 1685-2009, plus K.1/K.2, across every table: B.1 cross-references, B.2 interconnections,
B.3 channels/bridges/abstractors, B.4 monitors, B.5 configurable elements and parameters
(1685-2009: XPath dependencies), B.6 port maps, ports and port connection equivalence classes,
B.7 registers and fields, B.8 memory maps, B.9 addressing, B.10 hierarchical families, B.11
hierarchical memory maps, B.12 constraints, B.13 design configurations, B.14 expression value
types (1685-2009: rules needing external knowledge), B.15 presence (`isPresent`), B.16 access
handles. Every rule has at least one failing regression case, the 22 `EU-2022-*` rules included.

Cross-document rules need the referenced documents: give them with `-lib`, or lint a directory
(`-in dir` makes everything under it both input and library). Without either, a Note says the
cross-document rules are skipped -- and SCR 1.2 (`anyVLNVRefMustExist`, a VLNV that matches no
document) is reported only when a library was given.

Expressions (2014/2022) are evaluated as SystemVerilog: based literals (`'h10`, `8'b1010`),
operators, `?:`, `$clog2`, `$pow`, parameter references by `parameterId`. 2009 values are read as
literals (`0x10`, `#10`, `4K`). A value that cannot be resolved (a real, `x`/`z` digits, an unknown
system function, a parameter defined elsewhere) skips the numeric checks that need it.
Parameters with no `type` (it defaults to `string`) or `type="string"` are not parsed for SCR
5.17/5.18. `0x...` in a 2014/2022 value is SCR 5.17 (`0x` is C, not SystemVerilog).

Rules are judged on the values as written -- default values, before configuration. When an
address/size/offset check (overlaps, fits, widths) rests on a parameter with `resolve="user"` or
`"generated"`, it is reported as a **Warning** ending "(with the default values of configurable
parameters)", since configuration can change the verdict. EU-2022-ACC-3 and EU-2022-DOC-1 are
Warnings. Everything else is an Error.

Message format: `ipxactlint: Error: <id>: <file>:<line>: SCR <n> <ruleName>: <text>. Fix: <how>`
(or `K.<n> <ruleName>`, or `EU-2022-<area>-<n> <ruleName>` for the 1685-2022 rules). File is as given on the command line; line is the offending element's.
`<text>` names the elements and values involved; `Fix:` says what to change (the same per-rule
hint `-lint_rules` prints). Message ids: 12300 (+ the log's base offset) error, 12301 warning
(also a stale waiver), 12302 note (also each waived violation), 12303 a file that does not exist, cannot be read,
is not XML, or is not IP-XACT, and a bad waiver-file line.

### Waivers

A waiver file has one waiver per line (`#` comments), in the key=value style of the CDC/RDC
checkers' waiver files; a value with spaces is double-quoted, `\"` and `\\` escape inside quotes:

```
rule=RegisterOverlap file=comp.xml reason="r1 aliases r0 by design" owner=kanai
rule="SCR 6.19" reason="paddr width comes from a generic set upstream"
rule=7.4 msg="field 'f2' *" reason="f2 spills into the next register on purpose"
rule=* file=*.xml line=315 reason="po is driven in test mode only"
```

| Key | Meaning |
|---|---|
| `rule` | Required. Rule name, its number in the document's standard (`7.1`, `SCR 7.1`, `K.1`), an `EU-2022-*` id, or `*` |
| `file` | Glob (`*`, `?`) over the document path as given, or its file name. Default `*` |
| `line` | Line of the finding. Default: any |
| `msg` | Glob over the finding text (the part after `<ruleName>: `, without `Fix:`). Default `*` |
| `reason` | Required: why the violation is acceptable |
| `owner` | Optional |

The first matching waiver wins. A waived violation is printed as
`Note: <id>: Waived error: <finding> [waived by <waiverfile>:<line> (<reason>; owner: <owner>)]`
and is not counted in `Found N error(s)`. A line with an unknown rule or key, no `reason`, or a
non-numeric `line` is an Error naming the waiver file and line, and that waiver is ignored. A
waiver that matches nothing is a Warning ("stale"): its violation was fixed or renamed.

The waiver report (default `ipxactlint_waived.rpt`) lists every waived violation with the waiver (or `-waive_all`) that waived it,
the stale waivers, and the count of violations not waived. The generated waiver file
(`-gen_waivers`, or `-waive_all`, default `ipxactlint.waivers`) has one line per distinct violation with `rule`, `file` and the
exact `msg` (line numbers inside the text globbed to `line *`, so edits elsewhere do not make it
stale); violations already waived keep their reason and owner, new ones get
`reason="TODO: why this violation is acceptable"` -- replace it before relying on the file.
Typical flow: `-waive_all` once, review the generated file, delete the lines for violations to be
fixed, then run with `-waiver <file> -gen_waivers <file>` to keep it current.

How the rules that look beyond one element judge:

- **Port connection equivalence classes** (B.1.6; SCR 6.9, 6.10, 6.14 of 1685-2009, 2.13 of
  1685-2009) are built per bit from bus interface port maps, interconnections between interfaces
  of the same abstraction and ad hoc connections, within one design. A port of the containing
  component is seen from inside: an input drives, requires and provides swap. SCR 6.9/6.10 use the
  whole class, so masters that reach one shared port of a bus component count as connected; SCR
  6.23/6.25 compare only ports connected directly (one interconnection or ad hoc connection), with
  the compatibility definitions of SCR 6.23 a)-f).
- **Hierarchical memory maps** (SCR 11.1-11.4) compare the memory map a hierarchical slave
  interface references with the one of the sub-instance interface it exports: visible addresses,
  subspace windows (masters matched through their own hierarchical families), the behaviour of
  every register bit (access, volatile, reset, modifiedWriteValue, readAction, testable) and, for
  1685-2009, aliases. Addresses are compared in bits, so members with different addressUnitBits
  compare.
- **Value types** (Table B.14) come from each version's schema, per context where one name has
  several types (`baseAddress`, `width`, `value`, `busWidth`, `dim` ...). A string type needs a
  quoted SystemVerilog string (or a string parameter); a file name (stringURIExpression) may be an
  unquoted path, but without spaces or backslashes. A bit vector must fit the field or port it
  sizes.
- **1685-2009 dependencies** (SCR 5.2-5.5) are compiled with the JDK's XPath 1.0 engine (the
  spirit:decode/pow/log/containsToken extensions accepted); id() targets are resolved in the
  document. SCR 14.2 checks that the vendor has the shape of a domain name; ownership cannot be
  checked.

Limits: the 2014 rules read a 2022 element's access from its policy without a `modeRef` (EU-2022-ACC-3
compares the accesses per mode); a 1685-2022 register or register file array whose stride leaves gaps
occupies only its elements for SCR 7.1 (up to 4096 elements; bigger arrays keep their whole extent);
2022 `typeDefinitions` and `...DefinitionRef` contents are not resolved; equivalence classes do not
cross hierarchy levels; parameters with no `type` (it defaults to string) are not checked for casts.

### Examples

Shipped in `examples/` (run each `runme.csh` from inside its directory; `runme.bat` where noted).
Every `runme.csh` exits 0 only when its expected result holds, so each doubles as a check:

| Example | Command | Expected |
|---|---|---|
| `clean` (csh, bat) | `ipxactlint -in uart.xml -lib lib` | a 1685-2014 UART register block: exit 0, `Found 0 error(s)` |
| `findings` (csh, bat) | `ipxactlint -in uart.xml -lib lib` | the same UART with 5 planted mistakes (K.2, SCR 6.6, 7.1, 7.4, 8.5): exit 2, `Found 5 error(s)` |
| `waivers` (csh, bat) | `ipxactlint -in uart.xml -lib lib -waiver uart.waivers -gen_waivers next.waivers` | the 5 findings waived with reasons: exit 0, report `Waived violations: 5` |
| `soc_2014` (csh, bat) | `ipxactlint -in soc -lib lib` | 1685-2014 SoC subsystem: RV32 core on AXI4-lite, AXI4-lite-to-APB bridge, UART, GPIO, timer, interrupts by ad hoc connection: exit 0, `Found 0 error(s)` |
| `legacy_2009` (csh, bat) | `ipxactlint -in library` | the same IPs and design as a 1685-2009 (spirit) component library, linted as a directory: exit 0, `Found 0 error(s)` |
| `dmac_2022` (csh, bat) | `ipxactlint -in soc -lib lib` | 1685-2022 version plus DMAC-4 (modes with port/field slices and `$ipxact_*()` conditions, mode-specific access policies, no-access, readResponse, strided register arrays with indexVar, a field alias, power domains linked in the design, a structured port; `match`/`allBits` in the APB abstraction): exit 0, `Found 0 error(s)` |
| `waiver_flow` (csh) | `-gen_waivers review.waivers`, review (accept two warnings, drop the error's line), `-waiver accepted.waivers` | DMAC-4 rev B (EU-2022-DOC-1, ACC-3 warnings; ACC-1 error): final run exit 2, `Found 1 error(s) and 0 warning(s)`, `Waived violations: 2` |
| `ci_gate` (csh, sh) | `sh lint_gate.sh gate.list` | a CI gate over four trees, deciding on ipxactlint's exit status, one log per entry under `work/` (via `EDAUTILS_LOG_FILE`) and `gate_summary.txt`; `uart_findings` is declared `expect=2` in `gate.list` (planted mistakes the gate must catch), so it reports `EXPECTED` and the gate exits 0, `GATE: PASS`; an entry that misses its `expect=` fails the gate |

`lib/` directories hold the bus/abstraction definitions and components the inputs reference
(`example.com:bus:apb:1.0`, `axi4lite`, `simplebus` ...). `waiver_flow` and `ci_gate` use the other
examples through `../`, so keep the examples directory together. In the ipxact-shell and
designplayer-shell bundles the same examples are under `tools/ipxactlint/examples/`.

Regression suite: `tests.edautilscommandline/tests/ipxactlint` -- clean, findings, waivers,
`-waive_all`, malformed waiver file, directory input, missing `-in`, bad option, missing,
unreadable and not-well-formed input (exit 1), `-lint_rules` listing, clean 1685-2009/2014/2022
SoC subsystems (directory input, `-in dir -lib dir`), clean real-world sets (the verilog2ipxact
i2c designs in 2014 and 2022, the Leon2 1685-2009 I2C channel library), the 31-document Leon2
1685-2014 sample with its missing-library references waived (26 findings kept), and waivers of
EU-2022 rules by id, name and message glob with a stale waiver. Each checks the exit status and
compares the `Error`/`Warning` lines of `ipxactlint.log`, and where written the waiver report and
generated waiver file, with `.gld` copies. The rule-by-rule cases are the `lint_*` cases of
`tests/validateipxact` (`lint_eu2022_component`, `lint_eu2022_design` for the EU-2022 rules).

### Integration notes

- Non-interactive; does not read stdin. Run with `</dev/null`.
- Writes its log and reports into the current directory: give each parallel run its own working
  directory (or a distinct `EDAUTILS_LOG_FILE`).
- Result test: the exit status. For the findings, read the `Error:`/`Warning:` lines of the log
  (format above); each ends with `. Fix: <what to change>`.
- To fix a finding: open `<file>` at `<line>`, apply the `Fix:` hint, re-run. Waive only with a
  reason someone has agreed to; never rely on a generated `TODO` reason.

### See also

validateipxact (same engine; also the JAXB-based semantic check and `-sanity`), upgradeipxact,
verilog2ipxact / vhdl2ipxact (generate components to lint), ipxact-shell.
