Page MenuHomeFreeBSD

arcanist: Improve comments to fit on one line
ClosedPublic

Authored by ziaee on Mon, Nov 3, 7:20 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 4, 5:46 AM
Unknown Object (File)
Tue, Nov 4, 3:27 AM
Unknown Object (File)
Tue, Nov 4, 3:25 AM
Unknown Object (File)
Mon, Nov 3, 10:52 PM
Unknown Object (File)
Mon, Nov 3, 10:39 PM
Unknown Object (File)
Mon, Nov 3, 10:37 PM
Unknown Object (File)
Mon, Nov 3, 10:37 PM
Unknown Object (File)
Mon, Nov 3, 10:36 PM
Subscribers
None

Diff Detail

Repository
R11 FreeBSD ports repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Mon, Nov 3, 7:20 PM
ziaee created this revision.

While I'm not fundamentally opposed to the stylistic change, I don't understand the reasoning.

The longest comment is 54 chars, which is way below the limit of 70 chars for pkg, so it already fits on one line.

Picture worth a thousand words?

20251103_142903.jpg (2×4 px, 5 MB)

I'm using 80x25 here, which I know people loathe, but 80x60 or whatever in GUI windows is I think a very common use case, or split screen that still works out to ~80.

Also I think it's more useful for quick scanning to put what its about first, like we do with commit messages.

Picture worth a thousand words?

20251103_142903.jpg (2×4 px, 5 MB)

I'm using 80x25 here, which I know people loathe, but 80x60 or whatever in GUI windows is I think a very common use case, or split screen that still works out to ~80.

Also I think it's more useful for quick scanning to put what its about first, like we do with commit messages.

Sorry, the picture is not visible (it says restricted file attached). You might need to modify its permissions.

I also use 80x25 most of the time, but the comment field is defined as being up to 70 chars, so there is no reason to try to strip down all port comments to fit strlen(package name + version + comment).

What about simply using pkg search arcanist | less -S?

That said, why not make it CLI while being there?

  • arcanist: Phabricator CLI
  • arcanist-lib: Phabricator Arcanist libraries
  • phorgeit-arcanist: Phorge.it CLI
  • phorgeit-arcanist-lib: Phorge.it Arcanist libraries

Picture worth a thousand words?

20251103_142903.jpg (2×4 px, 5 MB)

I'm using 80x25 here, which I know people loathe, but 80x60 or whatever in GUI windows is I think a very common use case, or split screen that still works out to ~80.

Also I think it's more useful for quick scanning to put what its about first, like we do with commit messages.

Sorry, the picture is not visible (it says restricted file attached). You might need to modify its permissions.

Thanks, did that fix it?

I also use 80x25 most of the time, but the comment field is defined as being up to 70 chars, so there is no reason to try to strip down all port comments to fit strlen(package name + version + comment).

What about simply using pkg search arcanist | less -S?

That said, why not make it CLI while being there?

  • arcanist: Phabricator CLI
  • arcanist-lib: Phabricator Arcanist libraries
  • phorgeit-arcanist: Phorge.it CLI
  • phorgeit-arcanist-lib: Phorge.it Arcanist libraries

Well, that's totally fine with me, but I didn't do that because now we're removing syntactically significant search terms. I only removed conjunctions so far.

Picture worth a thousand words?

20251103_142903.jpg (2×4 px, 5 MB)

I'm using 80x25 here, which I know people loathe, but 80x60 or whatever in GUI windows is I think a very common use case, or split screen that still works out to ~80.

Also I think it's more useful for quick scanning to put what its about first, like we do with commit messages.

Sorry, the picture is not visible (it says restricted file attached). You might need to modify its permissions.

Thanks, did that fix it?

I also use 80x25 most of the time, but the comment field is defined as being up to 70 chars, so there is no reason to try to strip down all port comments to fit strlen(package name + version + comment).

What about simply using pkg search arcanist | less -S?

That said, why not make it CLI while being there?

  • arcanist: Phabricator CLI
  • arcanist-lib: Phabricator Arcanist libraries
  • phorgeit-arcanist: Phorge.it CLI
  • phorgeit-arcanist-lib: Phorge.it Arcanist libraries

Well, that's totally fine with me, but I didn't do that because now we're removing syntactically significant search terms. I only removed conjunctions so far.

We also gain an important search term though ("CLI"). Looking at existing packages, this is a lot more common than writing "Command line interface", so I think it's fine.

FYI, out of 36500 packages on the public repo, about 13700 are longer than 80 chars in pkg search's output.

(and yes, the image is visible now)

We also gain an important search term though ("CLI"). Looking at existing packages, this is a lot more common than writing "Command line interface", so I think it's fine.

Sgtm! I'll change it when I get back to my desk.

FYI, out of 36500 packages on the public repo, about 13700 are longer than 80 chars in pkg search's output.

Some of them always will be. I treat them kind of like manpage descriptions. The goal is that it fits on one line, sometimes they can't, but if I just fix two or three of them, that's two or three more useful lines on the screen.

It's like cleaning up a bit in the garden, it's not enough that I'm a great engineer or something, but it is enough that after I've been hanging out for a few years, a lot of extremely minor subtle things are actually a lot nicer, and it's nice.

I'm particularly proud of the last one we did, blackhole(4). From:

blackhole(4) - a sysctl(8) MIB for manipulating behaviour in respect of refused SCTP, TCP, or UDP connection attempts

To:

blackhole(4) - quietly drop refused SCTP, TCP, or UDP packets

This revision was not accepted when it landed; it landed in state Needs Review.Mon, Nov 3, 8:17 PM
This revision was automatically updated to reflect the committed changes.

As I will be AFK now, I quickly committed the change myself (I bumped the revision, which is not strictly necessary, but I would find it confusing otherwise + building these ports is really cheap)