Skip to contentSkip to conversation

man: ss.8: more line breaks

PATCH New Luca Boccassi 1 participant 3 messages Jan 12, 2019

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/3 man: ss.8: more line breaks

groff stiff complains about unbreakable lines:
96: warning [p 2, 3.0i]: can't break line

Indent it some more.

Fixes 7f5047524c99 ("man: ss.8: break and indent long line")
---
 man/man8/ss.8 | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
man/man8/ss.8 +8 -2
index f138c91a..553a6cf4 100644
@@ -89,11 +89,17 @@ an uuid of the socket
 Show socket memory usage. The output format is:
 .RS
 .P
-skmem:(r<rmem_alloc>,rb<rcv_buf>,t<wmem_alloc>,tb<snd_buf>,f<fwd_alloc>,
+skmem:(r<rmem_alloc>,rb<rcv_buf>,t<wmem_alloc>,tb<snd_buf>,
 .br
 .RS
 .RS
-w<wmem_queued>,o<opt_mem>,bl<back_log>)
+f<fwd_alloc>,w<wmem_queued>,
+.RE
+.RE
+.br
+.RS
+.RS
+o<opt_mem>,bl<back_log>)
 .RE
 .RE
 .P
Signature · 1 line
2.20.1
#1 lore raw

PATCH 2/3 man: tc-taprio.8: fix syntax error

.Q does not exist so groff complains and the "queues" word is actually not displayed.

Fixes 579acb4bc52f ("taprio: Add manpage for tc-taprio(8)")
---
 man/man8/tc-taprio.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man/man8/tc-taprio.8 +1 -1
index 92055b43..850be9b0 100644
@@ -45,7 +45,7 @@ How traffic is mapped to different hardware queues is similar to
 and so the
 .B map
 and
-.Q queues
+.B queues
 parameters have the same meaning.
 
 The other parameters specify the schedule, and at what point in time
Signature · 1 line
2.20.1
#2 lore raw

PATCH 3/3 Makefile: check manpages for syntax errors

In reply to Luca Boccassi

Pass the same parameters Lintian uses in Debian.

$ make check
<...>
Checking manpages for syntax errors...
<standard input>:48: warning: macro `Q' not defined
Error in tc-taprio.8
Makefile:27: recipe for target 'check' failed

---
As far as I can see all the shell-ery should be portable and not bash specific. Do not error out if man is not present, to avoid issues on minimal build workers. The rest comes from coreutils (tee, wc) so we can assume they are available.

 Makefile          | 6 ++++++
 man/Makefile      | 9 +++++++--
 man/man3/Makefile | 6 +++++-
 man/man7/Makefile | 6 +++++-
 man/man8/Makefile | 6 +++++-
 5 files changed, 28 insertions(+), 5 deletions(-)
Makefile +6 -0
index a513cf38..48f469b0 100644
@@ -115,6 +115,12 @@ distclean: clobber
 
 check: all
 	cd testsuite && $(MAKE) && $(MAKE) alltests
+	@if command -v man >/dev/null 2>&1; then \
+		echo "Checking manpages for syntax errors..."; \
+		$(MAKE) -C man check; \
+	else \
+		echo "man not installed, skipping checks for syntax errors."; \
+	fi
 
 cscope:
 	cscope -b -q -R -Iinclude -sip -slib -smisc -snetem -stc
man/Makefile +7 -2
index 6b095ee4..0c759dd2 100644
@@ -2,14 +2,19 @@
 INSTALL=install
 INSTALLDIR=install -m 0755 -d
 INSTALLMAN=install -m 0644
+# Pass the same parameters as Lintian uses on Debian.
+MAN_CHECK=LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings \
+	--encoding=UTF-8 --local-file --troff-device=utf8 --ditroff
+# Hide man output, count and print errors.
+MAN_REDIRECT=2>&1 >/dev/null | tee /dev/fd/2 | wc -l
 
 SUBDIRS = man3 man7 man8
 
-all clean install:
+all clean install check:
 	@for subdir in $(SUBDIRS); do $(MAKE) -C $$subdir $@ || exit $$?; done
 
 distclean: clean
 
-.PHONY: install clean distclean
+.PHONY: install clean distclean check
 
 .EXPORT_ALL_VARIABLES:
man/man3/Makefile +5 -1
index e3d3e607..1732be26 100644
@@ -11,4 +11,8 @@ install:
 	$(INSTALLDIR) $(DESTDIR)$(MANDIR)/man3
 	$(INSTALLMAN) $(MAN3PAGES) $(DESTDIR)$(MANDIR)/man3
 
-.PHONY: install clean distclean
+check:
+	@for page in $(MAN3PAGES); do test 0 -eq $$($(MAN_CHECK) $$page \
+		$(MAN_REDIRECT)) || { echo "Error in $$page"; exit 1; }; done
+
+.PHONY: install clean distclean check
man/man7/Makefile +5 -1
index 1a8d5219..c0e545a1 100644
@@ -11,4 +11,8 @@ install:
 	$(INSTALLDIR) $(DESTDIR)$(MANDIR)/man7
 	$(INSTALLMAN) $(MAN7PAGES) $(DESTDIR)$(MANDIR)/man7
 
-.PHONY: install clean distclean
+check:
+	@for page in $(MAN7PAGES); do test 0 -eq $$($(MAN_CHECK) $$page \
+		$(MAN_REDIRECT)) || { echo "Error in $$page"; exit 1; }; done
+
+.PHONY: install clean distclean check
man/man8/Makefile +5 -1
index 932ba1f3..0269e174 100644
@@ -23,4 +23,8 @@ install:
 	$(INSTALLDIR) $(DESTDIR)$(MANDIR)/man8
 	$(INSTALLMAN) $(MAN8PAGES) $(DESTDIR)$(MANDIR)/man8
 
-.PHONY: install clean distclean
+check: all
+	@for page in $(MAN8PAGES); do test 0 -eq $$($(MAN_CHECK) $$page \
+		$(MAN_REDIRECT)) || { echo "Error in $$page"; exit 1; }; done
+
+.PHONY: install clean distclean check
Signature · 1 line
2.20.1