strerror.3: Add an example for perror()
ClosedPublic
Actions

Authored by 0mp on Dec 15 2020, 6:05 PM.

Details

Reviewers

yuripv
jilles

Group Reviewers

manpages

Commits

rS368714: strerror.3: Add an example for perror()

Summary

strerror.3: Add an example for perror()

This is a nice and quick reference.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

0mp created this revision.Dec 15 2020, 6:05 PM

Herald added a reviewer: manpages. · View Herald TranscriptDec 15 2020, 6:05 PM

Herald added a subscriber: imp. · View Herald Transcript

0mp requested review of this revision.Dec 15 2020, 6:05 PM

Harbormaster completed remote builds in B35420: Diff 80725.Dec 15 2020, 6:05 PM

yuripv added a subscriber: yuripv.Dec 15 2020, 6:15 PM

yuripv added inline comments.

lib/libc/string/strerror.3
158 ↗	(On Diff #80725)

main(void)

Thank you

Harbormaster completed remote builds in B35422: Diff 80727.Dec 15 2020, 6:45 PM

@yuripv, let me know if that's a nice addition to the manual page or not. :) I understand it's basic stuff, but I feel like it's nice to show common patterns in a manual for reference.

Hmm, maybe it's better to keep the example shorter as in the err(3) manual page?

In D27623#617254, @0mp wrote:

@yuripv, let me know if that's a nice addition to the manual page or not. :) I understand it's basic stuff, but I feel like it's nice to show common patterns in a manual for reference.

it is nice addition indeed, every little bit helps

In D27623#617271, @0mp wrote:

Hmm, maybe it's better to keep the example shorter as in the err(3) manual page?

not sure, both works for me.

p.s. as you mentioned err(3), i think there an error in "Warn of an error" example -- second one uses err().

jilles added a subscriber: jilles.Dec 15 2020, 11:09 PM

jilles added inline comments.

lib/libc/string/strerror.3
161 ↗	(On Diff #80727)	This is not a great example since it is undefined behaviour. In fact, before FreeBSD 11.0, this caused a segmentation fault instead of an error return. Perhaps a better example is `fd = open("/dev/null/wrong", O_RDONLY);` which will fail with `Not a directory`.