Bug 1688744

Summary: sha512sum(1) man page is badly formatted
Product: Red Hat Enterprise Linux 8 Reporter: Jonathan Wakely <jwakely>
Component: coreutilsAssignee: Kamil Dudka <kdudka>
Status: CLOSED ERRATA QA Contact: Radka Brychtova <rskvaril>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 8.0CC: admiller, extras-qa, jamartis, jarodwilson, kdudka, kzak, ooprala, ovasik, p, sebastian.kisela, svashisht, twaugh
Target Milestone: rcKeywords: EasyFix
Target Release: 8.0Flags: pm-rhel: mirror+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: coreutils-8.30-8.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 1688740 Environment:
Last Closed: 2020-11-04 01:37:10 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1681018, 1688740    
Bug Blocks:    
Attachments:
Description Flags
Patch to patch the patch none

Description Jonathan Wakely 2019-03-14 10:58:54 UTC
Created attachment 1543998 [details]
Patch to patch the patch

+++ This bug was initially created as a clone of Bug #1688740 +++

The coreutils-6.10-manpages.patch screws up the formatting of the man page (and the note it adds to the --help output is not proper English anyway).

The rendered man page looks like:

       -t, --text
              read in text mode (default)

              Note: There is no difference between binary and text mode option
              on GNU system.  -z, --zero           end each output  line  with
              NUL, not newline,

              and disable file name escaping


Note that the -z option is not a new item, but continues on from the note, and there's a spurious line break after "not newline,". In the troff source the problem is a missing .TP macro and a missing newline, but the man page appears to be generated by help2man so it's not as simple as fixing the troff.

Please either drop the patch completely (it seems unnecessary to me) or fix the formatting and the grammar.

I've attached a patch for the patch, which moves the "Note:" to the end, so it doesn't mess up the formatting of the --text and --zero options. I also fixed the grammar.

Comment 10 errata-xmlrpc 2020-11-04 01:37:10 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (coreutils bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:4454