diff mbox series

[OpenWrt-Devel] Do not hard-code IS_TTY in script scripts/feeds

Message ID mailman.2840.1586705844.2542.openwrt-devel@lists.openwrt.org
State Changes Requested
Delegated to: Petr Štetiar
Headers show
Series [OpenWrt-Devel] Do not hard-code IS_TTY in script scripts/feeds | expand

Commit Message

Thomas Richard via openwrt-devel April 12, 2020, 3:37 p.m. UTC
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.
Hi all:

Please find attached a patch in order to avoid hard-coding IS_TTY in script scripts/feeds .

For related information, see here:

https://bugs.openwrt.org/index.php?do=details&task_id=2086

Best regards,
   rdiez

Comments

Petr Štetiar June 3, 2020, 9:43 a.m. UTC | #1
R. Diez via openwrt-devel <openwrt-devel@lists.openwrt.org> [2020-04-12 17:37:13]:

> The sender domain has a DMARC Reject/Quarantine policy which disallows
> sending mailing list messages using the original "From" header.
> 
> To mitigate this problem, the original message has been wrapped
> automatically by the mailing list software.

> Date: Sun, 12 Apr 2020 17:37:13 +0200
> From: "R. Diez" <rdiezmail-openwrt@yahoo.com>
> To: openwrt-devel@lists.openwrt.org
> Subject: [PATCH] Do not hard-code IS_TTY in script scripts/feeds
> User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
>  Thunderbird/68.4.1
> X-Mailer: WebService/1.1.15620 hermes Apache-HttpAsyncClient/4.1.4
>  (Java/11.0.6)
> Message-ID: <bc270db4-005d-36b9-c726-c044ef719624@yahoo.com>
> 
> Hi all:
> 
> Please find attached a patch in order to avoid hard-coding IS_TTY in script scripts/feeds .
> 
> For related information, see here:
> 
> https://bugs.openwrt.org/index.php?do=details&task_id=2086
> 
> Best regards,
>   rdiez

Hi, please resend it as a proper patch, for details see
https://openwrt.org/submitting-patches, thanks!

-- ynezz
R. Diez June 4, 2020, 12:55 p.m. UTC | #2
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.
> Hi, please resend it as a proper patch, for details see
> https://openwrt.org/submitting-patches, thanks!

I do not know what you did not like in the patch, so I am hoping it is just the formatting of the subject line and perhaps that some extra explanation 
is needed. Please find enclosed the new patch version.

This is actually a trivial patch, please feel free to modify it any way you want.

For related information, see here:

https://bugs.openwrt.org/index.php?do=details&task_id=2086

Best regards,
   rdiez
Petr Štetiar June 6, 2020, 4:57 a.m. UTC | #3
R. Diez via openwrt-devel <openwrt-devel@lists.openwrt.org> [2020-06-04 14:55:30]:

Hi,

> I do not know what you did not like in the patch, so I am hoping it is just
> the formatting of the subject line and perhaps that some extra explanation
> is needed. Please find enclosed the new patch version.

https://openwrt.org/submitting-patches#no_mime_no_links_no_compression_no_attachments_just_plain_text

> This is actually a trivial patch, please feel free to modify it any way you want.

Please send a patch in proper format, so it can be handled with maintainer
scripts and shows at Patchwork[1] we use for patch handling. Otherwise it is
going to be lost.

> For related information, see here:
> https://bugs.openwrt.org/index.php?do=details&task_id=2086

Good, that's important information and should be added into the commit
description, right above your Signed-off-by:

 Ref: FS#2086

or

 Fixes: FS#2086

> Subject: [PATCH] build: do not hard-code IS_TTY in script scripts/feeds
> 
> The script was previously assuming that stdin is always a TTY.

It should be obvious from your commit description what is wrong currently, so
why is this fix needed. Nobody wants to read commit logs AND bug reports,
which are not even linked/referenced in the commit description.

Quotting from [2]:

 "it will be committed to the source changelog, so it should explain to a
  competent reader why you made this commit.  Include symptoms of the failure
  you are fixing (log messages, error messages, etc.), it will be useful for
  people searching the commit logs looking for a fix for their issue.  If a
  patch fixes a compile failure, include only the most relevant part of the
  failure log"

> Fixes: FS#2086
> Signed-off-by: R. Diez <rdiezmail-openwrt@yahoo.com>

1. https://patchwork.ozlabs.org/project/openwrt/list/
2. https://openwrt.org/submitting-patches

-- ynezz
R. Diez June 6, 2020, 12:44 p.m. UTC | #4
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.
> https://openwrt.org/submitting-patches#no_mime_no_links_no_compression_no_attachments_just_plain_text

Sometimes I use Thunderbird, and sometimes I use the Yahoo web interface. Both have problems with e-mail formatting, as they tend to reflow text lines 
and mess with quotations and blanks. Sending patches as plain text inside e-mails is too much trouble for me.

I do not understand why Patchwork cannot automatically pick up a patch from an e-mail attachment aptly named xxx.patch, and with an e-mail title that 
starts with [PATCH].

Is it possible to add patches manually to Patchwork using its web interface? If so, I would try that way.

