Bug #7105: Socket documentation fix

• Status: Closed
• Priority: Normal
• Assignee: zzak (Zachary Scott)
• Target version: 2.0.0
• ruby -v: 2.0.0dev
• Backport: 2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN

[davidbalbert (David Albert)]

The "Quick start" section of the Socket documentation refers to the Socket::INET constant, which doesn't exist. I've attached a small patch changing the reference to Socket::AF_INET, which seems consistent with the rest of the documentation (the alternative would be Socket::PF_INET, which has the same value).

[zzak (Zachary Scott)]

• Assignee set to zzak (Zachary Scott)
• Target version set to 2.0.0

[zzak (Zachary Scott)]

Hello,
I've discussed this with another mri committer, and we've come to the conclusion that the example should use AF_INET, as socket(2) suggests:

"The manifest constants used under 4.x BSD for protocol families are PF_UNIX, PF_INET, etc., while AF_UNIX etc. are used for address families. However, already the BSD man page promises: "The protocol family generally is the same as the address family", and subsequent standards use AF_* everywhere."

PF_INET is just an alias.

I will commit this patch if there are no obligations. Thank you for your contribution David.

[zzak (Zachary Scott)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r37274.
David, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• ext/socket/socket.c: Documentation for Socket Based on a patch by David Albert [Bug #7105]