Hi all:

OpenOCD's manual is written in Texinfo format:

https://sourceforge.net/p/openocd/code/ci/master/tree/doc/openocd.texi

An example of the generated PDF is here:

http://openocd.org/doc-release/pdf/openocd.pdf

When generating the PDF on my computer, I get some warnings like these:

Underfull \hbox (badness 10000) in paragraph at lines 525--528
 []@textrm Link: [][]@texttt https://  software-dl.  ti.  com/  ccs/  esd/  doc
uments/  xdsdebugprobes/

Underfull \hbox (badness 10000) in paragraph at lines 525--528
 []@textrm Link: [][]@texttt https://  software-dl.  ti.  com/  ccs/  esd/  doc
uments/  xdsdebugprobes/

These are the related .texi lines:

@item @b{TI XDS110 Debug Probe}
@* 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

The generated text in the PDF looks indeed weird, and that is the reason for 
the warnings. Such long URLs are broken into the next line, but the first line 
is justified, so the first part of the URL gets moved to the right inside the 
line. Somebody helped me by posting this image of the problem:  
https://ibb.co/M53SjdM

Alternatively, just search for "xdsdebugprobes" in the example PDF linked near 
the top of this e-mail to see the effect.

I already asked in the OpenOCD project, but I got no help:

https://sourceforge.net/p/openocd/mailman/openocd-devel/thread/19873a0f-4c6e-4484-8dc1-80656c5e4dda%40yahoo.de/#msg58778698

The trouble is, I know next to nothing about Textinfo, TeX or LaTeX. I have 
searched the Internet, and there are lots of advice about underfull and 
overfull warnings, but I haven't figured it out yet.

Could someone here tell me the best way to fix this problem with long URLs?


There are also other Overfull warnings like this:

Overfull \hbox (20.85455pt too wide) in paragraph at lines 2141--2141
 []@texttt lappend post_init_commands {echo "OpenOCD successfully initialized."
}[] |

Just search for "OpenOCD successfully initialized" in the example PDF linked 
near the top of this e-mail to see the effect.

These are the related .texi lines:

@example
lappend post_init_commands @{echo "OpenOCD successfully initialized."@}
lappend post_init_commands @{echo "Have fun with OpenOCD !"@}
@end example

This is a different issue. The OpenOCD manual wants to give examples of 
commands or console outputs with long text lines which will often not fit on a 
printed page. Such commands should not be broken up like normal text, because 
the reader must have a sense of what words belong to a single command line or 
console output line. What is the best strategy to display such long commands in 
a Texinfo user manual?

Thanks in advance,
  rdiez

Reply via email to