From owner-dev-commits-doc-all@freebsd.org Wed Aug 4 18:27:26 2021 Return-Path: Delivered-To: dev-commits-doc-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 BBA8F653927 for ; Wed, 4 Aug 2021 18:27:26 +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 4Gg0b24yybz4hrf; Wed, 4 Aug 2021 18:27:26 +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 929C834F1; Wed, 4 Aug 2021 18:27:26 +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 174IRQA5001908; Wed, 4 Aug 2021 18:27:26 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 174IRQWS001907; Wed, 4 Aug 2021 18:27:26 GMT (envelope-from git) Date: Wed, 4 Aug 2021 18:27:26 GMT Message-Id: <202108041827.174IRQWS001907@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ed Maste Subject: git: 41f56bf545 - main - developers-handbook: remove obsolete object file commentary MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: emaste X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 41f56bf545e9d33953c38c3d879f096aab926ecb Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 04 Aug 2021 18:27:26 -0000 The branch main has been updated by emaste (src committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=41f56bf545e9d33953c38c3d879f096aab926ecb commit 41f56bf545e9d33953c38c3d879f096aab926ecb Author: Ed Maste AuthorDate: 2021-08-04 16:19:41 +0000 Commit: Ed Maste CommitDate: 2021-08-04 18:26:35 +0000 developers-handbook: remove obsolete object file commentary It is no longer necessary to uuencode binary blobs for drivers. We can now commit the binary object to the tree as-is. Reviewed by: imp Approved by: ygy Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D31411 --- .../content/en/books/developers-handbook/policies/_index.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/content/en/books/developers-handbook/policies/_index.adoc b/documentation/content/en/books/developers-handbook/policies/_index.adoc index cfa074a542..ea92c91ea3 100644 --- a/documentation/content/en/books/developers-handbook/policies/_index.adoc +++ b/documentation/content/en/books/developers-handbook/policies/_index.adoc @@ -267,11 +267,12 @@ The following policies apply to including encumbered files in the FreeBSD source . Any file which is interpreted or executed by the system CPU(s) and not in source format is encumbered. . Any file with a license more restrictive than BSD or GNU is encumbered. -. A file which contains downloadable binary data for use by the hardware is not encumbered, unless (1) or (2) apply to it. It must be stored in an architecture neutral ASCII format (file2c or uuencoding is recommended). +. A file which contains downloadable binary data for use by the hardware is not encumbered, unless (1) or (2) apply to it. . Any encumbered file requires specific approval from the link:https://www.FreeBSD.org/administration/#t-core[Core Team] before it is added to the repository. . Encumbered files go in [.filename]#src/contrib# or [.filename]#src/sys/contrib#. . The entire module should be kept together. There is no point in splitting it, unless there is code-sharing with non-encumbered code. -. Object files are named [.filename]#arch/filename.o.uu>#. +. In the past binary files were typically uuencoded, and named [.filename]#arch/filename.o.uu#. + This is no longer necessary, and binary files may be added to the repository unchanged. . Kernel files: .. Should always be referenced in [.filename]#conf/files.*# (for build simplicity). .. Should always be in [.filename]#LINT#, but the link:https://www.FreeBSD.org/administration/#t-core[Core Team] decides per case if it should be commented out or not. The link:https://www.FreeBSD.org/administration/#t-core[Core Team] can, of course, change their minds later on.