Otherwise, I am tempted to drop it (and other such further contributions I had in the pipeline). This is a trivial fix and the administrative cost of 
getting it right is clearly disproportionate.

Regards,
   rdiez
Kevin 'ldir' Darbyshire-Bryant June 6, 2020, 3:45 p.m. UTC | #5
> From: "R. Diez" <rdiezmail-openwrt@yahoo.com>
> Subject: Re: [OpenWrt-Devel] [PATCH] Do not hard-code IS_TTY in script scripts/feeds
> Date: 6 June 2020 at 13:44:11 BST
> To: Petr Štetiar <ynezz@true.cz>
> Cc: openwrt-devel@lists.openwrt.org
> 
> 
> 
>> https://openwrt.org/submitting-patches#no_mime_no_links_no_compression_no_attachments_just_plain_text
> 
> Sometimes I use Thunderbird, and sometimes I use the Yahoo web interface. Both have problems with e-mail formatting, as they tend to reflow text lines and mess with quotations and blanks. Sending patches as plain text inside e-mails is too much trouble for me.
> 
> I do not understand why Patchwork cannot automatically pick up a patch from an e-mail attachment aptly named xxx.patch, and with an e-mail title that starts with [PATCH].
> 
> Is it possible to add patches manually to Patchwork using its web interface? If so, I would try that way.
> 
> Otherwise, I am tempted to drop it (and other such further contributions I had in the pipeline). This is a trivial fix and the administrative cost of getting it right is clearly disproportionate.

I recognise the frustration!  When I first started trying to send patches I had similar issues (white space wrapping/reflow etc)  The same issues are encountered when sending to many open source email patch lists including the Linux kernel.  I came very, very, very close to giving up with openwrt, before being introduced to ‘git send-email’.  I fought a little with configuring git send-email and got it working, before I then discovered https://www.freedesktop.org/wiki/Software/PulseAudio/HowToUseGitSendEmail/  which is a quite helpful guide. Maybe that can help you too?

Kevin
R. Diez June 6, 2020, 8:56 p.m. UTC | #6
The sender domain has a DMARC Reject/Quarantine policy which disallows
sending mailing list messages using the original "From" header.

To mitigate this problem, the original message has been wrapped
automatically by the mailing list software.
> I recognise the frustration!  When I first started trying to send patches
> I had similar issues (white space wrapping/reflow etc)
 > [...]

I am just trying to get an obvious, trivial issue fixed. I can fix it in 2 seconds on my PC. It is very frustrating. As a voluntary contributor, it 
takes the fun out of it. I am guessing that you and I are not the only ones that got frustrated at the beginning. It is probably hindering other 
contributions as well. It is probably the reason why so many little things stay unfixed for years even though many people must notice them every day.

Other projects take such small patches without a blink. Maybe not directly applying the patch, but just fixing the issue themselves straight away.

I have only seen one other open-source project so frustrating: OpenOCD. You also have to follow a long procedure to set your system up in order to 
contribute patches:

http://openocd.org/doc/doxygen/html/patchguide.html

But then it is almost worth it. Gerrit tells you whether your patch compiles, and even whether it conflicts with another patch (and which one). You 
get notifications and reviews, and you can comment directly there.

But thanks for your hint about "git send-email". I'll see if I can put together enough motivation to try again.

Regards,
   rdiez
diff mbox series

Patch

From 768da7dc56e3bd267cfa2f0ea6e317816388a21b Mon Sep 17 00:00:00 2001
From: "R. Diez" <rdiezmail-openwrt@yahoo.com>
Date: Sun, 12 Apr 2020 17:33:28 +0200
Subject: [PATCH] Do not hard-code IS_TTY in script scripts/feeds

Signed-off-by: R. Diez <rdiezmail-openwrt@yahoo.com>
---
 scripts/feeds | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/scripts/feeds b/scripts/feeds
index 69ab602..56a690e 100755
--- a/scripts/feeds
+++ b/scripts/feeds
@@ -128,8 +128,11 @@  sub update_index($)
 	-d "./feeds/$name.tmp/info" or mkdir "./feeds/$name.tmp/info" or return 1;
 
 	system("$mk -s prepare-mk OPENWRT_BUILD= TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
-	system("$mk -s -f include/scan.mk IS_TTY=1 SCAN_TARGET=\"packageinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"package\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
-	system("$mk -s -f include/scan.mk IS_TTY=1 SCAN_TARGET=\"targetinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"target\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" SCAN_MAKEOPTS=\"TARGET_BUILD=1\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
+
+	my $is_tty = -t STDOUT ? 1 : 0;
+	system("$mk -s -f include/scan.mk IS_TTY=$is_tty SCAN_TARGET=\"packageinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"package\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
+	system("$mk -s -f include/scan.mk IS_TTY=$is_tty SCAN_TARGET=\"targetinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"target\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" SCAN_MAKEOPTS=\"TARGET_BUILD=1\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
+
 	system("ln -sf $name.tmp/.packageinfo ./feeds/$name.index");
 	system("ln -sf $name.tmp/.targetinfo ./feeds/$name.targetindex");
 
-- 
2.26.0