Bug 328711

Summary:	valgrind.1 manpage "memcheck options" section is badly generated
Product:	[Developer tools] valgrind	Reporter:	Miroslav Franc <mfranc>
Component:	memcheck	Assignee:	Julian Seward <jseward>
Status:	RESOLVED FIXED
Severity:	normal	CC:	mark, philippe.waroquiers
Priority:	NOR
Version First Reported In:	3.9.0
Target Milestone:	---
Platform:	Compiled Sources
OS:	Linux
Latest Commit:		Version Fixed/Implemented In:
Sentry Crash Report:
Attachments:	patch

Description Miroslav Franc 2013-12-12 09:41:12 UTC

Generated valgrind.1 manpage (the MEMCHECK OPTIONS part) doesn't have .RE macro on many places at the beginning of the line failing to restore left margin.  As a result the text is "blown to the right".  Is seems that the cause is missing para tag in those items.

Reproducible: Always

Steps to Reproduce:
1. man valgrind
2. look at MEMCHECK OPTIONS and scroll down

Comment 1 Miroslav Franc 2013-12-12 09:44:43 UTC

Created attachment 84057 [details]
patch

This fixes things for me.  After make man-pages in docs the man page look OK.

Comment 2 Mark Wielaard 2013-12-12 21:21:53 UTC

Thanks that fixes things also for me.
Pushed as valgrind svn r13758.

Comment 3 Philippe Waroquiers 2013-12-12 23:20:51 UTC

(In reply to comment #1)
> Created attachment 84057 [details]
> patch
> 
> This fixes things for me.  After make man-pages in docs the man page look OK.

Found some similar (bug less "mucking" :) problems in manual-core.xml,
drd-manual.xml and mc-manual.xml, causing some options to still be pushed
to the right.

So, further improvements in revision 13759

Comment 4 Mark Wielaard 2013-12-13 08:41:01 UTC

(In reply to comment #3)
> (In reply to comment #1)
> > This fixes things for me.  After make man-pages in docs the man page look OK.
> 
> Found some similar (bug less "mucking" :) problems in manual-core.xml,
> drd-manual.xml and mc-manual.xml, causing some options to still be pushed
> to the right.

I was wondering why I hadn't seen these. Turns out it depends on DocBook XSL Stylesheets version used. Apparently v1.78.1 is a bit more forgiving than v1.75.2. With v1.75.2 I can see the extra indentation issues (and they are fixed Philippe's patch), with v1.78.1 those extra corrections weren't needed.

With v1.75.2 I still see one (small) extra indentation issue after the --collect-atstart=<yes|no> switch block, which I cannot seem to correct with tweaking the paras. But with v1.78.1 things look fine.

Comment 5 Miroslav Franc 2013-12-13 09:37:54 UTC

(In reply to comment #4)
> I was wondering why I hadn't seen these. Turns out it depends on DocBook XSL
> Stylesheets version used. Apparently v1.78.1 is a bit more forgiving than
> v1.75.2. With v1.75.2 I can see the extra indentation issues (and they are
> fixed Philippe's patch), with v1.78.1 those extra corrections weren't needed.

That would explain it.  I was using v1.78.1 as well.  Sigh.