Page MenuHomeFreeBSD

man9: Add a manual page for filedesc(9)
Needs ReviewPublic

Authored by raghav.original_gmail.com on Fri, Mar 27, 6:48 PM.
Referenced Files
Unknown Object (File)
Wed, Apr 15, 1:55 AM
Unknown Object (File)
Mon, Apr 13, 10:53 AM
Unknown Object (File)
Sun, Apr 12, 7:32 PM
Unknown Object (File)
Sat, Apr 11, 10:27 PM
Unknown Object (File)
Sat, Apr 11, 8:04 PM
Unknown Object (File)
Sat, Apr 11, 11:12 AM
Unknown Object (File)
Sat, Apr 11, 8:03 AM
Unknown Object (File)
Wed, Apr 8, 9:59 AM
Subscribers
This revision needs review, but there are no reviewers specified.

Details

Reviewers
None
Summary

man9: Add a manual page for filedesc(9)

A reference manpage already exists in NetBSD and this follows that general structure.

I would appreciate review on the DESCRIPTION section to see if it is accurate.
for reference here is the NetBSDs manpage for filedesc(9):
https://man.freebsd.org/cgi/man.cgi?query=filedesc&apropos=0&sektion=9&manpath=NetBSD+10.1&format=html

This is the issue which reports it:
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=143408

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

Hi Raghav,

Thanks for the patch.

Several observations:

  • Please run it through a spell checker, there are a couple of misspellings
  • Please place each sentence on a new line: it simplify future maintenance, especially for translators
  • Did you write the manpage from scratch or were any parts of it taken from elsewhere, e.g., from NetBSD? If the latter is true, the license section should reflect it. I am asking because I see that it least some wording matches NetBSD closely. Also, it may worth importing NetBSD manpage entirely, although I haven't checked if their code is identical or similar to us.

Please note that I didn't check whether the man page itself correct, matches the code, or if FreeBSD even needs it.

Maxim

Thank you Maxim for the review

I will run this through a spell checker.

  • Did you write the manpage from scratch or were any parts of it taken from elsewhere, e.g., from NetBSD? If the latter is true, the license

section should reflect it. I am asking because I see that it least some wording matches NetBSD closely.

Some portions of the wordings were taken from NetBSD where behavior seemed similar. How exactly should I reflect this in the license section.

Also, it may worth importing NetBSD manpage entirely, although I haven't checked if their code is identical or similar to us.

Yes their code is similar to us but FreeBSD has lot of functions with capability rights which I plan to document in the future revisions of this manpage.

Thank you Maxim for the review

I will run this through a spell checker.

  • Did you write the manpage from scratch or were any parts of it taken from elsewhere, e.g., from NetBSD? If the latter is true, the license

section should reflect it. I am asking because I see that it least some wording matches NetBSD closely.

Some portions of the wordings were taken from NetBSD where behavior seemed similar. How exactly should I reflect this in the license section.

If you borrow a substantial* amount of changes from NetBSD I'd the following:

(1) Preserved a copyright notice from their man page

(2) Preserved their license

(3) Attribute NetBSD origin in the man page in the Authors section. Something like: this man page incorporates text of filedesc.9 from NetBSD written by Joe Dow.

  • What is substantial and whether this is the case -- I don't really know. Use your gut feeling.

Maxim