patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Alyssa Ross <hi@alyssa.is>
To: Valentin Gagarin <valentin@gagarin.work>
Cc: devel@spectrum-os.org
Subject: Re: [PATCH] release/checks/whitespace: skip binary files
Date: Sat, 23 May 2026 14:57:34 +0200	[thread overview]
Message-ID: <87a4tqfflt.fsf@alyssa.is> (raw)
In-Reply-To: <eb3247f9-0300-431d-8d47-cf78b4ba6c25@gagarin.work>

[-- Attachment #1: Type: text/plain, Size: 1358 bytes --]

Valentin Gagarin <valentin@gagarin.work> writes:

> The reasons I wrote it out is that it's more obvious what it does 
> without looking up the documentation.  As a project grows larger and so 
> does the number of tools or options in use, the amount of rare things 
> one needs to "just know" tends to become unmanageable, and the time to 
> decompress a highly compressed representation goes up.
>
> This is, what I consider to be by now classic, advice, which I have 
> assumed to be tacit knowledge:
> https://changelog.com/posts/use-long-flags-when-scripting
>
> Discussion:
> - https://news.ycombinator.com/item?id=5164354 (2013)
> - https://news.ycombinator.com/item?id=24518682 (2020)
>
> In this particular case, nothing would tell me off the cuff what `-I` is 
> supposed to mean for `grep`.  It seems reasonable to be explicit here 
> and avoid the extra round of distraction for readers.  This has even 
> more impact on people with less experience (overall or just with the 
> particular tools).
>
> No action required now, the change is merged and does its thing.  But I 
> suggest considering whether a note on the issue should be added to a 
> document about coding conventions.

I think you're probably right and I'd be happy for the convention to be
changed and documented (but long single lines still avoided).

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 227 bytes --]

  reply	other threads:[~2026-05-23 12:57 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-20 22:22 [PATCH] release/checks/whitespace: skip binary files Valentin Gagarin
2026-05-23  8:29 ` Alyssa Ross
2026-05-23 12:52   ` Valentin Gagarin
2026-05-23 12:57     ` Alyssa Ross [this message]
2026-05-25 13:22       ` Long vs. short options Alyssa Ross
2026-05-23  8:30 ` [PATCH] release/checks/whitespace: skip binary files Alyssa Ross

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a4tqfflt.fsf@alyssa.is \
    --to=hi@alyssa.is \
    --cc=devel@spectrum-os.org \
    --cc=valentin@gagarin.work \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).