Page MenuHomeFreeBSD
Differential D23942

Document that gettimeofday() is obsolescent
ClosedPublic
Actions

Authored by 0mp on Mar 3 2020, 3:18 PM.
Tags
None
Referenced Files
F83136127: D23942.diff
Mon, May 6, 7:53 PM
Unknown Object (File)
Mon, Apr 29, 3:05 AM
Unknown Object (File)
Sun, Apr 28, 8:06 PM
Unknown Object (File)
Sun, Apr 28, 5:36 PM
Unknown Object (File)
Fri, Apr 26, 4:28 PM
Unknown Object (File)
Thu, Apr 25, 4:05 PM
Unknown Object (File)
Thu, Apr 25, 9:45 AM
Unknown Object (File)
Tue, Apr 23, 2:39 PM
View All 43 Files
Subscribers
concussious.bugzilla_runbox.com
emaste
imp

Details

Reviewers
bcr
kaktus
pstef
Group Reviewers
manpages
Commits
rGf7659ab23590: Document that gettimeofday() is obsolescent
rGc32f8e613e57: Document that gettimeofday() is obsolescent
rG4395d3ced5cf: Document that gettimeofday() is obsolescent
Summary
Document that gettimeofday() is obsolescent

Reported by:	kaktus

I am not sure if I should put the link to this document in the commit message:
https://pubs.opengroup.org/onlinepubs/9699919799/functions/gettimeofday.html

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 29758
Build 27596: arc lint + arc unit

Event Timeline

0mp created this revision.Mar 3 2020, 3:18 PM
Herald added a reviewer: manpages. · View Herald TranscriptMar 3 2020, 3:18 PM
Herald added a subscriber: imp. · View Herald Transcript
Harbormaster completed remote builds in B29758: Diff 69123.Mar 3 2020, 3:18 PM
0mp updated this revision to Diff 69124.Mar 3 2020, 3:36 PM
  • Hard-code the correct standards name. mdoc cannot do it on its own at the moment.
Harbormaster completed remote builds in B29759: Diff 69124.Mar 3 2020, 3:37 PM
0mp edited the summary of this revision. (Show Details)Mar 3 2020, 3:52 PM
0mp added inline comments.
lib/libc/sys/gettimeofday.2
142

Related differential revision: https://reviews.freebsd.org/D23944

emaste added a subscriber: emaste.Mar 5 2020, 9:54 PM
bcr added a comment.Apr 23 2020, 1:40 PM

What's the status on this? Seems like all issues were resolved and it is ready for commit?

pstef accepted this revision.Jun 21 2020, 8:22 AM
This revision is now accepted and ready to land.Jun 21 2020, 8:22 AM
kaktus accepted this revision.Jun 21 2020, 9:36 AM
0mp added a comment.Jun 23 2020, 6:09 PM

This DR is blocked by https://reviews.freebsd.org/D23944.

Closed by commit rG4395d3ced5cf: Document that gettimeofday() is obsolescent (authored by 0mp). · Explain WhyThu, Apr 25, 9:44 AM
This revision was automatically updated to reflect the committed changes.
0mp added a commit: rG4395d3ced5cf: Document that gettimeofday() is obsolescent.
0mp added a commit: rGc32f8e613e57: Document that gettimeofday() is obsolescent.Sat, May 4, 1:07 PM
0mp added a commit: rGf7659ab23590: Document that gettimeofday() is obsolescent.
concussious.bugzilla_runbox.com added a subscriber: concussious.bugzilla_runbox.com.Sat, May 4, 9:15 PM

Sorry I'm late (no subscribe @manpages?)

How do you guys feel about similar language to PR #1195:

(First line after .Sh DESCRIPTION)
"Some commands attempt to describe the nature of a failure condition by using these pre-defined exit codes. This interface has been deprecated and is retained only for compatibility. Its use is discouraged."

I don't like the first line in the description being a emphasized note of depreciation. The first line in the description should explain what the manual is about. 10x as many people read the manual to determine what's going on with their existing stuff as they do to write new stuff. I also really prefer consistent syntax of "deprecated" over obsolescent, we say deprecated most of the time.

What we have in #1195 doesn't imply that it will be removed, but firmly, clearly and immediately states that it is deprecated, without resorting to Em, and still explaining what the page is about. And it's terse :)

Revision Contents
Changeset List

PathSize
lib/
libc/
sys/
20 lines

Diff 69123

View Options

lib/libc/sys/gettimeofday.2

Loading...