Generate IP documentation (HTML/ODT) from an IP-XACT component: ports, parameters, bus interfaces, memory maps and registers.
Reads an IP-XACT component XML (or a memoryMaps document) and writes an OpenDocument text file (.odt) describing it: ports, parameters, bus interfaces, memory maps, registers and bit fields, filled into an ODT template. Input revision is IP-XACT 1685-2014 by default; -v2009 / -v2022 select the other revisions (no auto-detection).
Usage
gendocipxact -in <component.xml> [-out <file.odt>] [-v2009 | -v2022] [options]
Every option is listed by gendocipxact -help, and the complete reference is in the capability file that ships with the tool's AGENTS.md.
Exit status
- 0 on a normal finish, including runs that reported errors (missing
-ingives Error 1168 "NULL object passed as component definition XML" and Fatal 5768 "Failed to process", then exit 0). 10 = license checkout failed. 1 =EDAUTILS_ROOTmissing/invalid. - The license is checked before the tool prefix is set, so license-failure lines carry the prefix
DesignPlayerand go toDesignPlayer.log. - Message format:
gendocipxact: <Severity>: <id>: <text>, severity one ofError,Fatal Error,Warning,Note;<id>is a 5-digit message number. Usage lines have no severity or id.
Requirements
Java 11 or newer on PATH (Java 21 recommended), Linux or Windows. Unpack the bundle, run source setup_env.sh and call gendocipxact. Install in one command with curl -fsSL https://edautils.com/install.sh | sh -s -- gendocipxact.