GNU bug report logs - #51311
[PATCH] echo: update --help to document edge cases

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Pádraig Brady <P <at> draigBrady.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#51311: closed ([PATCH] echo: update --help to document edge
 cases)
Date: Thu, 21 Oct 2021 12:12:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Thu, 21 Oct 2021 13:11:25 +0100
with message-id <a0798791-704f-3032-da2a-7cb9480904ef <at> draigBrady.com>
and subject line Re: bug#51311: [PATCH] echo: update --help to document edge cases
has caused the debbugs.gnu.org bug report #51311,
regarding [PATCH] echo: update --help to document edge cases
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
51311: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=51311
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Florent Flament <contact <at> florentflament.com>
To: bug-coreutils <at> gnu.org
Cc: bob <at> proulx.com
Subject: [PATCH] echo: update --help to document edge cases
Date: Wed, 20 Oct 2021 23:50:47 +0200

* src/echo.c (usage): Document edge cases when displaying arbitrary
strings with the echo command.
---
 src/echo.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/echo.c b/src/echo.c
index 18513398a..73b44660b 100644
--- a/src/echo.c
+++ b/src/echo.c
@@ -78,6 +78,14 @@ If -e is in effect, the following sequences are recognized:\n\
   fputs (_("\
   \\0NNN   byte with octal value NNN (1 to 3 digits)\n\
   \\xHH    byte with hexadecimal value HH (1 to 2 digits)\n\
+"), stdout);
+  fputs (_("\
+\n\
+NOTE: The echo command doesn't behave gracefully when displaying\n\
+arbitrary strings. For example, it can't display the string \"-n\" and\n\
+requires the STRICTLY_POSIX flag to display \"-e\" or \"-E\". Therefore,\n\
+if you need to display arbitrary strings please use the printf command\n\
+instead.\n\
 "), stdout);
   printf (USAGE_BUILTIN_WARNING, PROGRAM_NAME);
   emit_ancillary_info (PROGRAM_NAME);
-- 
2.25.1

[Message part 3 (message/rfc822, inline)]

From: Pádraig Brady <P <at> draigBrady.com>
To: Florent Flament <contact <at> florentflament.com>, 51311-done <at> debbugs.gnu.org
Cc: bob <at> proulx.com
Subject: Re: bug#51311: [PATCH] echo: update --help to document edge cases
Date: Thu, 21 Oct 2021 13:11:25 +0100

[Message part 4 (text/plain, inline)]

On 20/10/2021 22:50, Florent Flament wrote:
> 
> * src/echo.c (usage): Document edge cases when displaying arbitrary
> strings with the echo command.
> ---
>   src/echo.c | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/src/echo.c b/src/echo.c
> index 18513398a..73b44660b 100644
> --- a/src/echo.c
> +++ b/src/echo.c
> @@ -78,6 +78,14 @@ If -e is in effect, the following sequences are recognized:\n\
>     fputs (_("\
>     \\0NNN   byte with octal value NNN (1 to 3 digits)\n\
>     \\xHH    byte with hexadecimal value HH (1 to 2 digits)\n\
> +"), stdout);
> +  fputs (_("\
> +\n\
> +NOTE: The echo command doesn't behave gracefully when displaying\n\
> +arbitrary strings. For example, it can't display the string \"-n\" and\n\
> +requires the STRICTLY_POSIX flag to display \"-e\" or \"-E\". Therefore,\n\
> +if you need to display arbitrary strings please use the printf command\n\
> +instead.\n\
>   "), stdout);
>     printf (USAGE_BUILTIN_WARNING, PROGRAM_NAME);
>     emit_ancillary_info (PROGRAM_NAME);

This is too verbose.
BTW the env var is POSIXLY_CORRECT, not STRICTLY_POSIX.
Anyway I don't think we should mention that in the man page anyway.
I'll push the attached later, which just says printf(1) is preferred.

cheers,
Pádraig

[echo-printf.patch (text/x-patch, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.