Page MenuHomeFreeBSD

man: do not ignore the exit status of roff tools
ClosedPublic

Authored by wosch on Apr 15 2024, 1:06 PM.
Tags
None
Referenced Files
F102189515: D44798.diff
Fri, Nov 8, 5:26 PM
Unknown Object (File)
Thu, Nov 7, 12:06 AM
Unknown Object (File)
Tue, Nov 5, 9:05 AM
Unknown Object (File)
Fri, Oct 18, 9:15 AM
Unknown Object (File)
Thu, Oct 17, 8:36 AM
Unknown Object (File)
Wed, Oct 16, 1:55 PM
Unknown Object (File)
Mon, Oct 14, 6:43 AM
Unknown Object (File)
Sat, Oct 12, 6:24 PM
Subscribers

Details

Summary
Test Plan

cat /dev/null > /tmp/bla.1.gz
man /tmp/bla.1.gz >/dev/null; echo $?

gzcat: /tmp/bla.1.gz: unexpected end of file
gzcat: /tmp/bla.1.gz: unexpected end of file
grotty:<standard input>:(<standard input>):6: fatal error: 'V' command invalid before first 'p' command
1

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

wosch requested review of this revision.Apr 15 2024, 1:06 PM
wosch added reviewers: kevans, bapt, emaste, jilles.

OK. Discarding errors from $cattool is not directly related to the original issue, right?

This revision is now accepted and ready to land.Apr 15 2024, 1:15 PM

OK. Discarding errors from $cattool is not directly related to the original issue, right?

gzip may print (a useless) error message for large files if we catch SIGPIPE. E.g.

small input
(set -o pipefail; trap '' SIGPIPE; man cat | gzip |gzip -dc | head -1 >/dev/null; echo $?)
0

large input for gzcat
(set -o pipefail; trap '' SIGPIPE; man tcsh | gzip |gzip -dc | head -1 >/dev/null; echo $?)
gzcat: error writing to output: Broken pipe
gzcat: /usr/share/man/man1/tcsh.1.gz: uncompress failed
gzip: error writing to output: Broken pipe
1

You don't want to bother users with this new warnings.