From owner-dev-commits-src-all@freebsd.org Thu Jun 17 19:55:44 2021 Return-Path: Delivered-To: dev-commits-src-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id E666665D56A; Thu, 17 Jun 2021 19:55:44 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4G5Xq45vw1z3n6x; Thu, 17 Jun 2021 19:55:44 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id B3E14155B3; Thu, 17 Jun 2021 19:55:44 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 15HJtie6008930; Thu, 17 Jun 2021 19:55:44 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 15HJtiJB008929; Thu, 17 Jun 2021 19:55:44 GMT (envelope-from git) Date: Thu, 17 Jun 2021 19:55:44 GMT Message-Id: <202106171955.15HJtiJB008929@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: 5851680bcabe - main - style(9): Add advice about $FreeBSD$ MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 5851680bcabed1079bbb96c78512fedfa6c2737e Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 17 Jun 2021 19:55:45 -0000 The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=5851680bcabed1079bbb96c78512fedfa6c2737e commit 5851680bcabed1079bbb96c78512fedfa6c2737e Author: Warner Losh AuthorDate: 2021-06-17 19:54:12 +0000 Commit: Warner Losh CommitDate: 2021-06-17 19:54:59 +0000 style(9): Add advice about $FreeBSD$ 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. o Give advice about how to tag files derived from other files in the tree. Reviewed by: bcr, allanjude,ceri Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D30789 --- share/man/man9/style.9 | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index 77c8dbe8e7d7..fff0e3815c13 100644 --- a/share/man/man9/style.9 +++ b/share/man/man9/style.9 @@ -112,13 +112,20 @@ New lines should only be added when making substantial changes to the file, not for trivial changes. .Pp -After any copyright and license comment, there is a blank line, and the +After any copyright and license comment, there is a blank line. +If your code needs to be merged into stable/12 or earlier, it +needs to have the .Li $\&FreeBSD$ -for non C/C++ language source files. -Version control system ID tags should only exist once in a file -(unlike in this one). +tag. +Otherwise, this tag should be omitted in new code. +Legacy code will have the tag removed in the future. +For non C/C++ language source files, +.Li $\&FreeBSD$ +is next, if applicable. Non-C/C++ source files follow the example above, while C/C++ source files follow the one below. +Version control system ID tags should only exist once in a file +(unlike in this one). All VCS (version control system) revision identification in files obtained from elsewhere should be maintained, including, where applicable, multiple IDs showing a file's history. @@ -132,6 +139,11 @@ and to keep the IDs out of object files. Only add .Dq Li "From: " in front of foreign VCS IDs if the file is renamed. +Add +.Dq Li "From: " +and FreeBSD git hash with full path name if the file was derived +from another FreeBSD file and include relevant copyright info +from the original file. .Bd -literal /* From: @(#)style 1.14 (Berkeley) 4/28/95 */