diff mbox

[5/5] stress: Patch to fix documentation source

Message ID 1396979109-10691-5-git-send-email-paul@crapouillou.net
State Rejected
Headers show

Commit Message

Paul Cercueil April 8, 2014, 5:45 p.m. UTC 
From: Maarten ter Huurne <maarten@treewalker.org>

Some versions of "makeinfo" consider @itemx not immediately following
@item an error. It is a violation of the texinfo syntax, but silently
ignored on most systems, for some reason.

Signed-Off-By: Maarten ter Huurne <maarten@treewalker.org>
---
 package/stress/stress-0002-Fix-doc-itemx.patch | 47 ++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 package/stress/stress-0002-Fix-doc-itemx.patch

Comments

Thomas Petazzoni April 12, 2014, 2:14 p.m. UTC | #1 
Dear Paul Cercueil,

On Tue,  8 Apr 2014 19:45:09 +0200, Paul Cercueil wrote:
> From: Maarten ter Huurne <maarten@treewalker.org>
> 
> Some versions of "makeinfo" consider @itemx not immediately following
> @item an error. It is a violation of the texinfo syntax, but silently
> ignored on most systems, for some reason.
> 
> Signed-Off-By: Maarten ter Huurne <maarten@treewalker.org>
> ---
>  package/stress/stress-0002-Fix-doc-itemx.patch | 47 ++++++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100644 package/stress/stress-0002-Fix-doc-itemx.patch

I don't think this patch is still necessary. Since commit
dc7a9bb9f7e0ac096d79c47e9240c2eb7b08dce9 (October 2013), we pass
MAKEINFO=: to avoid generating the stress documentation. So we should
not hit such issues.

If you're really interested in having this fixed, please submit the
patch to the upstream maintainer, apw@debian.org.

Thanks!

Thomas
diff mbox

Patch

diff --git a/package/stress/stress-0002-Fix-doc-itemx.patch b/package/stress/stress-0002-Fix-doc-itemx.patch
new file mode 100644
index 0000000..8ef7fa4
--- /dev/null
+++ b/package/stress/stress-0002-Fix-doc-itemx.patch
@@ -0,0 +1,47 @@ 
+diff -ru stress-1.0.4.org/doc/stress.texi stress-1.0.4/doc/stress.texi
+--- stress-1.0.4.org/doc/stress.texi	2005-03-10 02:16:02.000000000 +0100
++++ stress-1.0.4/doc/stress.texi	2013-07-21 21:50:47.000000000 +0200
+@@ -65,7 +65,7 @@
+ @itemx --help
+ Show help information.
+ 
+-@itemx --version
++@item --version
+ Show version information.
+ 
+ @item -v
+@@ -84,7 +84,7 @@
+ @itemx --timeout @var{secs}
+ Time out after @var{secs} seconds.
+ 
+-@itemx --backoff @var{usecs}
++@item --backoff @var{usecs}
+ Wait for factor of @var{usecs} microseconds before starting work.
+ 
+ @item -c @var{forks}
+@@ -99,10 +99,10 @@
+ @itemx --vm @var{forks}
+ Spawn @var{forks} processes each spinning on @samp{malloc()}.
+ 
+-@itemx --vm-bytes @var{bytes}
++@item --vm-bytes @var{bytes}
+ Allocate @var{bytes} number of bytes.  The default is 1.
+ 
+-@itemx --vm-hang
++@item --vm-hang
+ Instruct each vm hog process to go to sleep after allocating memory.  This
+ contrasts with their normal behavior, which is to free the memory and
+ reallocate @emph{ad infinitum}.  This is useful for simulating low memory
+@@ -117,10 +117,10 @@
+ @itemx --hdd @var{forks}
+ Spawn @var{forks} processes each spinning on @samp{write()}.
+ 
+-@itemx --hdd-bytes @var{bytes}
++@item --hdd-bytes @var{bytes}
+ Write @var{bytes} number of bytes.  The default is 1GB.
+ 
+-@itemx --hdd-noclean
++@item --hdd-noclean
+ Do not unlink file(s) to which random ASCII data is written.
+ 
+ @end table