diff options
author | Antonio Borneo <borneo.antonio@gmail.com> | 2020-04-27 16:52:31 +0200 |
---|---|---|
committer | Antonio Borneo <borneo.antonio@gmail.com> | 2020-05-09 14:37:17 +0100 |
commit | 307ee6db473b3e92597ee69863f5428a37a8a941 (patch) | |
tree | abce1e4baeb03eeb90b8a936d42fbb735aca525f | |
parent | 4738a55da416176542efa1b554020de275a5b4e5 (diff) | |
download | riscv-openocd-307ee6db473b3e92597ee69863f5428a37a8a941.zip riscv-openocd-307ee6db473b3e92597ee69863f5428a37a8a941.tar.gz riscv-openocd-307ee6db473b3e92597ee69863f5428a37a8a941.tar.bz2 |
doc: fix texinfo warning on @deffn not at the line beginning
Commit 87a4158acf56 ("drivers: xds110: Clean up command syntax and
documentation") does not follow the documentation structure that
lists the adapters in cpt 2 "Debug Adapter Hardware" then lists
the adapter commands in cpt 8.2 "Interface Drivers"; it puts all
in cpt 2.
While doing that, uses an incorrect texinfo syntax that causes the
following warnings at compile time:
doc/openocd.texi:543: warning: @deffn should only appear at the beginning of a line
doc/openocd.texi:547: warning: @deffn should only appear at the beginning of a line
doc/openocd.texi:552: warning: @deffn should only appear at the beginning of a line
Move the documentation of xds110 commands in the proper chapter
and fix the texinfo syntax.
Change-Id: I0b3f0fe0c687f194bb02e2d81aca86fcd4fdd718
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Fixes: 87a4158acf56 ("drivers: xds110: Clean up command syntax and documentation")
Reviewed-on: http://openocd.zylin.com/5613
Tested-by: jenkins
Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
Reviewed-by: Edward Fewell <efewell@ti.com>
-rw-r--r-- | doc/openocd.texi | 41 |
1 files changed, 23 insertions, 18 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index 2dbe770..f3f963e 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -536,24 +536,6 @@ debuggers to ARM Cortex based targets @url{http://www.keil.com/support/man/docs/ @* Link: @url{http://www.keil.com/ulink1/} @item @b{TI XDS110 Debug Probe} -@* The XDS110 is included as the embedded debug probe on many Texas Instruments -LaunchPad evaluation boards. The XDS110 is also available as a stand-alone USB -debug probe with the added capability to supply power to the target board. The -following commands are supported by the XDS110 driver: -@*@deffn {Config Command} {xds110 serial} serial_string -Specifies the serial number of which XDS110 probe to use. Otherwise, the first -XDS110 found will be used. -@end deffn -@*@deffn {Config Command} {xds110 supply} voltage_in_millivolts -Available only on the XDS110 stand-alone probe. Sets the voltage level of the -XDS110 power supply. A value of 0 leaves the supply off. Otherwise, the supply -can be set to any value in the range 1800 to 3600 millivolts. -@end deffn -@*@deffn {Command} {xds110 info} -Displays information about the connected XDS110 debug probe (e.g. firmware -version). -@end deffn -@* Further information can be found at the following sites: @* Link: @url{https://software-dl.ti.com/ccs/esd/documents/xdsdebugprobes/emu_xds110.html} @* Link: @url{https://software-dl.ti.com/ccs/esd/documents/xdsdebugprobes/emu_xds_software_package_download.html#xds110-support-utilities} @end itemize @@ -3141,6 +3123,29 @@ opendous-jtag is a freely programmable USB adapter. This is the Keil ULINK v1 JTAG debugger. @end deffn +@deffn {Interface Driver} {xds110} +The XDS110 is included as the embedded debug probe on many Texas Instruments +LaunchPad evaluation boards. The XDS110 is also available as a stand-alone USB +debug probe with the added capability to supply power to the target board. The +following commands are supported by the XDS110 driver: + +@deffn {Config Command} {xds110 serial} serial_string +Specifies the serial number of which XDS110 probe to use. Otherwise, the first +XDS110 found will be used. +@end deffn + +@deffn {Config Command} {xds110 supply} voltage_in_millivolts +Available only on the XDS110 stand-alone probe. Sets the voltage level of the +XDS110 power supply. A value of 0 leaves the supply off. Otherwise, the supply +can be set to any value in the range 1800 to 3600 millivolts. +@end deffn + +@deffn {Command} {xds110 info} +Displays information about the connected XDS110 debug probe (e.g. firmware +version). +@end deffn +@end deffn + @deffn {Interface Driver} {xlnx_pcie_xvc} This driver supports the Xilinx Virtual Cable (XVC) over PCI Express. It is commonly found in Xilinx based PCI Express designs. It allows debugging |