Differential D52740

inetd.8: Remove the enumeration of examples
ClosedPublic
Actions

Authored by ivy on Sep 25 2025, 8:00 PM.

Details

Reviewers

0mp

Group Reviewers

manpages

Commits

rG5c889c6522a4: inetd.8: Remove the enumeration of examples
rGa7c558b4ade8: inetd.8: Remove the enumeration of examples

Summary

The user can trivially see the list of examples in /etc/inetd.conf
by looking at the file, so there's no need to include an entire
paragraph in the manual enumerating the examples which are provided.

MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

ivy created this revision.Sep 25 2025, 8:00 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptSep 25 2025, 8:00 PM

ivy requested review of this revision.Sep 25 2025, 8:00 PM

Harbormaster completed remote builds in B67337: Diff 162854.Sep 25 2025, 8:00 PM

kevans added a subscriber: kevans.Sep 25 2025, 11:03 PM

kevans added inline comments.

usr.sbin/inetd/inetd.8
791	FWIW, I think removing these is fair game. It's just one more list to get stale, and it doesn't help me evaluate the implementation at all if I'm just browsing the manpage via the web interface or something like that.
818	I would argue for keeping this list, though.

kevans added inline comments.Sep 25 2025, 11:05 PM

usr.sbin/inetd/inetd.8
818	Actually, I guess I wouldn't- it's a duplicate of the same list from DESCRIPTION. I wouldn't mind making that list an actual list, though, rather than inline with a bunch of other text.

Listing those things with Nm makes little sense so removing them is a good idea. I would contemplate adding references to inetd(8) in the manual pages of the programs listed here though. But that's out of scope for this change.

This revision is now accepted and ready to land.Oct 31 2025, 3:55 PM

(not a inetd-sme) I thought they were Nm because these utilities are part of inetd?

In D52740#1221525, @ziaee wrote:

(not a inetd-sme) I thought they were Nm because these utilities are part of inetd?

AFAIU, these utilities are just called by inetd and are not internal. I've not checked the code but my understanding is that inetd is able to run any service the user specifies in the config file.

In D52740#1221574, @0mp wrote:

In D52740#1221525, @ziaee wrote:

(not a inetd-sme) I thought they were Nm because these utilities are part of inetd?

AFAIU, these utilities are just called by inetd and are not internal. I've not checked the code but my understanding is that inetd is able to run any service the user specifies in the config file.

Correct- these aren't the internal services (except for the last paragraph removed), these are provided elsewhere. inetd(8) can work with anything that has some mode where it either detects or can be specified to interact with stdin/stdout as a socket.

Okay, thanks!

Closed by commit rGa7c558b4ade8: inetd.8: Remove the enumeration of examples (authored by ivy). · Explain WhyNov 5 2025, 11:53 PM

This revision was automatically updated to reflect the committed changes.

ivy added a commit: rGa7c558b4ade8: inetd.8: Remove the enumeration of examples.

ivy added a commit: rG5c889c6522a4: inetd.8: Remove the enumeration of examples.Sat, Nov 15, 9:17 AM