Details

Reviewers

allanjude
ceri

Group Reviewers

manpages

Commits

rG5851680bcabe: style(9): Add advice about $FreeBSD$

Summary

Codify our standard practice with $FreeBSD$
o New code only needs it if it might land in stable/12
o Old code should retain it until stable/12 is unsupported
o We'll do a bulk remove in the future: don't do it proactively.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

imp created this revision.Jun 16 2021, 3:39 PM

Herald added a reviewer: manpages. · View Herald TranscriptJun 16 2021, 3:39 PM

imp requested review of this revision.Jun 16 2021, 3:39 PM

Harbormaster completed remote builds in B39932: Diff 90963.Jun 16 2021, 3:39 PM

s/can/should/

Harbormaster completed remote builds in B39933: Diff 90964.Jun 16 2021, 3:46 PM

Minor nit, thanks for the update.

share/man/man9/style.9
154	s/Otherwise/Otherwise,/

Wording tweak from bcr
Use .Li markup as used elsewhere for $FreeBSD$
Add ", if applicable" to an earlier mention of $FreeBSD$

Harbormaster completed remote builds in B39934: Diff 90971.Jun 16 2021, 5:20 PM

Tweaked a little.
A bit torn on whether to move the bulk of the wording changes up or not...

Add some additional, relevant advice.

Harbormaster completed remote builds in B39942: Diff 90988.Jun 17 2021, 12:18 AM

allanjude added a subscriber: allanjude.Jun 17 2021, 1:59 PM

allanjude added inline comments.

share/man/man9/style.9
118–119	Possibly as a separate commit: For non C/C++ language source files, if applicable, add .Li $\&FreeBSD$ after any copyright and license comment.

allanjude accepted this revision.Jun 17 2021, 2:00 PM

This revision is now accepted and ready to land.Jun 17 2021, 2:00 PM

emaste added a subscriber: emaste.Jun 17 2021, 2:08 PM

take up allanjude's suggestion, with a tweak or two (sorry allan,
I did this before I saw your review :)

This revision now requires review to proceed.Jun 17 2021, 2:55 PM

Harbormaster completed remote builds in B39950: Diff 91008.Jun 17 2021, 2:55 PM

ceri added a subscriber: ceri.Jun 17 2021, 3:13 PM

ceri added inline comments.

share/man/man9/style.9
119–124	This is a little unclear. Do C/C++ source files need to follow the same rules about including/not including $FreeBSD$? If so, why is this highlighted text where it is?