git: 41f56bf545 - main - developers-handbook: remove obsolete object file commentary
Ed Maste
emaste at FreeBSD.org
Wed Aug 4 18:27:26 UTC 2021
The branch main has been updated by emaste (src committer):
URL: https://cgit.FreeBSD.org/doc/commit/?id=41f56bf545e9d33953c38c3d879f096aab926ecb
commit 41f56bf545e9d33953c38c3d879f096aab926ecb
Author: Ed Maste <emaste at FreeBSD.org>
AuthorDate: 2021-08-04 16:19:41 +0000
Commit: Ed Maste <emaste at FreeBSD.org>
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.
More information about the dev-commits-doc-all
mailing list