From nobody Wed Oct 02 14:09:03 2024 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4XJc9q2RMZz5XZlK for ; Wed, 02 Oct 2024 14:09:03 +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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4XJc9q1vMQz4k64; Wed, 2 Oct 2024 14:09:03 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727878143; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=OP5K25cI/OISfCMEO5d8+E8rBL+wJZ9SUK2VkGRZsBk=; b=cvNduwD1PGCjGIJyvTDkSkKxJHzloOTqF1dq9vvdni36p293PY4WBc/nY2hbt8G3vnkYo1 oUqntnsICbODGNrWYKUW2bOLyDFgMtMUOoR5ZJDcFAjFLP/am3pzhXXbXRcAbqO+aaV67+ h9k7UCiQh7zt6WdJLgEVy7hu0Gbdqlj6RIXQfY/x1a0EN3y42dWATmnml9CTDAU8U19PEi 0bzIfm6Td5L7cZlzd9kAmM+GmaeKTygYuEyWFp6Etyqr03QdHkD4NzLpbR4dvGURbBbVlF pOcjVKRRWIDgIJhnFX3aN9ytVOTZ1eBDzquq2Zbj1vPUDPG1hNk0u4eit4bpTA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1727878143; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=OP5K25cI/OISfCMEO5d8+E8rBL+wJZ9SUK2VkGRZsBk=; b=bzXY8MsVZDdeiFqLsWTIIeh2/LWdH7BOyLVDrsgnMdE22Z4UaoS4dXGoJOTmbcaAWajMnw p6EY6bk4wOeut53yJimw77j9j9S7rr6nV3yziOA3PbDlVX5/c43MOWfjv8ZXUS9M9OXLi/ OXX+F/hLBsMwSl9DwKyDaVcFbWU4T9JBcmVsEL6WEov2Acib5kt7dg5JCI8GmpVhw6a1qz 5nVf/Sw2diSydzekh6a1y15tGcqYdeNkEx56liu6igLCq0kxne2Cstn25JmMZaavcWF2vj 1RsuozaLlP5lijC/wvhmZJ8DqUsVBhCcz9ECOE1v3ykYYCJg5Qc6PGEODrXO7Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1727878143; a=rsa-sha256; cv=none; b=aIdSr9ZUjfCmVNR3TPvtmHSpzELCUVvCg8K7x51/hb/9qe/jqFrYA2wskUqVpxrz1w3x9a uYjxhhthX5ZJCaJR7HzK12jxLvdIKnVWrOth/wBLkCF4sCXeXEHts5EvKgO/dtyUB8TNh1 phl9NJHXNOiPhCoeSkGVNoU2Ea193MaSFwxmM0c75LWGziPmQnj2HqBGI5d9X8t4T8iqJu xeq6IuLzkdngHD9/CCW4tps1OxQXrLCZWJn8Q5g53ORaILhY8xmIDmaNn7FT5kERlG+M8x vYRpjIW/igo42tC2l40RFtk6OTnU6sd2h5azBatJKcX3d/IqMDIAgrgAcAQgJw== 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 4XJc9q1PV0z1P15; Wed, 2 Oct 2024 14:09:03 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 492E93M9066051; Wed, 2 Oct 2024 14:09:03 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 492E936J066048; Wed, 2 Oct 2024 14:09:03 GMT (envelope-from git) Date: Wed, 2 Oct 2024 14:09:03 GMT Message-Id: <202410021409.492E936J066048@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ed Maste Subject: git: b6ecd1fc99 - main - handbook: add warning about custom kernel configs List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org 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: b6ecd1fc99bf873699cd0678617aecee6e8cdc2c Auto-Submitted: auto-generated The branch main has been updated by emaste: URL: https://cgit.FreeBSD.org/doc/commit/?id=b6ecd1fc99bf873699cd0678617aecee6e8cdc2c commit b6ecd1fc99bf873699cd0678617aecee6e8cdc2c Author: Ed Maste AuthorDate: 2024-10-02 13:42:08 +0000 Commit: Ed Maste CommitDate: 2024-10-02 14:06:33 +0000 handbook: add warning about custom kernel configs Inform users that custom kernel configs are less well tested, and they should be prepared to participate in the investigation and remediation of any failures. Reviewed by: imp, olce Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D46875 --- documentation/content/en/books/handbook/kernelconfig/_index.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/documentation/content/en/books/handbook/kernelconfig/_index.adoc b/documentation/content/en/books/handbook/kernelconfig/_index.adoc index 0aadc0f2d2..a763eb0b4e 100644 --- a/documentation/content/en/books/handbook/kernelconfig/_index.adoc +++ b/documentation/content/en/books/handbook/kernelconfig/_index.adoc @@ -89,6 +89,13 @@ This has a number of benefits, such as: * Lower memory usage. A custom kernel often uses less memory than the [.filename]#GENERIC# kernel by omitting unused features and device drivers. This is important because the kernel code remains resident in physical memory at all times, preventing that memory from being used by applications. For this reason, a custom kernel is useful on a system with a small amount of RAM. * Additional hardware support. A custom kernel can add support for devices which are not present in the [.filename]#GENERIC# kernel. +[WARNING] +==== +When building a custom kernel, it is important to note that non-default configurations are less thoroughly tested than the GENERIC configuration. +While customizing the kernel can provide specific benefits it also increases the risk of encountering build or runtime issues. +Custom kernel configurations are recommended only for advanced users who have a specific reason for making changes and are willing to engage in the debugging process if necessary. +==== + Before building a custom kernel, consider the reason for doing so. If there is a need for specific hardware support, it may already exist as a module.