bug-coreutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#9531: md5sum: confusing documentation for file type output


From: Jim Meyering
Subject: bug#9531: md5sum: confusing documentation for file type output
Date: Mon, 19 Sep 2011 11:41:08 +0200

Reuben Thomas wrote:

> I attach a patch which makes simpler changes than those I suggested
> before. In particular, for the man page I just replaced "` '" with
> "space" because I can't see a way to put a non-breaking space into
> help text which will then also work in the man page after going
> through help2man (perhaps a Unicode non-breaking space would work, but
> it doesn't seem sensible to try!).
>
>>From bd0ed380c7050a1b55fca71da075fd9853442b1c Mon Sep 17 00:00:00 2001
> From: Reuben Thomas <address@hidden>
> Date: Sat, 17 Sep 2011 16:05:17 +0100
> Subject: [PATCH] md5sum: clarify what is meant by binary/text flag.
>
>         src/md5sum.c: Clarify that we are talking about input mode.
>         doc/coreutils.texi: Ditto.

Thanks.
I've applied that with the log adjusted to conform:

    doc: clarify what is meant by md5sum's binary/text flag

    * src/md5sum.c (usage): Clarify that we are talking about input mode.
    * doc/coreutils.texi (md5sum invocation): Ditto.

Changes:
 - leading "doc: " so this doesn't look like an md5sum bug fix
 - neither capitalized first word nor period at end of summary line
 - left-justified "*" for each file-starting ChangeLog entry.
     If you use vc-dwim and emacs' 'C-x 4 a', it'll insert the
     "* FILE_NAME (FUNCTION_NAME):" for each file in your ChangeLog.
     See vc-dwim's --help output for how to convert each new ChangeLog
     entry into a commit log.  Plus, it provides a handy cross-check,
     to ensure that files listed in ChangeLog are also in the commit,
     and don't have pending-but-not-written-to-disk changes.
 - "(parenthesized function or section name)" after each file name.





reply via email to

[Prev in Thread] Current Thread [Next in Thread]