From nobody Sun May 7 19:27:58 2023 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 4QDvb30jpJz49PJh for ; Sun, 7 May 2023 19:27:59 +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 4QDvb30BTPz4RdV; Sun, 7 May 2023 19:27:59 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683487679; 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=dlBtdGTajamquufWTh6ksxs/OT3a0lwIZ/2oKGc6feg=; b=icVenDHtWgCHsPmAlgHPPaiEoFcpWIgxLobgsNLwWpOYjTle9Z2+uUv5AM80uUuXxGIg0O 6se1PSmAlXgkoLkOx0BJiRDgLcrth6jlf+NG46Xc35bd5xkYgazVOL9upH0FXB2wbF5kgR oOYhU/k4en2NR6Xiwfskvg4rW0w2DJYT269uPfoZXwYHwYTct/fnUNP3s3N6jzqUXRg7c1 A8smnVkKBiu42qnnbHhzpmhCJK8EC2HUo8UsWuBPn74adx20gW7mdrMFuWY108KLR2jgqm F46FuTPy0oZX5MD/m+4SNBQROvquBPh4KipnxHu29uDYhoK9Nz2MqdxcGudxEQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683487679; 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=dlBtdGTajamquufWTh6ksxs/OT3a0lwIZ/2oKGc6feg=; b=tC6i39pKjl/UZ9wxhQvYTtj81qnAeFYiVPI7dY2zifCphwKTR/RJb3kMVAV3RO6zgHsQFn DCUZhZ9cV7UJZ1OnLPLBP4h6krC8mxX9VsXvjbdyN4KavlwxN6bLo+6/34s1zqp6eVPAR5 ktfwecmO4EUbJGuPHUvUiMu3XDnSs8U6Gs1jr0dP/ID0IaG8S8zBa9M8IWstzTD9+w6ksU k2bKpE8lky/LRxM8kGdIQD24fMY9JlQjYRcdW81HyKAKtdFmEiLDvxMaMt5iQlVVBT53xa 2P4PIHB1FydX0szkF5ng5By7s/FOd42+GRQx3reEg2O9kiCBS3kRDl5daKmklw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683487679; a=rsa-sha256; cv=none; b=JNwuc45WN0nVJu4xvw6V1K8cCILX1tzxQNJ48x7L43lVXHPEh4Tyu7muLZJFolEg8u+1jr jhXpnt4JmSkJLYqJbxy1act/RRnXT3PlGMuNFTA2kVQgoaG9xRGkkr+a4OtCq8pxUhnMYI 2UAShx3Cu2Jy0MPC7Wc003mOj7XNIZbxNQa113KCNqh/o4AXtjwbDlwhhLvJRGETOxZ/t1 J83XrS87oOTPyo1AHBMgax6SU6tcYfw0U8/f7Kony0r6/wJEGTXIIdFeN0Ib5nqWmASKEN BIqjQf66myM9N6gzeVUFqmbCk00fxZ/KCFR/+FK6ccZVhcaBv0NoYP65xCYrUQ== 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 4QDvb26LPszWCP; Sun, 7 May 2023 19:27:58 +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 347JRwFc057797; Sun, 7 May 2023 19:27:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 347JRwhT057796; Sun, 7 May 2023 19:27:58 GMT (envelope-from git) Date: Sun, 7 May 2023 19:27:58 GMT Message-Id: <202305071927.347JRwhT057796@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 8995ee8abe - main - Safekeep sam's src bit 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 8995ee8abef0109b893621a1a5e8aabdb892238f Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=8995ee8abef0109b893621a1a5e8aabdb892238f commit 8995ee8abef0109b893621a1a5e8aabdb892238f Author: Sergio Carlavilla Delgado AuthorDate: 2023-05-07 19:27:16 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2023-05-07 19:27:16 +0000 Safekeep sam's src bit Thank you for your years of service as src committer Approved by: core (implicit) --- shared/contrib-develalumni.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/shared/contrib-develalumni.adoc b/shared/contrib-develalumni.adoc index b6bced02d5..35eac6373a 100644 --- a/shared/contrib-develalumni.adoc +++ b/shared/contrib-develalumni.adoc @@ -1,3 +1,4 @@ +* {sam} (2002 - 2023) * {eadler} (2011 - 2023) * {nhibma} (1998 - 2023) * {ryusuke} (2009 - 2023) From nobody Mon May 8 10:12:28 2023 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 4QFHCc4mqQz49jZH for ; Mon, 8 May 2023 10:12:28 +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 4QFHCc4KXnz41cV; Mon, 8 May 2023 10:12:28 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683540748; 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=EaCI5dNr4BXYQsoTRmOqeONikxhCUutB3M5J5Su3cSY=; b=Zyk1j4W8CTQ1lWmy1El0hEUPmv2ZEhzGKMdKMqfJwg5ZBiytWiN6ldNyYRbkO9bt4VxRzT /8gAiwXcnW+m2vaad7J2uONRYboCxKq3P1lJQeLyeWQ+SuX43bgLR7em/Vo4HKm7gVH+S+ Q/lJfzpuyaWKdCZlLsw6UIF6EmDrYAXgPuGHRWdgKLXjnGL7cx0XD7mhYNoyjmzHnQuMd5 AWgAG/sGEKtGaDYzPn4Jhec2Rp/BF5P5N0b9ttZerrjHDkcQnJW3JTCd59NuVYj9cBp+zc 9Goyg/41Us7CQsfOQLcyfiw8juwyf8tPRJI1IUbf/fAQK9ig8XnvsVzpvMesqQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683540748; 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=EaCI5dNr4BXYQsoTRmOqeONikxhCUutB3M5J5Su3cSY=; b=aBSohXsMlQoFV3bm5HxEfusjc6S6i3x2sGTh9Bp9PTBC/Nrv3ARMQ6naxEkgmqJPTFQcUB Dktlgw7mRJ+sG+/5YRU1heKcWb5TiMa6WJD2yhIeQgEwxT/g0NtqlLY1YiXNt/dh0bE2uX NIjlqYbsexhOBVkmoGDVwb3Yc0wATTJAYgvxDhJFXt2a0vbk/eIpRSPyPkIKj6jtS12pZu 4BFXtQ9olnrjh+Yz8mu4XQy24LfUvSiRgmpFkB7LJIDYC4/Dy+JdqOs57K0xXb7C4BdQvO mxUgIY2pNDOo+eG8O6XJxgj8WetPvtKEXiBK1VL5A1UcSEMckttOfyLWV1rhfA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683540748; a=rsa-sha256; cv=none; b=OIjyTbDFA3DBHJyjqCP9/DotOBj83rvDBE6DNbl/m2E9oKzdu1J4xXw/mQkmOy6Tmb/U7v zw3csZ8QdpF+mwQrGCXoJlQp38lj2AwKeyYQVsCo/iJvTcdKzuUDDjdX3RLFGH0/7rHaAs R/7505rAyPBM8zHjMcOhyFU+Y4oxKkq/2xvx68CqyjNxn+OsVP3NCd9q25TaXBEf03vnNp fmPAC185D9xn1IesPeQeG8DW55HREiO5SqsQGKFK1BgCmD+Po51uH1Bwyc443TKC3FA56X d3lCXl/WhC9tg49dl9hln0LA/nlmH6ujiuJwcDuivj15npWRWrnyibQ/RHDuWQ== 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 4QFHCc3Pl3zwcg; Mon, 8 May 2023 10:12:28 +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 348ACSPE032074; Mon, 8 May 2023 10:12:28 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 348ACSHu032073; Mon, 8 May 2023 10:12:28 GMT (envelope-from git) Date: Mon, 8 May 2023 10:12:28 GMT Message-Id: <202305081012.348ACSHu032073@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: =?utf-8?Q?Fernando=20Apestegu=C3=ADa?= Subject: git: 6c87ece22b - main - [phb]: Changes to MAINTAINER require bump of PORTREVISION 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 6c87ece22b65be5419040deb58f578dbc39ffe6b Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=6c87ece22b65be5419040deb58f578dbc39ffe6b commit 6c87ece22b65be5419040deb58f578dbc39ffe6b Author: Fernando Apesteguía AuthorDate: 2023-05-04 14:23:02 +0000 Commit: Fernando Apesteguía CommitDate: 2023-05-08 10:07:02 +0000 [phb]: Changes to MAINTAINER require bump of PORTREVISION As discussed in the mail list since users would like to know who to contact in case of problems. It also helps in reproducible builds. Reviewed by: manu@ Differential Revision: https://reviews.freebsd.org/D39957 --- documentation/content/en/books/porters-handbook/makefiles/_index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc index 4424c368d0..ac8a9a5f51 100644 --- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc +++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc @@ -299,6 +299,7 @@ Examples of when `PORTREVISION` must be bumped: * Changes in the packing list or the install-time behavior of the package. For example, a change to a script which generates initial data for the package, like man:ssh[1] host keys. * Version bump of a port's shared library dependency (in this case, someone trying to install the old package after installing a newer version of the dependency will fail since it will look for the old libfoo.x instead of libfoo.(x+1)). * Silent changes to the port distfile which have significant functional differences. For example, changes to the distfile requiring a correction to [.filename]#distinfo# with no corresponding change to `DISTVERSION`, where a `diff -ru` of the old and new versions shows non-trivial changes to the code. +* Changes to `MAINTAINER`. Examples of changes which do not require a `PORTREVISION` bump: @@ -306,7 +307,6 @@ Examples of changes which do not require a `PORTREVISION` bump: * Changes to `MASTER_SITES` or other functional changes to the port which do not affect the resulting package. * Trivial patches to the distfile such as correction of typos, which are not important enough that users of the package have to go to the trouble of upgrading. * Build fixes which cause a package to become compilable where it was previously failing. As long as the changes do not introduce any functional change on any other platforms on which the port did previously build. Since `PORTREVISION` reflects the content of the package, if the package was not previously buildable then there is no need to increase `PORTREVISION` to mark a change. -* Changes to `MAINTAINER`. A rule of thumb is to decide whether a change committed to a port is something which _some_ people would benefit from having. Either because of an enhancement, fix, or by virtue that the new package will actually work at all. From nobody Mon May 8 10:39:47 2023 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 4QFHq81Hl4z49kx5 for ; Mon, 8 May 2023 10:39:48 +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 4QFHq80q98z43Cj; Mon, 8 May 2023 10:39:48 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683542388; 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=Rmq8gpz039lpLipab6GVw4uGOXP0dsbkVGez7mdjJnM=; b=Z8pcCFqOasU/+eVVS3v3S0tpIvNb6Q19hWrGPJ1udwyv2DRcfVNEPOU9F01NWbUq0H85rs tE561RT/Sjr2G2dsL6scuBZlET2SGqhhdE+ScD5AoZB+pm+fBNgWrYbMns8CLIVbOZIsqi AKZN88Ym3yIno/FWEJq9ZVi8DyQmZzCsKTsWzgHj+06F89/wp4RN/P46aTgxOuXeE4i1v4 wy6MPvFRoaxyJGucC543nqo+OqLNwRM8oBmIestgiILAmjNp69Nr8bZLqoThsHK5UtqXTs NUOAdvQlk6QEhaE/ca/OKXitslcE5+okedWfizo91bx05qidjlwfeW4vk7AXtA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683542388; 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=Rmq8gpz039lpLipab6GVw4uGOXP0dsbkVGez7mdjJnM=; b=JGL4OlcB7naDom6PFfp3lukeQrijgFiwf3FP/P4CSsTB2koUJ2Jyh8DWWgoVKkxs0JJ6K7 QwNVY+C7qD2fKM1yaxL1iaKJ2cF7I5M8XOhiiIud4wYlu/SUGaz8uHg3fN49N9g0Tjws6a AsWhaUnvGwa7KHeCMO4AzDPgyE5vlADLESzMfZWzOplnN/j1R5rGjoVsTdqeIzCYPAysog tyDDMJipScwurggWWLvIPvMGFJYru2mBEKPX6VG1AoMA2hpJMjmqAPQ50450iakfCLMbRS BhlvjuxiroGQfFM5IDsYknsmHnWjC3MO8vInyu5zMxUe0slzmGLysPvYn7iM+A== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683542388; a=rsa-sha256; cv=none; b=gV9WaM5GU0qVUoB1CbaOUyV0H/79TU80XEjuen0RxELqg+g8JIY0ljweB51gPq2+tLRU+L ZuXiFKVhZEuynmXf/WZ9ZsWxFIuJVL9CIDUfO0r337pyZNAGDQYjFFyoWpSp1W4eYcK4cP 5Q6FLPYcXE+1FcXuOkbQnCvEmKTwG0cjwGTWWx8aWwirvyYVLdgtmOe4WyGcA5Qey3IJDJ 8g3COiZuJoW/smv7BTrpuG09qRVA00FBfDu52j/X0qbjvZ8oPNTcMBTlvFEg/WBTB3XLJy SN9RbkR5IUwCS8vlCflv8hWbk4jzzTkUOo+P1ALeVnGVvA+Md4Dk1poag/6WPw== 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 4QFHq76zkczxS2; Mon, 8 May 2023 10:39:47 +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 348Adlds066720; Mon, 8 May 2023 10:39:47 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 348Adl5j066719; Mon, 8 May 2023 10:39:47 GMT (envelope-from git) Date: Mon, 8 May 2023 10:39:47 GMT Message-Id: <202305081039.348Adl5j066719@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Li-Wen Hsu Subject: git: 9eed05454d - main - releng: Add 12.3 to code-freeze status 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: lwhsu X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 9eed05454d19df8b141317991354bb8e8fcf3e7b Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by lwhsu: URL: https://cgit.FreeBSD.org/doc/commit/?id=9eed05454d19df8b141317991354bb8e8fcf3e7b commit 9eed05454d19df8b141317991354bb8e8fcf3e7b Author: Li-Wen Hsu AuthorDate: 2023-05-08 10:38:39 +0000 Commit: Li-Wen Hsu CommitDate: 2023-05-08 10:38:39 +0000 releng: Add 12.3 to code-freeze status PR: 271311 --- website/content/en/releng/_index.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/website/content/en/releng/_index.adoc b/website/content/en/releng/_index.adoc index 6cc570c2d6..45cc3b6e6e 100644 --- a/website/content/en/releng/_index.adoc +++ b/website/content/en/releng/_index.adoc @@ -51,6 +51,7 @@ This table lists the code freeze status for major branches of the `src/` reposit |`releng/13.0` |Frozen |security-officer@FreeBSD.org |FreeBSD 13.0 errata fix branch (not officially supported). |`stable/12` |Open |committers |Development branch for FreeBSD 12-STABLE. |`releng/12.4`|Frozen|security-officer@FreeBSD.org|FreeBSD 12.4 supported errata fix branch. +|`releng/12.3` |Frozen |security-officer@FreeBSD.org |FreeBSD 12.3 errata fix branch (not officially supported). |`releng/12.2` |Frozen |security-officer@FreeBSD.org |FreeBSD 12.2 errata fix branch (not officially supported). |`releng/12.1` |Frozen |security-officer@FreeBSD.org |FreeBSD 12.1 errata fix branch (not officially supported). |`releng/12.0` |Frozen |security-officer@FreeBSD.org |FreeBSD 12.0 errata fix branch (not officially supported). From nobody Mon May 8 14:01:49 2023 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 4QFNJG07k9z49xb9 for ; Mon, 8 May 2023 14:01:50 +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 4QFNJF6sQdz4QH2; Mon, 8 May 2023 14:01:49 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683554509; 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=HvUZeB4FKuipF7rKPDjmcK1t2KsjQUB9kB7zrqVG1F4=; b=q74/14w2NIANsQtDNLFNO3iMW40cLTPFQWdSaNhtfX6kFqIw0zYqC9A7avmj8C56bQxZgJ GYjJelF18RtW2J3Gs/NasHWGftiEH5Dj2bE7k1RymVvvOH3k0KPg/pMOOrRtfCIcNJpXR+ rXr8cMPLBy22xtTrHYjDljbZUtSycKyI4O05ny71Jye/MShKzwCmzrH6VdG4dwXdNAg9XH wE2vcBN3T27g9ABYItSGeWIDhuWyHmUUHnuDb6mVP3jEPOv3PgfRVO5BIcvqiF4BYlzTJM ITZ/3u6S5Y09pUsQcRUfcsdkwZ43wr9pX+aGWXV+tgG/HFNVECLM4seVuo6Cyg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683554509; 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=HvUZeB4FKuipF7rKPDjmcK1t2KsjQUB9kB7zrqVG1F4=; b=ZLlRH/2GDFJBGW/3WeD1mxfk5e/vAYb1zoMDIxy/gXdI4fSjgLKbtIRU0p6F2Qv9sOou6h TnGA9mJLNReDhWiE65jRL4V/kpXaZZDNJVT38z8y5sIfcQ0t/YvEU5I4hp9XHMKdz04+Ct cv90jRNa1DN/2dFBbQ836aXWkrma1Nh1DI8VGxUpq6Zm3sefypeBzyh0PdMvFpSDT1MOUg tonl1Mv6wFbU3XTipa3pBhxX5gqs51b3A+mAl+Oh6AHyEYsQwtdEfDQ6pycB6709MWeTZQ 70NGtpBh0DrgJPTWoNSJyRV3KY480WFWpl1rQItE8jaA2f31YEXDogw8GPiuWw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683554509; a=rsa-sha256; cv=none; b=LnlofGfrl0Ftvi/tHsqB0j/rDdLlFp4y6LxdHjBcF5Zv/VBiOBhsHp4ys1Z/6PF3AJW//o 6/qf/ezw4BIELU+hXEQa803Gol/WBiRA/8dg8XmtGyHpJqZplQnzJErbXGMqGuj6St9kxC kanhjkwN/gJ7+1wdwCDjI+mkqNF72Ijs4KRqX17vDScpWP/0sRJhATfCgsm7R/v74ZELk7 YMhh4yd6nWCW+JZzRb40TW4xOlVN85isl2tLkQHUleRCxldDygJWqhEYaGm/tRjimw/Iqu hpSJOaXUVJwAlLlvcWZTwxYt76jjHRunULUJHEg7xvTW1elTu0RRM9xkVTb0Gg== 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 4QFNJF5yCFz13N8; Mon, 8 May 2023 14:01:49 +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 348E1n1E009402; Mon, 8 May 2023 14:01:49 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 348E1nqa009401; Mon, 8 May 2023 14:01:49 GMT (envelope-from git) Date: Mon, 8 May 2023 14:01:49 GMT Message-Id: <202305081401.348E1nqa009401@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 2c95a54679 - main - Handbook - kernelconfig: Global review 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 2c95a546791c24dcc4dc8851599d557e00824c51 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=2c95a546791c24dcc4dc8851599d557e00824c51 commit 2c95a546791c24dcc4dc8851599d557e00824c51 Author: Sergio Carlavilla Delgado AuthorDate: 2023-05-08 13:59:26 +0000 Commit: Sergio Carlavilla Delgado CommitDate: 2023-05-08 13:59:26 +0000 Handbook - kernelconfig: Global review Changes: * Make the first paragraph a note * AsciiDoc tweaks * Remove stale architectures * Remove editors paragraph * Add link to config(5) * Remove pssection * Restore PORTS_MODULE variable Reviewed by: fernape@, karels@, mhorne@ Differential Revision: https://reviews.freebsd.org/D39836 --- .../en/books/handbook/kernelconfig/_index.adoc | 147 ++++++++++++--------- 1 file changed, 84 insertions(+), 63 deletions(-) diff --git a/documentation/content/en/books/handbook/kernelconfig/_index.adoc b/documentation/content/en/books/handbook/kernelconfig/_index.adoc index 2bc4c8a19a..9b5c761547 100644 --- a/documentation/content/en/books/handbook/kernelconfig/_index.adoc +++ b/documentation/content/en/books/handbook/kernelconfig/_index.adoc @@ -64,7 +64,10 @@ After reading this chapter, you will know: * How to install the new kernel. * How to troubleshoot if things go wrong. +[NOTE] +==== All of the commands listed in the examples in this chapter should be executed as `root`. +==== [[kernelconfig-custom-kernel]] == Why Build a Custom Kernel? @@ -82,29 +85,35 @@ Some security environments prevent the loading and unloading of kernel modules a Building a custom kernel is often a rite of passage for advanced BSD users. This process, while time consuming, can provide benefits to the FreeBSD system. -Unlike the [.filename]#GENERIC# kernel, which must support a wide range of hardware, a custom kernel can be stripped down to only provide support for that computer's hardware. +Unlike the `GENERIC` kernel, which must support a wide range of hardware, a custom kernel can be stripped down to only provide support for that computer's hardware. + This has a number of benefits, such as: * Faster boot time. Since the kernel will only probe the hardware on the system, the time it takes the system to boot can decrease. -* 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. +* Lower memory usage. A custom kernel often uses less memory than the `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 `GENERIC` kernel. +[NOTE] +==== 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. +==== Kernel modules exist in [.filename]#/boot/kernel# and may be dynamically loaded into the running kernel using man:kldload[8]. Most kernel drivers have a loadable module and manual page. + For example, the man:ath[4] wireless network driver has the following information in its manual page: -[source,shell,subs="macros"] +[.programlisting] .... Alternatively, to load the driver as a module at boot time, place the following line in man:loader.conf[5]: - if_ath_load="YES" + if_ath_load="YES" + if_ath_pci_load="YES" .... -Adding `if_ath_load="YES"` to [.filename]#/boot/loader.conf# will load this module dynamically at boot time. +Adding `if_ath_load="YES"` and `if_ath_pci_load="YES"` to [.filename]#/boot/loader.conf# will load these modules dynamically at boot time. In some cases, there is no associated module in [.filename]#/boot/kernel#. This is mostly true for certain subsystems. @@ -116,16 +125,11 @@ Before editing the kernel configuration file, it is recommended to perform an in On a dual-boot system, the inventory can be created from the other operating system. For example, Microsoft(R)'s Device Manager contains information about installed devices. -[NOTE] -==== -Some versions of Microsoft(R) Windows(R) have a System icon which can be used to access Device Manager. -==== - If FreeBSD is the only installed operating system, use man:dmesg[8] to determine the hardware that was found and listed during the boot probe. Most device drivers on FreeBSD have a manual page which lists the hardware supported by that driver. For example, the following lines indicate that the man:psm[4] driver found a mouse: -[source,shell] +[.programlisting] .... psm0: irq 12 on atkbdc0 psm0: [GIANT-LOCKED] @@ -143,6 +147,12 @@ For example: [source,shell] .... % pciconf -lv +.... + +The output should be similar to the following: + +[.programlisting] +.... ath0@pci0:3:0:0: class=0x020000 card=0x058a1014 chip=0x1014168c rev=0x01 hdr=0x00 vendor = 'Atheros Communications Inc.' device = 'AR5212 Atheros AR5212 802.11abg wireless' @@ -150,7 +160,7 @@ ath0@pci0:3:0:0: class=0x020000 card=0x058a1014 chip=0x1014168c rev=0x01 subclass = ethernet .... -This output shows that the [.filename]#ath# driver located a wireless Ethernet device. +This output shows that the `ath` driver located a wireless Ethernet device. The `-k` flag of man:man[1] can be used to provide useful information. For example, it can be used to display a list of manual pages which contain a particular device brand or name: @@ -158,6 +168,12 @@ For example, it can be used to display a list of manual pages which contain a pa [source,shell] .... # man -k Atheros +.... + +The output should be similar to the following: + +[.programlisting] +.... ath(4) - Atheros IEEE 802.11 wireless network driver ath_hal(4) - Atheros Hardware Access Layer (HAL) .... @@ -173,7 +189,7 @@ If [.filename]#/usr/src/# does not exist or it is empty, source has not been ins Source can be installed with Git using the instructions in crossref:mirrors[git,“Using Git”]. Once source is installed, review the contents of [.filename]#/usr/src/sys#. -This directory contains a number of subdirectories, including those which represent the following supported architectures: [.filename]#amd64#, [.filename]#i386#, [.filename]#powerpc#, and [.filename]#sparc64#. +This directory contains a number of subdirectories, including those which represent the FreeBSD supported architectures. Everything inside a particular architecture's directory deals with that architecture only and the rest of the code is machine independent code common to all platforms. Each supported architecture has a [.filename]#conf# subdirectory which contains the [.filename]#GENERIC# kernel configuration file for that architecture. @@ -189,14 +205,14 @@ This example creates a copy, named [.filename]#MYKERNEL#, of the [.filename]#GEN # cp GENERIC MYKERNEL .... -[.filename]#MYKERNEL# can now be customized with any `ASCII` text editor. -The default editor is vi, though an easier editor for beginners, called ee, is also installed with FreeBSD. +The [.filename]#MYKERNEL# file can now be customized with any text editor. The format of the kernel configuration file is simple. Each line contains a keyword that represents a device or subsystem, an argument, and a brief description. Any text after a `+#+` is considered a comment and ignored. To remove kernel support for a device or subsystem, put a `+#+` at the beginning of the line representing that device or subsystem. Do not add or remove a `+#+` for any line that you do not understand. +More information about the configuration kernel file can be found in man:config[5]. [WARNING] ==== @@ -211,7 +227,6 @@ For architecture independent options, refer to [.filename]#/usr/src/sys/conf/NOT [TIP] ==== When finished customizing the kernel configuration file, save a backup copy to a location outside of [.filename]#/usr/src#. - Alternately, keep the kernel configuration file elsewhere and create a symbolic link to the file: [source,shell] @@ -241,101 +256,113 @@ options IPDIVERT Using this method, the local configuration file expresses local differences from a [.filename]#GENERIC# kernel. As upgrades are performed, new features added to [.filename]#GENERIC# will also be added to the local kernel unless they are specifically prevented using `nooptions` or `nodevice`. -A comprehensive list of configuration directives and their descriptions may be found in man:config[5]. - -[NOTE] -==== -To build a file which contains all available options, run the following command as `root`: - -[source,shell] -.... -# cd /usr/src/sys/arch/conf && make LINT -.... -==== +A comprehensive list of configuration directives and their descriptions may be found in man:config[5]. [[kernelconfig-building]] == Building and Installing a Custom Kernel Once the edits to the custom configuration file have been saved, the source code for the kernel can be compiled using the following steps: -[.procedure] -==== -*Procedure: Building a Kernel* +Move to [.filename]#/usr/src#: -. Change to this directory: -+ [source,shell] .... # cd /usr/src .... -+ -. Compile the new kernel by specifying the name of the custom kernel configuration file: -+ + +Compile the new kernel by specifying the name of the custom kernel configuration file: + [source,shell] .... # make buildkernel KERNCONF=MYKERNEL .... -+ -. Install the new kernel associated with the specified kernel configuration file. This command will copy the new kernel to [.filename]#/boot/kernel/kernel# and save the old kernel to [.filename]#/boot/kernel.old/kernel#: -+ + +Install the new kernel associated with the specified kernel configuration file. This command will copy the new kernel to [.filename]#/boot/kernel/kernel# and save the old kernel to [.filename]#/boot/kernel.old/kernel#: + [source,shell] .... # make installkernel KERNCONF=MYKERNEL .... -+ -. Shutdown the system and reboot into the new kernel. If something goes wrong, refer to <>. -==== +Shutdown the system and reboot into the new kernel. If something goes wrong, refer to <>. + +[TIP] +==== By default, when a custom kernel is compiled, all kernel modules are rebuilt. To update a kernel faster or to build only custom modules, edit [.filename]#/etc/make.conf# before starting to build the kernel. - For example, this variable specifies the list of modules to build instead of using the default of building all modules: [.programlisting] .... -MODULES_OVERRIDE = linux acpi +MODULES_OVERRIDE= linux ipfw .... Alternately, this variable lists which modules to exclude from the build process: [.programlisting] .... -WITHOUT_MODULES = linux acpi sound +WITHOUT_MODULES= linux acpi sound +.... + +This variable instructs the build to skip kernel modules and compile only the kernel itself: + +[.programlisting] +.... +NO_MODULES= yes +.... + +The Ports Framework includes drivers and other modules that depend on kernel interfaces, such as package:graphics/drm-kmod[] or package:emulators/virtualbox-ose-kmod[]. +With the `PORTS_MODULES` variable every time the kernel is built, the ports containing kernel modules are re-built against the updated sources. +This ensures the kernel module stays in-sync with the kernel itself. +The kernel and ports trees should be updated together for maximum compatibility. +`PORTS_MODULES` can be added to [.filename]#/etc/make.conf# file to ensure all kernels you build rebuild this module. + +[.programlisting] +.... +PORTS_MODULES= drm-kmod virtualbox-ose-kmod .... Additional variables are available. Refer to man:make.conf[5] for details. +==== [[kernelconfig-trouble]] == If Something Goes Wrong There are four categories of trouble that can occur when building a custom kernel: -`config` fails:: -If `config` fails, it will print the line number that is incorrect. -As an example, for the following message, make sure that line 17 is typed correctly by comparing it to [.filename]#GENERIC# or [.filename]#NOTES#: -+ +=== `config` fails + +If man:config[5] fails, it will print the line number that is incorrect. + +As an example, for the following message, make sure that line 32 is typed correctly by comparing it to [.filename]#GENERIC# or [.filename]#NOTES#: + [source,shell] .... -config: line 17: syntax error +config: /usr/src/sys/amd64/conf/GENERIC:32: syntax error .... -`make` fails:: -If `make` fails, it is usually due to an error in the kernel configuration file which is not severe enough for `config` to catch. +=== `make` fails + +If man:make[1] fails, it is usually due to an error in the kernel configuration file which is not severe enough for `config` to catch. + Review the configuration, and if the problem is not apparent, send an email to the {freebsd-questions} which contains the kernel configuration file. [[kernelconfig-noboot]] -The kernel does not boot:: +=== The kernel does not boot + If the new kernel does not boot or fails to recognize devices, do not panic! Fortunately, FreeBSD has an excellent mechanism for recovering from incompatible kernels. + Simply choose the kernel to boot from at the FreeBSD boot loader. -This can be accessed when the system boot menu appears by selecting the "Escape to a loader prompt" option. -At the prompt, type `boot _kernel.old_`, or the name of any other kernel that is known to boot properly. -+ +This can be accessed when the system boot menu appears by selecting the "Kernel:" option, which initially displays "Kernel: default/kernel". +Each time the option is selected, another choice appears, for example "kernel.old". +When the desired kernel is listed, press return to boot. + After booting with a good kernel, check over the configuration file and try to build it again. One helpful resource is [.filename]#/var/log/messages# which records the kernel messages from every successful boot. Also, man:dmesg[8] will print the kernel messages from the current boot. -+ + [NOTE] ==== When troubleshooting a kernel make sure to keep a copy of a kernel that is known to work, such as [.filename]#GENERIC#. @@ -347,10 +374,4 @@ As soon as possible, move the working kernel by renaming the directory containin # mv /boot/kernel /boot/kernel.bad # mv /boot/kernel.good /boot/kernel .... - ==== - -The kernel works, but man:ps[1] does not:: -If the kernel version differs from the one that the system utilities have been built with, for example, a kernel built from -CURRENT sources is installed on a -RELEASE system, many system status commands like man:ps[1] and man:vmstat[8] will not work. -To fix this, crossref:cutting-edge[makeworld,recompile and install a world] built with the same version of the source tree as the kernel. -It is never a good idea to use a different version of the kernel than the rest of the operating system. From nobody Mon May 8 19:46:15 2023 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 4QFWxh1N7jz4BJ8B for ; Mon, 8 May 2023 19:46:16 +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 4QFWxh18SQz46Rw; Mon, 8 May 2023 19:46:16 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683575176; 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=fMh6zPNGppoDpM9YLVhI5L/wm8Ty/rYLXcXmKgwandI=; b=AVjTVgjR3FgvM/wOzoKH0GzjV3Nqr/GSB/CV+QfeqfDhH6K0ZaN5NAzEwJv7CPM/9Rywpy TsOY5TJCUBfS6k7VdQxTKTRDhLTiZymdRUSLIJMuOmtZ81HHn5TXLsf8398upiD0j/v3YO rrGfnW6x4hDKVOTqJ8oejO+ZG9mvb8J5uuLiMO4mdsTv3GNDJ+Cb2ZINLa4AmyVncYvgex k+WCmJyCNasG0ro1Mo8L69mIJScs2w969kTMS2qOU3tYky/vtv5kTvl+VpZweT5/IaXPoU EcJiEgLwV94E59wGBdJl1kFl+QzPf0c9H/cWVQQ6Ta28Lap/mW81X4z/6GFq5w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683575176; 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=fMh6zPNGppoDpM9YLVhI5L/wm8Ty/rYLXcXmKgwandI=; b=wLbq5Hj0KqP8YGowDmwJhyAx2sUEVVww6QcPuBB95oylTNYCu6/WDVYYADXynmnUYHjjAE /80u9ocI+D3vqyemWyC2osbawkbSeo+5pmyPWH2Y4T2lQEOr/GdJFIpCfFd8D4i6uzl4S5 jYY079Cu3QLK49p6wGyYybyLASvRqcJI+YkQKcSWP1iA4f2rPYMCGQGhxzz0ennxt6ra46 aXL3czEP6yW9RIOyK+cx6U/fbTCwd9ZRoy5dR8AdDLp2iiBW5W/m29C0XcjEkDMlSzNlOR uLFPn7P6dn56aOMyzd855BeBNmDMDapzJWq8QxvHrdzZ1jNNCpHU3oyJqDte2g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683575176; a=rsa-sha256; cv=none; b=r+/LkeQzB9M0BDCH7AYLo7KKKbHcAC+PrKUp8lvDEqnByq18FRaG4xEPywdcqIjIRnWb+5 yp5D3i0CkrOaCisuRxjVa214cxeUF5se3IqOzw26q2PcMDH6T+9LoAzgUmJQohqLp/vOHU G6/6SwyJF6YARLF6FlfuWmjNPSKFC4af+8hEcLk47j8sp6HsU+SRnGRf+01DRu+XxZmwT9 Q5CjWTZytChiW+hsNyjyabiyAoP//KxPoUOx5smFPSSUNwdJ65i7P6EjlCnahhItMFWw/9 WulDZd6gC6JqV3VbzBtwRbBDz5miqeTMLpVGSQnWMEkTsdFMZ6nvA63MJpeB8Q== 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 4QFWxh0Bksz1D4k; Mon, 8 May 2023 19:46:16 +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 348JkGkD072171; Mon, 8 May 2023 19:46:16 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 348JkFmF072170; Mon, 8 May 2023 19:46:15 GMT (envelope-from git) Date: Mon, 8 May 2023 19:46:15 GMT Message-Id: <202305081946.348JkFmF072170@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Edson Brandi Subject: git: 3219cd782e - main - Article freebsd-src-lsp translated to pt_BR and synced with doc tree version 98c736dd127a2096dc08252d1082300f2ec28ab5 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ebrandi X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 3219cd782eeeb882a84b75a8b31d5c7833326d57 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by ebrandi: URL: https://cgit.FreeBSD.org/doc/commit/?id=3219cd782eeeb882a84b75a8b31d5c7833326d57 commit 3219cd782eeeb882a84b75a8b31d5c7833326d57 Author: Edson Brandi AuthorDate: 2023-05-08 19:45:25 +0000 Commit: Edson Brandi CommitDate: 2023-05-08 19:45:25 +0000 Article freebsd-src-lsp translated to pt_BR and synced with doc tree version 98c736dd127a2096dc08252d1082300f2ec28ab5 --- .../pt-br/articles/freebsd-src-lsp/_index.adoc | 268 ++++++++ .../pt-br/articles/freebsd-src-lsp/_index.po | 702 +++++++++++++++++++++ 2 files changed, 970 insertions(+) diff --git a/documentation/content/pt-br/articles/freebsd-src-lsp/_index.adoc b/documentation/content/pt-br/articles/freebsd-src-lsp/_index.adoc new file mode 100644 index 0000000000..98dd54ff75 --- /dev/null +++ b/documentation/content/pt-br/articles/freebsd-src-lsp/_index.adoc @@ -0,0 +1,268 @@ +--- +authors: + - + author: 'Ka Ho Ng' + email: khng@FreeBSD.org +copyright: '2021 The FreeBSD Foundation' +description: 'Utilize servidores de linguagem para o desenvolvimento na árvore src do FreeBSD para obter resultados precisos e completos ao buscar a definição de um termo no código fonte.' +tags: ["FreeBSD", "Language Server", "LSP"] +title: 'Utilize Servidores de Linguagem para o Desenvolvimento na Árvore Src do FreeBSD' +trademarks: ["freebsd"] +--- + += Utilize Servidores de Linguagem para o Desenvolvimento na Árvore Src do FreeBSD +:doctype: article +:toc: macro +:toclevels: 1 +:icons: font +:sectnums: +:sectnumlevels: 6 +:source-highlighter: rouge +:experimental: +:images-path: articles/freebsd-src-lsp/ + +ifdef::env-beastie[] +ifdef::backend-html5[] +include::shared/authors.adoc[] +include::shared/mirrors.adoc[] +include::shared/releases.adoc[] +include::shared/attributes/attributes-{{% lang %}}.adoc[] +include::shared/{{% lang %}}/teams.adoc[] +include::shared/{{% lang %}}/mailing-lists.adoc[] +include::shared/{{% lang %}}/urls.adoc[] +:imagesdir: ../../../images/{images-path} +endif::[] +ifdef::backend-pdf,backend-epub3[] +include::../../../../shared/asciidoctor.adoc[] +endif::[] +endif::[] + +ifndef::env-beastie[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] + +toc::[] + +[[intro]] +== Introdução + +Este guia é sobre como configurar uma árvore src do FreeBSD com servidores de linguagem realizando a indexação de código fonte. O guia descreve os passos para o Vim/NeoVim e o VSCode. Se você usar um editor de texto diferente, pode usar este guia como referência e procurar os comandos equivalentes para o seu editor preferido. + +[[requirements]] +== Requisitos + +Para seguir este guia, precisamos instalar certos requisitos. Precisamos de um servidor de linguagem, `ccls` ou `clangd`, e opcionalmente um banco de dados de compilação. + +A instalação do servidor de linguagem pode ser realizada via `pkg` ou via ports. Se escolhermos `clangd`, precisaremos instalar o `llvm`. + +Usando o `pkg` para instalar o `ccls`: + +[source, shell] +.... +# pkg install ccls +.... + +Se quisermos usar o `clangd`, precisaremos instalar o `llvm` (O comando de exemplo usa o `llvm15`, mas escolha a versão que desejar): + +[source, shell] +.... +# pkg install llvm15 +.... + +Para instalar via ports, escolha a sua combinação favorita de ferramentas de cada categoria abaixo: + +* Implementações de servidores de linguagem +** package:devel/ccls[] +** package:devel/llvm12[] (Outras versões também são aceitáveis, mas as mais novas são melhores. Substitua `clangd12` por `clangdN` no caso de outras versões serem usadas.) +* Editores +** package:editors/vim[] +** package:editors/neovim[] +** package:editors/vscode[] +* Gerador de banco de dados de compilação +** package:devel/python[] (Para a implementação do scan-build-py do llvm) +** package:devel/py-pip[] (Para a implementação do scan-build do rizsotto) +** package:devel/bear[] + +[[editor-settings]] +== Configurações do editor + +[[settings-vim]] +=== Vim/Neovim + +==== Plugins de cliente LSP + +O gerenciador de plugin integrado é usado para ambos os editores neste exemplo. O plugin do cliente LSP usado é o link:https://github.com/prabirshrestha/vim-lsp[prabirshrestha/vim-lsp]. + +Para configurar o plugin do cliente LSP para o Neovim: + +[source, shell] +.... +# mkdir -p ~/.config/nvim/pack/lsp/start +# git clone https://github.com/prabirshrestha/vim-lsp ~/.config/nvim/pack/lsp/start/vim-lsp +.... + +e para o Vim: + +[source, shell] +.... +# mkdir -p ~/.vim/pack/lsp/start +# git clone https://github.com/prabirshrestha/vim-lsp ~/.vim/pack/lsp/start/vim-lsp +.... + +Para habilitar o plugin do cliente LSP no editor, adicione o seguinte trecho em [.filepath]#~/.config/nvim/init.vim# ao usar o Neovim, ou [.filepath]#~/.vim/vimrc# ao usar o Vim: + +.Para o ccls +[source, vim] +.... +au User lsp_setup call lsp#register_server({ + \ 'name': 'ccls', + \ 'cmd': {server_info->['ccls']}, + \ 'allowlist': ['c', 'cpp', 'objc'], + \ 'initialization_options': { + \ 'cache': { + \ 'hierarchicalPath': v:true + \ } + \ }}) +.... + +.Para o clangd +[source, vim] +.... +au User lsp_setup call lsp#register_server({ + \ 'name': 'clangd', + \ 'cmd': {server_info->['clangd15', '--background-index', '--header-insertion=never']}, + \ 'allowlist': ['c', 'cpp', 'objc'], + \ 'initialization_options': {}, + \ }) +.... + +Dependendo da versão que você instalou para o `clangd`, pode ser necessário atualizar o `server-info` para apontar para o binário correto. + +Por favor, consulte link:https://github.com/prabirshrestha/vim-lsp/blob/master/README.md#registering-servers[] para aprender sobre como configurar atalhos e as funções para autocompletar o código. O site oficial do clangd é link:https://clangd.llvm.org[], e o repositório do ccls é link:https://github.com/MaskRay/ccls/[]. + +Abaixo estão as configurações de referência para atalhos de teclado e o autocomplemento de código. Insira o seguinte trecho em [.filepath]#~/.config/nvim/init.vim# ou [.filepath]#~/.vim/vimrc# para que usuários do Vim possam utilizá-las: + +[source, vim] +.... +function! s:on_lsp_buffer_enabled() abort + setlocal omnifunc=lsp#complete + setlocal completeopt-=preview + setlocal keywordprg=:LspHover + + nmap (lsp-definition) + nmap ] (lsp-peek-definition) + nmap (lsp-peek-definition) + nmap gr (lsp-references) + nmap (lsp-next-reference) + nmap (lsp-previous-reference) + nmap gI (lsp-implementation) + nmap go (lsp-document-symbol) + nmap gS (lsp-workspace-symbol) + nmap ga (lsp-code-action) + nmap gR (lsp-rename) + nmap gm (lsp-signature-help) +endfunction + +augroup lsp_install + au! + autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled() +augroup END +.... + +[[settings-vscode]] +=== VSCode + +==== Plugins de cliente LSP + +Plugins de cliente LSP são necessários para iniciar o daemon do servidor de linguagem. Pressione `Ctrl+Shift+X` para exibir o painel de pesquisa de extensões online. Digite `llvm-vs-code-extensions.vscode-clangd` quando estiver usando o clangd, ou `ccls-project.ccls` quando estiver usando o ccls. + +Em seguida, pressione `Ctrl+Shift+P` para exibir a paleta de comandos do editor. Digite `Preferences: Open Settings (JSON)` na paleta e pressione `Enter` para abrir o [.filepath]#settings.json#. Dependendo das implementações do servidor de linguagem, adicione um dos seguintes pares chave/valor JSON em [.filepath]#settings.json#: + +.Para o clangd +[source, json] +.... +[ + /* Begin of your existing configurations */ + ... + /* End of your existing configurations */ + "clangd.arguments": [ + "--background-index", + "--header-insertion=never" + ], + "clangd.path": "clangd12" +] +.... + +.Para o ccls +[source, json] +.... +[ + /* Begin of your existing configurations */ + ... + /* End of your existing configurations */ + "ccls.cache.hierarchicalPath": true +] +.... + +[[cdb]] +== Banco de dados de compilação + +Um banco de dados de compilação contém um array de objetos de comando de compilação. Cada objeto especifica uma maneira de compilar um arquivo de origem. O arquivo de banco de dados de compilação geralmente é chamado de [.filename]#compile_commands.json#. O banco de dados é usado por implementações de servidores de linguagem para fins de indexação. + +Por favor, consulte link:https://clang.llvm.org/docs/JSONCompilationDatabase.html#format[] para obter detalhes sobre o formato do arquivo do banco de dados de compilação. + +[[cdb-generators]] +=== Geradores + +[[generators-scan-build-py]] +==== Usando scan-build-py + +===== Instalação + +A ferramenta `intercept-build` do scan-build-py é usada para gerar o banco de dados de compilação. + +Primeiro instale o package:devel/python[] para obter o interpretador Python. Para obter o `intercept-build` do LLVM: + +[source, shell] +.... +# git clone https://github.com/llvm/llvm-project /path/to/llvm-project +.... + +onde [.filename]#/path/to/llvm-project/# é o caminho desejado para o repositório. Crie um alias no arquivo de configuração do shell para conveniência: + +[source, shell] +.... +alias intercept-build='/path/to/llvm-project/clang/tools/scan-build-py/bin/intercept-build' +.... + +Você também pode usar o link:https://github.com/rizsotto/scan-build[rizsotto/scan-build] em vez do scan-build-py do LLVM. O scan-build-py do LLVM foi incorporado ao repositório do LLVM. Essa implementação pode ser instalada com o comando `pip install --user scan-build`. O script `intercept-build` é instalado por padrão em [.filename]#~/.local/bin#. + +===== Uso + +No diretório raiz da árvore src do FreeBSD, gere o banco de dados de compilação com o `intercept-build`: + +[source, shell] +.... +# intercept-build --append make buildworld buildkernel -j`sysctl -n hw.ncpu` +.... + +A opção `--append` instrui o `intercept-build` a ler um banco de dados de compilação existente (se existir) e adicionar os resultados ao banco de dados. As entradas com chaves de comando duplicadas são mescladas. O banco de dados de compilação gerado por padrão é salvo no diretório de trabalho atual como [.filename]#compile_commands.json#. + +[[generators-bear]] +==== Usando o devel/bear + +===== Uso + +No diretório raiz da árvore src do FreeBSD, para gerar o banco de dados de compilação com o `bear`: + +[source, shell] +.... +# bear --append -- make buildworld buildkernel -j`sysctl -n hw.ncpu` +.... + +A opção `--append` instrui o `bear` a ler um banco de dados de compilação existente, se estiver presente, e adicionar os resultados ao banco de dados. As entradas com chave de comando duplicada são mescladas. O banco de dados de compilação gerado por padrão é salvo no diretório de trabalho atual como [.filename]#compile_commands.json#. + +[[final]] +== Finalizando + +Depois que o banco de dados de compilação for gerado, abra qualquer arquivo de código fonte na árvore src do FreeBSD e o daemon do servidor LSP será lançado em segundo plano. Abrir arquivos de código fonte na árvore src pela primeira vez leva significativamente mais tempo antes que o servidor LSP seja capaz de fornecer um resultado completo, devido à indexação de segundo plano inicial pelo servidor LSP compilando todas as entradas listadas no banco de dados de compilação. No entanto, o daemon do servidor de linguagem não indexa os arquivos de origem que não aparecem no banco de dados de compilação, portanto, nenhum resultado completo é mostrado em arquivos de origem que não estão sendo compilados durante o `make`. diff --git a/documentation/content/pt-br/articles/freebsd-src-lsp/_index.po b/documentation/content/pt-br/articles/freebsd-src-lsp/_index.po new file mode 100644 index 0000000000..18684ac133 --- /dev/null +++ b/documentation/content/pt-br/articles/freebsd-src-lsp/_index.po @@ -0,0 +1,702 @@ +# SOME DESCRIPTIVE TITLE +# Copyright (C) YEAR The FreeBSD Project +# This file is distributed under the same license as the FreeBSD Documentation package. +# FIRST AUTHOR , YEAR. +# +msgid "" +msgstr "" +"Project-Id-Version: FreeBSD Documentation VERSION\n" +"POT-Creation-Date: 2023-04-20 20:56-0300\n" +"PO-Revision-Date: 2023-05-08 19:31+0000\n" +"Last-Translator: Edson Brandi \n" +"Language-Team: Portuguese (Brazil) \n" +"Language: pt_BR\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 4.17\n" + +#. type: YAML Front Matter: description +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:1 +#, no-wrap +msgid "Use Language Servers for development in the FreeBSD src tree to get precise go-to-definition and completion results." +msgstr "" +"Utilize servidores de linguagem para o desenvolvimento na árvore src do " +"FreeBSD para obter resultados precisos e completos ao buscar a definição de " +"um termo no código fonte." + +#. type: Title = +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:1 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:13 +#, no-wrap +msgid "Use Language Servers for Development in the FreeBSD Src Tree" +msgstr "" +"Utilize Servidores de Linguagem para o Desenvolvimento na Árvore Src do " +"FreeBSD" + +#. type: Title == +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:47 +#, no-wrap +msgid "Introduction" +msgstr "Introdução" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:50 +msgid "" +"This guide is about setting up a FreeBSD src tree with language servers " +"performing source code indexing. The guide describes the steps for Vim/" +"NeoVim and VSCode. If you use a different text editor you can use this guide " +"as a reference and search the equivalent commands for your preferred editor." +msgstr "" +"Este guia é sobre como configurar uma árvore src do FreeBSD com servidores " +"de linguagem realizando a indexação de código fonte. O guia descreve os " +"passos para o Vim/NeoVim e o VSCode. Se você usar um editor de texto " +"diferente, pode usar este guia como referência e procurar os comandos " +"equivalentes para o seu editor preferido." + +#. type: Title == +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:52 +#, no-wrap +msgid "Requirements" +msgstr "Requisitos" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:55 +msgid "" +"In order to follow this guide we need to install certain requirements. We " +"need a Language server, `ccls` or `clangd`, and optionally a compilation " +"database." +msgstr "" +"Para seguir este guia, precisamos instalar certos requisitos. Precisamos de " +"um servidor de linguagem, `ccls` ou `clangd`, e opcionalmente um banco de " +"dados de compilação." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:57 +msgid "" +"The installation of the Language server can be performed via `pkg` or via " +"ports. If we chose `clangd` we need to install `llvm`." +msgstr "" +"A instalação do servidor de linguagem pode ser realizada via `pkg` ou via " +"ports. Se escolhermos `clangd`, precisaremos instalar o `llvm`." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:59 +msgid "Using `pkg` to install `ccls`:" +msgstr "Usando o `pkg` para instalar o `ccls`:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:63 +#, no-wrap +msgid "# pkg install ccls\n" +msgstr "# pkg install ccls\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:66 +msgid "" +"If we want to use `clangd` we need to install `llvm` (The example command " +"uses `llvm15` but choose the version you desire):" +msgstr "" +"Se quisermos usar o `clangd`, precisaremos instalar o `llvm` (O comando de " +"exemplo usa o `llvm15`, mas escolha a versão que desejar):" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:70 +#, no-wrap +msgid "# pkg install llvm15\n" +msgstr "# pkg install llvm15\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:73 +msgid "" +"To install via ports choose a favorite combination of tools from each " +"category below:" +msgstr "" +"Para instalar via ports, escolha a sua combinação favorita de ferramentas de " +"cada categoria abaixo:" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:75 +msgid "Language server implementations" +msgstr "Implementações de servidores de linguagem" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:76 +msgid "package:devel/ccls[]" +msgstr "package:devel/ccls[]" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:77 +msgid "" +"package:devel/llvm12[] (Other versions are okay, but newer is better. " +"Replace `clangd12` with clangdN in case other versions are used.)" +msgstr "" +"package:devel/llvm12[] (Outras versões também são aceitáveis, mas as mais " +"novas são melhores. Substitua `clangd12` por `clangdN` no caso de outras " +"versões serem usadas.)" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:78 +msgid "Editors" +msgstr "Editores" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:79 +msgid "package:editors/vim[]" +msgstr "package:editors/vim[]" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:80 +msgid "package:editors/neovim[]" +msgstr "package:editors/neovim[]" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:81 +msgid "package:editors/vscode[]" +msgstr "package:editors/vscode[]" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:82 +msgid "Compilation database generator" +msgstr "Gerador de banco de dados de compilação" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:83 +msgid "package:devel/python[] (For llvm's scan-build-py implementation)" +msgstr "package:devel/python[] (Para a implementação do scan-build-py do llvm)" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:84 +msgid "package:devel/py-pip[] (For rizsotto's scan-build implementation)" +msgstr "package:devel/py-pip[] (Para a implementação do scan-build do rizsotto)" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:85 +msgid "package:devel/bear[]" +msgstr "package:devel/bear[]" + +#. type: Title == +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:87 +#, no-wrap +msgid "Editor settings" +msgstr "Configurações do editor" + +#. type: Title === +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:90 +#, no-wrap +msgid "Vim/Neovim" +msgstr "Vim/Neovim" + +#. type: Title ==== +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:92 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:178 +#, no-wrap +msgid "LSP client plugins" +msgstr "Plugins de cliente LSP" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:96 +msgid "" +"The built-in plugin manager is used for both editors in this example. The " +"LSP client plugin used is link:https://github.com/prabirshrestha/vim-" +"lsp[prabirshrestha/vim-lsp]." +msgstr "" +"O gerenciador de plugin integrado é usado para ambos os editores neste " +"exemplo. O plugin do cliente LSP usado é o link:https://github.com/" +"prabirshrestha/vim-lsp[prabirshrestha/vim-lsp]." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:98 +msgid "To set up the LSP client plugin for Neovim:" +msgstr "Para configurar o plugin do cliente LSP para o Neovim:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:103 +#, no-wrap +msgid "" +"# mkdir -p ~/.config/nvim/pack/lsp/start\n" +"# git clone https://github.com/prabirshrestha/vim-lsp ~/.config/nvim/pack/lsp/start/vim-lsp\n" +msgstr "" +"# mkdir -p ~/.config/nvim/pack/lsp/start\n" +"# git clone https://github.com/prabirshrestha/vim-lsp ~/.config/nvim/pack/" +"lsp/start/vim-lsp\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:106 +msgid "and for Vim:" +msgstr "e para o Vim:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:111 +#, no-wrap +msgid "" +"# mkdir -p ~/.vim/pack/lsp/start\n" +"# git clone https://github.com/prabirshrestha/vim-lsp ~/.vim/pack/lsp/start/vim-lsp\n" +msgstr "" +"# mkdir -p ~/.vim/pack/lsp/start\n" +"# git clone https://github.com/prabirshrestha/vim-lsp ~/.vim/pack/lsp/start/" +"vim-lsp\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:114 +msgid "" +"To enable the LSP client plugin in the editor, add the following snippet " +"into [.filepath]#~/.config/nvim/init.vim# when using Neovim, or [." +"filepath]#~/.vim/vimrc# when using Vim:" +msgstr "" +"Para habilitar o plugin do cliente LSP no editor, adicione o seguinte trecho " +"em [.filepath]#~/.config/nvim/init.vim# ao usar o Neovim, ou [.filepath]#~/." +"vim/vimrc# ao usar o Vim:" + +#. type: Block title +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:115 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:203 +#, no-wrap +msgid "For ccls" +msgstr "Para o ccls" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:127 +#, no-wrap +msgid "" +"au User lsp_setup call lsp#register_server({\n" +" \\ 'name': 'ccls',\n" +" \\ 'cmd': {server_info->['ccls']},\n" +" \\ 'allowlist': ['c', 'cpp', 'objc'],\n" +" \\ 'initialization_options': {\n" +" \\ 'cache': {\n" +" \\ 'hierarchicalPath': v:true\n" +" \\ }\n" +" \\ }})\n" +msgstr "" +"au User lsp_setup call lsp#register_server({\n" +" \\ 'name': 'ccls',\n" +" \\ 'cmd': {server_info->['ccls']},\n" +" \\ 'allowlist': ['c', 'cpp', 'objc'],\n" +" \\ 'initialization_options': {\n" +" \\ 'cache': {\n" +" \\ 'hierarchicalPath': v:true\n" +" \\ }\n" +" \\ }})\n" + +#. type: Block title +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:129 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:188 +#, no-wrap +msgid "For clangd" +msgstr "Para o clangd" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:138 +#, no-wrap +msgid "" +"au User lsp_setup call lsp#register_server({\n" +" \\ 'name': 'clangd',\n" +" \\ 'cmd': {server_info->['clangd15', '--background-index', '--header-insertion=never']},\n" +" \\ 'allowlist': ['c', 'cpp', 'objc'],\n" +" \\ 'initialization_options': {},\n" +" \\ })\n" +msgstr "" +"au User lsp_setup call lsp#register_server({\n" +" \\ 'name': 'clangd',\n" +" \\ 'cmd': {server_info->['clangd15', '--background-index', '--header-" +"insertion=never']},\n" +" \\ 'allowlist': ['c', 'cpp', 'objc'],\n" +" \\ 'initialization_options': {},\n" +" \\ })\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:141 +msgid "" +"Depending on the version that you installed for `clangd` you might need to " +"update the `server-info` to point to the correct binary." +msgstr "" +"Dependendo da versão que você instalou para o `clangd`, pode ser necessário " +"atualizar o `server-info` para apontar para o binário correto." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:144 +msgid "" +"Please refer to link:https://github.com/prabirshrestha/vim-lsp/blob/master/" +"README.md#registering-servers[] to learn about setting up key bindings and " +"code completion. The official site of clangd is link:https://clangd.llvm." +"org[], and the repository link of ccls is link:https://github.com/MaskRay/" +"ccls/[]." +msgstr "" +"Por favor, consulte link:https://github.com/prabirshrestha/vim-lsp/blob/" +"master/README.md#registering-servers[] para aprender sobre como configurar " +"atalhos e as funções para autocompletar o código. O site oficial do clangd é " +"link:https://clangd.llvm.org[], e o repositório do ccls é link:https://github" +".com/MaskRay/ccls/[]." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:147 +msgid "" +"Below are the reference settings of keybindings and code completions. Put " +"the following snippet into [.filepath]#~/.config/nvim/init.vim#, or [." +"filepath]#~/.vim/vimrc# for Vim users to use it:" +msgstr "" +"Abaixo estão as configurações de referência para atalhos de teclado e o " +"autocomplemento de código. Insira o seguinte trecho em [.filepath]#~/.config/" +"nvim/init.vim# ou [.filepath]#~/.vim/vimrc# para que usuários do Vim possam " +"utilizá-las:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:154 +#, no-wrap +msgid "" +"function! s:on_lsp_buffer_enabled() abort\n" +" setlocal omnifunc=lsp#complete\n" +" setlocal completeopt-=preview\n" +" setlocal keywordprg=:LspHover\n" +msgstr "" +"function! s:on_lsp_buffer_enabled() abort\n" +" setlocal omnifunc=lsp#complete\n" +" setlocal completeopt-=preview\n" +" setlocal keywordprg=:LspHover\n" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:168 +#, no-wrap +msgid "" +" nmap (lsp-definition)\n" +" nmap ] (lsp-peek-definition)\n" +" nmap (lsp-peek-definition)\n" +" nmap gr (lsp-references)\n" +" nmap (lsp-next-reference)\n" +" nmap (lsp-previous-reference)\n" +" nmap gI (lsp-implementation)\n" +" nmap go (lsp-document-symbol)\n" +" nmap gS (lsp-workspace-symbol)\n" +" nmap ga (lsp-code-action)\n" +" nmap gR (lsp-rename)\n" +" nmap gm (lsp-signature-help)\n" +"endfunction\n" +msgstr "" +" nmap (lsp-definition)\n" +" nmap ] (lsp-peek-definition)\n" +" nmap (lsp-peek-definition)\n" +" nmap gr (lsp-references)\n" +" nmap (lsp-next-reference)\n" +" nmap (lsp-previous-reference)\n" +" nmap gI (lsp-implementation)\n" +" nmap go (lsp-document-symbol)\n" +" nmap gS (lsp-workspace-symbol)\n" +" nmap ga (lsp-code-action)\n" +" nmap gR (lsp-rename)\n" +" nmap gm (lsp-signature-help)\n" +"endfunction\n" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:173 +#, no-wrap +msgid "" +"augroup lsp_install\n" +" au!\n" +" autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled()\n" +"augroup END\n" +msgstr "" +"augroup lsp_install\n" +" au!\n" +" autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled()\n" +"augroup END\n" + +#. type: Title === +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:176 +#, no-wrap +msgid "VSCode" +msgstr "VSCode" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:183 +msgid "" +"LSP client plugins are required to launch the language server daemon. Press " +"`Ctrl+Shift+X` to show the extension online search panel. Enter `llvm-vs-" +"code-extensions.vscode-clangd` when running clangd, or `ccls-project.ccls` " +"when running ccls." +msgstr "" +"Plugins de cliente LSP são necessários para iniciar o daemon do servidor de " +"linguagem. Pressione `Ctrl+Shift+X` para exibir o painel de pesquisa de " +"extensões online. Digite `llvm-vs-code-extensions.vscode-clangd` quando " +"estiver usando o clangd, ou `ccls-project.ccls` quando estiver usando o ccls." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:187 +msgid "" +"Then, press `Ctrl+Shift+P` to show the editor commands palette. Enter " +"`Preferences: Open Settings (JSON)` into the palette and hit `Enter` to open " +"[.filepath]#settings.json#. Depending on the language server " +"implementations, put one of the following JSON key/value pairs in [." +"filepath]#settings.json#:" +msgstr "" +"Em seguida, pressione `Ctrl+Shift+P` para exibir a paleta de comandos do " +"editor. Digite `Preferences: Open Settings (JSON)` na paleta e pressione " +"`Enter` para abrir o [.filepath]#settings.json#. Dependendo das " +"implementações do servidor de linguagem, adicione um dos seguintes pares " +"chave/valor JSON em [.filepath]#settings.json#:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:201 +#, no-wrap +msgid "" +"[\n" +" /* Begin of your existing configurations */\n" +" ...\n" +" /* End of your existing configurations */\n" +" \"clangd.arguments\": [\n" +" \"--background-index\",\n" +" \"--header-insertion=never\"\n" +" ],\n" +" \"clangd.path\": \"clangd12\"\n" +"]\n" +msgstr "" +"[\n" +" /* Begin of your existing configurations */\n" +" ...\n" +" /* End of your existing configurations */\n" +" \"clangd.arguments\": [\n" +" \"--background-index\",\n" +" \"--header-insertion=never\"\n" +" ],\n" +" \"clangd.path\": \"clangd12\"\n" +"]\n" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:212 +#, no-wrap +msgid "" +"[\n" +" /* Begin of your existing configurations */\n" +" ...\n" +" /* End of your existing configurations */\n" +" \"ccls.cache.hierarchicalPath\": true\n" +"]\n" +msgstr "" +"[\n" +" /* Begin of your existing configurations */\n" +" ...\n" +" /* End of your existing configurations */\n" +" \"ccls.cache.hierarchicalPath\": true\n" +"]\n" + +#. type: Title == +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:215 +#, no-wrap +msgid "Compilation database" +msgstr "Banco de dados de compilação" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:221 +msgid "" +"A Compilation database contains an array of compile command objects. Each " +"object specifies a way of compiling a source file. The compilation database " +"file is usually [.filename]#compile_commands.json#. The database is used by " +"language server implementations for indexing purpose." +msgstr "" +"Um banco de dados de compilação contém um array de objetos de comando de " +"compilação. Cada objeto especifica uma maneira de compilar um arquivo de " +"origem. O arquivo de banco de dados de compilação geralmente é chamado de [." +"filename]#compile_commands.json#. O banco de dados é usado por " +"implementações de servidores de linguagem para fins de indexação." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:223 +msgid "" +"Please refer to link:https://clang.llvm.org/docs/JSONCompilationDatabase." +"html#format[] for details on the format of the compilation database file." +msgstr "" +"Por favor, consulte link:https://clang.llvm.org/docs/JSONCompilationDatabase." +"html#format[] para obter detalhes sobre o formato do arquivo do banco de " +"dados de compilação." + +#. type: Title === +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:225 +#, no-wrap +msgid "Generators" +msgstr "Geradores" + +#. type: Title ==== +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:228 +#, no-wrap +msgid "Using scan-build-py" +msgstr "Usando scan-build-py" + +#. type: Title ===== +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:230 +#, no-wrap +msgid "Installation" +msgstr "Instalação" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:234 +msgid "" +"`intercept-build` tool from scan-build-py is used to generate compilation " +"database." +msgstr "" +"A ferramenta `intercept-build` do scan-build-py é usada para gerar o banco " +"de dados de compilação." + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:237 +msgid "" +"Install package:devel/python[] to get python interpreter first. To get " +"`intercept-build` from LLVM:" +msgstr "" +"Primeiro instale o package:devel/python[] para obter o interpretador Python. " +"Para obter o `intercept-build` do LLVM:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:241 +#, no-wrap +msgid "# git clone https://github.com/llvm/llvm-project /path/to/llvm-project\n" +msgstr "" +"# git clone https://github.com/llvm/llvm-project /path/to/llvm-project\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:244 +msgid "" +"where [.filename]#/path/to/llvm-project/# is your desired path for the " +"repository. Make an alias in the shell configuration file for convenience:" +msgstr "" +"onde [.filename]#/path/to/llvm-project/# é o caminho desejado para o " +"repositório. Crie um alias no arquivo de configuração do shell para " +"conveniência:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:248 +#, no-wrap +msgid "alias intercept-build='/path/to/llvm-project/clang/tools/scan-build-py/bin/intercept-build'\n" +msgstr "" +"alias intercept-build='/path/to/llvm-project/clang/tools/scan-build-py/bin/" +"intercept-build'\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:254 +msgid "" +"link:https://github.com/rizsotto/scan-build[rizsotto/scan-build] can be used " +"instead of LLVM's scan-build-py. The LLVM's scan-build-py was rizsotto/scan-" +"build merged into the LLVM tree. This implementation can be installed by " +"`pip install --user scan-build`. The `intercept-build` script is in [." +"filename]#~/.local/bin# by default." +msgstr "" +"Você também pode usar o link:https://github.com/rizsotto/scan-build[rizsotto/" +"scan-build] em vez do scan-build-py do LLVM. O scan-build-py do LLVM foi " +"incorporado ao repositório do LLVM. Essa implementação pode ser instalada " +"com o comando `pip install --user scan-build`. O script `intercept-build` é " +"instalado por padrão em [.filename]#~/.local/bin#." + +#. type: Title ===== +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:255 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:271 +#, no-wrap +msgid "Usage" +msgstr "Uso" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:258 +msgid "" +"In the top-level directory of the FreeBSD src tree, generate the compilation " +"database with `intercept-build`:" +msgstr "" +"No diretório raiz da árvore src do FreeBSD, gere o banco de dados de " +"compilação com o `intercept-build`:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:262 +#, no-wrap +msgid "# intercept-build --append make buildworld buildkernel -j`sysctl -n hw.ncpu`\n" +msgstr "" +"# intercept-build --append make buildworld buildkernel -j`sysctl -n hw.ncpu`" +"\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:267 +msgid "" +"The `--append` flag tells the `intercept-build` to read an existing " +"compilation database (if a compilation database exists) and append the " +"results to the database. Entries with duplicated command keys are merged. " +"The generated compilation database by default is saved in the current " +"working directory as [.filename]#compile_commands.json#." +msgstr "" +"A opção `--append` instrui o `intercept-build` a ler um banco de dados de " +"compilação existente (se existir) e adicionar os resultados ao banco de " +"dados. As entradas com chaves de comando duplicadas são mescladas. O banco " +"de dados de compilação gerado por padrão é salvo no diretório de trabalho " +"atual como [.filename]#compile_commands.json#." + +#. type: Title ==== +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:269 +#, no-wrap +msgid "Using devel/bear" +msgstr "Usando o devel/bear" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:274 +msgid "" +"In the top-level directory of the FreeBSD src tree, to generate compilation " +"database with `bear`:" +msgstr "" +"No diretório raiz da árvore src do FreeBSD, para gerar o banco de dados de " +"compilação com o `bear`:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:278 +#, no-wrap +msgid "# bear --append -- make buildworld buildkernel -j`sysctl -n hw.ncpu`\n" +msgstr "# bear --append -- make buildworld buildkernel -j`sysctl -n hw.ncpu`\n" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:283 +msgid "" +"The `--append` flag tells `bear` to read an existing compilation database if " +"it is present, and append the results to the database. Entries with " +"duplicated command key are merged. The generated compilation database by " +"default is saved in the current working directory as [." +"filename]#compile_commands.json#." +msgstr "" +"A opção `--append` instrui o `bear` a ler um banco de dados de compilação " +"existente, se estiver presente, e adicionar os resultados ao banco de dados. " +"As entradas com chave de comando duplicada são mescladas. O banco de dados " +"de compilação gerado por padrão é salvo no diretório de trabalho atual como [" +".filename]#compile_commands.json#." + +#. type: Title == +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:285 +#, no-wrap +msgid "Final" +msgstr "Finalizando" + +#. type: Plain text +#: documentation/content/en/articles/freebsd-src-lsp/_index.adoc:289 +msgid "" +"Once the compilation database is generated, open any source files in the " +"FreeBSD src tree and LSP server daemon will be launched as well in " +"background. Opening source files in the src tree for the first time takes " +"significantly longer time before the LSP server is able to give a complete " +"result, due to initial background indexing by the LSP server compiling all " +"the listed entries in the compilation database. The language server daemon " +"however does not index the source files not appearing in the compilation " +"database, thus no complete results are shown on source files not being " +"compiled during the `make`." +msgstr "" +"Depois que o banco de dados de compilação for gerado, abra qualquer arquivo " +"de código fonte na árvore src do FreeBSD e o daemon do servidor LSP será " +"lançado em segundo plano. Abrir arquivos de código fonte na árvore src pela " +"primeira vez leva significativamente mais tempo antes que o servidor LSP " +"seja capaz de fornecer um resultado completo, devido à indexação de segundo " +"plano inicial pelo servidor LSP compilando todas as entradas listadas no " +"banco de dados de compilação. No entanto, o daemon do servidor de linguagem " +"não indexa os arquivos de origem que não aparecem no banco de dados de " *** 11 LINES SKIPPED *** From nobody Tue May 9 16:26:12 2023 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 4QG3SN7006z4BNP7 for ; Tue, 9 May 2023 16:26:12 +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 4QG3SN4fVkz41hS; Tue, 9 May 2023 16:26:12 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683649572; 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=YxQkJmowU7L7PtHodFRogYfkcm4uUA46L+5GKccfzMw=; b=AnPeRCyftDj5seGzry3QAI9M+BCv77vChR/SzugAHSVNHtjx+Hlzn6n8ew/GFxwTnTiAQG Uld34Zq4+Qh9tas+nRnxhTFUtbv41yPD8SDyQGBBHrwwsvFR2UGY5Sk8IrsBxaDgkxF2gh yU3FkjL0gy4rtAXquu58m2DeXrxNvP/Xez8IapYzKBRvf6EZraUAQW1DkRRSI8v6hjICS5 WpPAHyOal9yJKTidsr1EO38LuDmxDaQGVqh9yZnshZAH2wjwW8s3VsmEMGveiuf9fiDSuI v06cgazQ7qtxsHkmQXhK8jOHFeBIqTuf2Ouptx9TGUoDikmyZf06UIlP0Jh8pg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683649572; 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=YxQkJmowU7L7PtHodFRogYfkcm4uUA46L+5GKccfzMw=; b=DCxGrRNYbBh6ESl8SxepYSuJ3EkrNOIkGDT77JvtEoRuRlvQp1CqVWAabhE5gAz46NHle2 LdIbx//WqHEqCs+eh2gGl/4+PpZyQvlxG5OQ/7XiTHnUqgh06WXfts9W8r4O3tE6W9ytQX j3MirPkGU1fsSE4eV9w24WVYdJ6lN4jzLXq/CvG61Bo2Zsg7uwZturACcrqqsHwpaXTxA2 Sbz9g2Rn7j1PHWmI/elfVdr5Y114UK2FOdtdwKcusS/CRNGdAbQVDDi7XY+8/4FWXX6YPd Usf+I6F6AsbUW8cHXjcPFtqZ+lWnv8s5hKsNADrXKM7lRls5PwjvD2Om/XpcLw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683649572; a=rsa-sha256; cv=none; b=Tr8uf8g/6aph0YASe+frWd1F3S/0JzeF9cWiy1cIVLyvzqR1IUpPgGpIgKRobzEKAiF5I7 ulCMZDDBbZ8fmip1pSVxOP/6PonZ2jIfEJ79saJ3C+6r6C8LbPWlrTsHOZ7+A0cC0HIp8M exjujnW8cSVW6FhPxXO7Fq1xNtU1wE4GljzjCO6pP2S+IRqhK1TgPyJICNNxaO2pcBCglj PzjMWegHvrSRg2N9aWwC9MB4A0R06OiM7khlxUZixIQXx3wNS4HQcWtPJyOUPqEQOlWnXO brX8DEZpSNKcFWRbdsE/oocmjlRRx631ROzDAMSEHmUVdwUxYh5Ewhqbe+tg3g== 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 4QG3SN3jDkzZf5; Tue, 9 May 2023 16:26:12 +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 349GQCCS014025; Tue, 9 May 2023 16:26:12 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 349GQCil014024; Tue, 9 May 2023 16:26:12 GMT (envelope-from git) Date: Tue, 9 May 2023 16:26:12 GMT Message-Id: <202305091626.349GQCil014024@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Li-Wen Hsu Subject: git: 29814ab2ae - main - hubs: Fix a typo 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: lwhsu X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 29814ab2ae518d3ba28b9fabe09ec6b0fbd48577 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by lwhsu: URL: https://cgit.FreeBSD.org/doc/commit/?id=29814ab2ae518d3ba28b9fabe09ec6b0fbd48577 commit 29814ab2ae518d3ba28b9fabe09ec6b0fbd48577 Author: Pierre Pronchery AuthorDate: 2023-05-09 16:06:56 +0000 Commit: Li-Wen Hsu CommitDate: 2023-05-09 16:25:32 +0000 hubs: Fix a typo Sponsored by: The FreeBSD Foundation --- documentation/content/en/articles/hubs/_index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/en/articles/hubs/_index.adoc b/documentation/content/en/articles/hubs/_index.adoc index 9c5bf2506e..4c94d70486 100644 --- a/documentation/content/en/articles/hubs/_index.adoc +++ b/documentation/content/en/articles/hubs/_index.adoc @@ -333,7 +333,7 @@ This means: ==== [[mirror-where-official]] -==== I am an Official Mirror, What is the Right Rite for Me? +==== I am an Official Mirror, What is the Right Site for Me? In general the description in <> still applies. Of course you may want to put some weight on the fact that your upstream should be of a low tier. From nobody Wed May 10 07:47:41 2023 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 4QGRvd4ckkz49Vst for ; Wed, 10 May 2023 07:47:41 +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 4QGRvd46Ndz4M3m; Wed, 10 May 2023 07:47:41 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683704861; 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=3ngY+NJQsS31EBYSBV40BhUBUMpfSnRvBUxgTqktxGg=; b=XykCQIIggJoXfMSICwUaeOYds1so7hecDp3VRJ7L7d2w0jINFSzTIcQa9vporf0brZakEg 8dixarsQLqLD9y1AyXoPspRnixlR0BOSisu6DwzlAjevE1PDgmcZg+6TYvwFYeE3bwLUiA gx5ue1t10u/UErRfdhqQAyihNTmB5+E+/JSNPSqta56K3SfBe4s7FYP1h/Y4P6LgT5K5E6 2nW7K23i/id1GVF7QrfOqxsIE/dwGnTRhWkpjyseuNjxcx6p7ig2gpHkd/0+GpNAH1btFM OeJDOivA1pNBXUhh4xMbTSwnTvqkRqB6fmlyIvf+2uyo/Ktuzo6VOQqwZ0XbfQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683704861; 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=3ngY+NJQsS31EBYSBV40BhUBUMpfSnRvBUxgTqktxGg=; b=x07npnK5A6ylOxvUk0PHTg3EGTkUvJOvXevp4BN8J9nn/fP19A8AMbeDhuq6y+Oi6sidrz k/y88zyiT2uSailXiSuFBDt6BnEn+GPW2Mgj6cKgb6JPfQ7RQstWXnhZ3ktAAdpbo/TRB3 XWAJB7dxIs+w50AiMRT7sfJvYxyZ8wk2z/AeBgyZasksrDHf+L8i3nq02jHuODeTabprJC y3vZ6DUUKdbjQS8vIqV6yPOw2bKQ2CCjgBrxjyJWs2vaGqg3J+PYUbQdodVvDqbSs1JvYy aHcmMyzfie0l+jWBfI7qSKwVbO+7AlkrdTiiu2eXQAFo8clVBf7ciTDhJvfK+g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683704861; a=rsa-sha256; cv=none; b=LayhOOUL0RIv61IT1JmreeCxeYnkYAj2ZBbAD0Mhs3lWFYQEm46BfYd8XHRp/qpMsmxoCS jlh+gKADhtb0iEy5P+wRNuk6Lbac/DIvCrekkd+BYv0GOOCuvIpVxrQ5Sw4ve+qzwle52L 1+WL2iUwQ2LbZpU1qt6/O2zK5xemjkRmNCz1ZwQCmXCo1KSACbb5/35EAqtv6u3DBnEp8e 7g/InshzVsU69NEiwF68ztpmtgiCos1YxT/yGslS5szA3VV2UBRytEccDcFD3kC2B2FwH+ sLidqzfCWdnRdpNd7i57x3iO1pnY2kir0Z7e9+/4u2dDVePV00nNPSVM6gNBNA== 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 4QGRvd39q4z126l; Wed, 10 May 2023 07:47:41 +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 34A7lfhW028953; Wed, 10 May 2023 07:47:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34A7lfbH028952; Wed, 10 May 2023 07:47:41 GMT (envelope-from git) Date: Wed, 10 May 2023 07:47:41 GMT Message-Id: <202305100747.34A7lfbH028952@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Muhammad Moinur Rahman Subject: git: cd44a8a530 - main - vale: Add new rule to reduce usage of pronouns 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bofh X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: cd44a8a530f3e3c26a197337d4181f1ed9c3d635 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bofh: URL: https://cgit.FreeBSD.org/doc/commit/?id=cd44a8a530f3e3c26a197337d4181f1ed9c3d635 commit cd44a8a530f3e3c26a197337d4181f1ed9c3d635 Author: Muhammad Moinur Rahman AuthorDate: 2023-05-10 07:46:15 +0000 Commit: Muhammad Moinur Rahman CommitDate: 2023-05-10 07:47:29 +0000 vale: Add new rule to reduce usage of pronouns Add various pronouns and their sub derivatives which are widely used in our websites and documentation specially the usage of you. Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D40029 --- .vale.ini | 1 + .vale/styles/FreeBSD/Pronouns.yml | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/.vale.ini b/.vale.ini index 60ce75b98d..2ce1390bf8 100644 --- a/.vale.ini +++ b/.vale.ini @@ -20,6 +20,7 @@ FreeBSD.ConsciousLanguage = NO FreeBSD.Contractions = NO FreeBSD.Hang = NO FreeBSD.Hyphens = NO +FreeBSD.Pronouns = NO FreeBSD.SuperfluousOptArgInLinks = NO FreeBSD.SemanticLineBreak = NO FreeBSD.Spacing = NO diff --git a/.vale/styles/FreeBSD/Pronouns.yml b/.vale/styles/FreeBSD/Pronouns.yml new file mode 100644 index 0000000000..15d8352874 --- /dev/null +++ b/.vale/styles/FreeBSD/Pronouns.yml @@ -0,0 +1,24 @@ +--- +extends: existence +message: "Avoid pronouns such as '%s'." +ignorecase: true +level: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b + - he/she + - s/he + - \(s\)he + - we + - we'(?:ve|re) + - ours? + - us + - let's + - you + - yours? + - you'(?:ve|re) From nobody Thu May 11 12:00:29 2023 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 4QH9Ss5QQcz4B8QQ for ; Thu, 11 May 2023 12:00:29 +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 4QH9Ss4pDjz43YB; Thu, 11 May 2023 12:00:29 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683806429; 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=bBKP/0p1b5SabpW6rAfLl5SkEeiMRinA8mcLqe2Vj4M=; b=btTtc/2ORtxWm6PiQtmCJ7u6ZasVmIixtoedOxIiNfQjeBJC1aUIqR2U9QDN25M27XAQ2s 3aeZw2AEAS1ysATybhcV9a7Rtr8NBryHf9bq9OFqqJlUdLSNvX+/QsVTCEv+l/mypn7LFJ dcFMr4mHM8JeFX4xWeDqGq2qwuSqbq3tsvl4qAoAXdHohvycKH4hea7hU3Z+axi91FKsZW nl8lxnclA6iOhMjO9tS+TMF+zfFr904JY5HfIKyufBkDp3AkzX6HO6UlQ8OUgoBkoxghN4 EWTjQ+IjPFgnDgtZyGONrwfWgBrIZYYVz4boWZ041I40p2Zbs+bi+XOZlSYIug== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683806429; 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=bBKP/0p1b5SabpW6rAfLl5SkEeiMRinA8mcLqe2Vj4M=; b=H+HvKBEytYEgvCheoEpvdryPDNBldrNDgav2EqeZhSpAaJxM22JzVrV4IlFsjI2h5WEOrM d2VuLIsgVpEzMmHDUj2NuUaYSn1CBNwl9Ct6XcOHvj3V8QO8hj6/a0MiWcuLrGwUFZy2dO mPSQLPe8stNhyxLCV1q37juTg06jX55B0gI1zJfMF0t78TqRNCi6fdp30OF2s23fX+cK9o a3uTSFMJAngC+1EL+rDt1Ok9J8OHI2abEb+rqJ+7ehdMrrbsFCnxbi+r1YMqZ1LyLXQAAX KqPIM46621s3DKPcnxhRQus6T/mmAUmv+OYLvktBEYsHzMVPDbt+l6QDlxIqMg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683806429; a=rsa-sha256; cv=none; b=eCXNMEJPCoWn/hFb2PDKUvWpAj63YvVxQ71bplej9dSYejV3WmbzaeKtXIXWdg6dyuUL9M vthiQjZlpv0K445dYCoijagdLQ0F7kHX7sz5pkXuG0Vyb2wqTaBridjaz+1QeAtKNv8GCB j2hcVbZ9BPXgLEu5MpppGiywAPPMliPNc/A4A7vJ3etG4EeiVlvIuXSGxTIHLvzpMs/Led OUh3ztUYAnbHchPebWdMqyfELR0Jm8ns4Ko1CKF6yb/YTajFL1Ke6EgYvonD6P7WehkfUP F3O+WqZqcJach1FG98F5h6cjBmIlPl3iIcj8uwPTUFWtd1UEBb72Mu4ak8vvQA== 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 4QH9Ss3jfXzrtJ; Thu, 11 May 2023 12:00:29 +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 34BC0TM3022205; Thu, 11 May 2023 12:00:29 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34BC0TtS022204; Thu, 11 May 2023 12:00:29 GMT (envelope-from git) Date: Thu, 11 May 2023 12:00:29 GMT Message-Id: <202305111200.34BC0TtS022204@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Lorenzo Salvadore Subject: git: db5022b3cf - main - fdp-primer/editor-config: Correct typo 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: salvadore X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: db5022b3cfe9bd2c37c06e95d45e60854dcca9ea Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by salvadore: URL: https://cgit.FreeBSD.org/doc/commit/?id=db5022b3cfe9bd2c37c06e95d45e60854dcca9ea commit db5022b3cfe9bd2c37c06e95d45e60854dcca9ea Author: Lorenzo Salvadore AuthorDate: 2023-05-11 11:54:33 +0000 Commit: Lorenzo Salvadore CommitDate: 2023-05-11 12:00:05 +0000 fdp-primer/editor-config: Correct typo Remove an extra `+` that prevented an unsorted list from being rendered correctly. Approved by: doceng (blanket) --- documentation/content/en/books/fdp-primer/editor-config/_index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc index 3ca2679198..b0378594b0 100644 --- a/documentation/content/en/books/fdp-primer/editor-config/_index.adoc +++ b/documentation/content/en/books/fdp-primer/editor-config/_index.adoc @@ -59,7 +59,7 @@ More advanced users can use a proper linter like link:https://github.com/dense-a === Use Manual page writers can use the following keyboard shortcuts to reformat: -+ + * Press kbd:[P] to reformat paragraphs or text that has been selected in Visual mode. * Press kbd:[T] to replace groups of eight spaces with a tab. From nobody Thu May 11 14:09:56 2023 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 4QHDLD6RDsz4BHVj for ; Thu, 11 May 2023 14:09:56 +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 4QHDLD5ml0z4MpR; Thu, 11 May 2023 14:09:56 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683814196; 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=+++3BLmsmRPtppQzZlnBIjj5t1v5ccQhcle6Grg2RUE=; b=vl3NBS7H3iPmQmwYr4yVT0BrvuLlAI1CMPMyEAPNOOs7SKHFJaCHUA4qGwaGdoeHCS7yTw rvRsqmEEIWIh9otaeRDOy49Pg1fgpQw1K2hBXHsuW0ISUxDsKrUAw4h79zRuJtoR7D8Sgd 4mogVGF3gnk1TYih5WKJO3z4UP8BTMfAHqfoe9+8dKcu/qQOf2pOnFbSH9kNVGFcohX1Qp j+aiE4Y2+hFaWJnaxNnkPeAO4qUD70jUmMD59XSrtMItCbHKlXcvnKDCfL0Ntt+KpP4xxw BnGN57/+qXPY3qKFa+o2ELIr06vV1exL0lQoGojOe1Sm9i630ICgxpoBLl2ZLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683814196; 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=+++3BLmsmRPtppQzZlnBIjj5t1v5ccQhcle6Grg2RUE=; b=Ydzv8W73pvVULrbS51+/5Bti1uj1g08khpn1oDjMfiF7NsWqxNNNrzK0jBobMmxKPJZTEJ 8/8jAa4nGvML3LrcTdbXsnC+77PlvG4Ag2nbnQKVkGcrp7lG1gQd7kcnotPO16TwamOiRi M0JowM40+0qF79AgQyDQEWpgVrrg8SycCQ0WOSsnhPQ/JLqv9vmpQdUZaLbpbXBMI2JYcF odS57SMLbx+Gx6DQ0cHhzgherlCgWC70HSxdHfYT1ECQ2U3ROtzQV+8oETiz9yZjA9BC13 dRELOx67kquZ8DvoR04MwG8mu1w3Ydk3KUJKX9DaQBQrtmfGhGBbozssKMQfdA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683814196; a=rsa-sha256; cv=none; b=YpJzxA7C1aN9hPYBHQRSGkaifwX3J3aORCRJjCUcYn/8OBgB8OCjMPXjLi4ZkThc3fIu7I hfo0Am41NEkRbIJhkXsAqh/JTixd5SL65DJz5yNIYqCVGPohfEmWS9Kuzjuz/8Ba7+Y6sh dqRzZWjFWY++Ik5P/LWF+2/XNqT6PPh4bgzhh81y18Aby7LCRmE5DYew6q6HSDb6t2Amwt 8LywP9OAvMxu/PHepejAhRh9hW2BkMFKppknac/zCJ3IegH2sGDR5gt7WRQBod6zHuf8Ie XjLaKrgOYfbwzFh7GjAzLL0DMY8r0GUHeZbpQaMMAq6j1yxTnU8tg6ibxsni2Q== 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 4QHDLD4kNqzvtb; Thu, 11 May 2023 14:09:56 +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 34BE9ukN027846; Thu, 11 May 2023 14:09:56 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34BE9uYV027845; Thu, 11 May 2023 14:09:56 GMT (envelope-from git) Date: Thu, 11 May 2023 14:09:56 GMT Message-Id: <202305111409.34BE9uYV027845@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Muhammad Moinur Rahman Subject: git: 6729b16b7b - main - vale/styles: Remove Weasel rule 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bofh X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 6729b16b7ba504e7ae967333153472632d9b2c1c Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bofh: URL: https://cgit.FreeBSD.org/doc/commit/?id=6729b16b7ba504e7ae967333153472632d9b2c1c commit 6729b16b7ba504e7ae967333153472632d9b2c1c Author: Muhammad Moinur Rahman AuthorDate: 2023-05-11 14:07:49 +0000 Commit: Muhammad Moinur Rahman CommitDate: 2023-05-11 14:09:44 +0000 vale/styles: Remove Weasel rule After some careful consideration and thoughts the Weasel rule is being removed because currently there are 18805 suggestions which will be really time consuming to fix as rewording the sentences from weasel words are a bit complicated. Approved by: bcr (mentor) Differential Revision: https://reviews.freebsd.org/D40063 --- .vale.ini | 1 - .vale/styles/FreeBSD/Weasel.yml | 206 --------------------- .../en/books/fdp-primer/writing-style/_index.adoc | 7 - 3 files changed, 214 deletions(-) diff --git a/.vale.ini b/.vale.ini index 2ce1390bf8..e7657b17a3 100644 --- a/.vale.ini +++ b/.vale.ini @@ -24,7 +24,6 @@ FreeBSD.Pronouns = NO FreeBSD.SuperfluousOptArgInLinks = NO FreeBSD.SemanticLineBreak = NO FreeBSD.Spacing = NO -FreeBSD.Weasel = NO Vale.Avoid= NO Vale.Repetition = NO Vale.Spelling = NO diff --git a/.vale/styles/FreeBSD/Weasel.yml b/.vale/styles/FreeBSD/Weasel.yml deleted file mode 100644 index 12b74d76ef..0000000000 --- a/.vale/styles/FreeBSD/Weasel.yml +++ /dev/null @@ -1,206 +0,0 @@ ---- -extends: existence -message: "'%s' is a weasel word!" -ignorecase: true -level: suggestion -tokens: - - absolutely - - accidentally - - additionally - - allegedly - - alternatively - - angrily - - anxiously - - approximately - - awkwardly - - badly - - barely - - beautifully - - blindly - - boldly - - bravely - - brightly - - briskly - - bristly - - bubbly - - busily - - calmly - - carefully - - carelessly - - cautiously - - cheerfully - - clearly - - closely - - coldly - - completely - - consequently - - correctly - - courageously - - crinkly - - cruelly - - crumbly - - cuddly - - currently - - daily - - daringly - - deadly - - definitely - - deliberately - - doubtfully - - dumbly - - eagerly - - early - - easily - - elegantly - - enormously - - enthusiastically - - equally - - especially - - eventually - - exactly - - exceedingly - - exclusively - - extremely - - fairly - - faithfully - - fatally - - fiercely - - finally - - fondly - - few - - foolishly - - fortunately - - frankly - - frantically - - generously - - gently - - giggly - - gladly - - gracefully - - greedily - - happily - - hardly - - hastily - - healthily - - heartily - - helpfully - - honestly - - hourly - - hungrily - - hurriedly - - immediately - - impatiently - - inadequately - - ingeniously - - innocently - - inquisitively - - interestingly - - irritably - - jiggly - - joyously - - justly - - kindly - - largely - - lately - - lazily - - likely - - literally - - lonely - - loosely - - loudly - - loudly - - luckily - - madly - - many - - mentally - - mildly - - mortally - - mostly - - mysteriously - - neatly - - nervously - - nightly - - noisily - - normally - - obediently - - occasionally - - only - - openly - - painfully - - particularly - - patiently - - perfectly - - politely - - poorly - - powerfully - - presumably - - previously - - promptly - - punctually - - quickly - - quietly - - rapidly - - rarely - - really - - recently - - recklessly - - regularly - - remarkably - - relatively - - reluctantly - - repeatedly - - rightfully - - roughly - - rudely - - sadly - - safely - - selfishly - - sensibly - - seriously - - sharply - - shortly - - shyly - - significantly - - silently - - simply - - sleepily - - slowly - - smartly - - smelly - - smoothly - - softly - - solemnly - - sparkly - - speedily - - stealthily - - sternly - - stupidly - - substantially - - successfully - - suddenly - - surprisingly - - suspiciously - - swiftly - - tenderly - - tensely - - thoughtfully - - tightly - - timely - - truthfully - - unexpectedly - - unfortunately - - usually - - very - - victoriously - - violently - - vivaciously - - warmly - - waverly - - weakly - - wearily - - weekly - - wildly - - wisely - - worldly - - wrinkly - - yearly diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index 8d0161fb81..935025d090 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -287,9 +287,6 @@ The following table describes the current rule names and their respective severi | FreeBSD.SuperfluousOptArgInLinks | suggestion -| FreeBSD.Weasel -| warning - | Vale.Avoid | error @@ -328,10 +325,6 @@ This rule proposes better wording. . FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL. -. FreeBSD.Weasel: This rule is aimed at avoiding weasel words. -The concept of weasel words is controversial so at the moment the list of words are being evaluated and the severity level is marked as warning only. -If a frequently used word is marked as a weasel word it should be removed from [.filename]#.vale/styles/FreeBSD/Weasel.yml# in the `doc` repository. - . Vale.Avoid: Enforces the *DO NOT USE* vocabulary terms for The FreeBSD Project. If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository. The list is empty at the moment. From nobody Thu May 11 20:26:58 2023 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 4QHNjG2pPqz49ytT for ; Thu, 11 May 2023 20:26:58 +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 4QHNjG2Fkrz3vNs; Thu, 11 May 2023 20:26:58 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683836818; 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=Pu5rn0Lj3GPaFOEpQYl2FJqDZ7wbyRF6DrbdoAWbpOs=; b=KFmX4wZkLpXwlYbhWhUV5LDEQyMCCQ3SHLmYkvc5TJc13E33eCX1w9X8mMfJDM+MeghFyu P/aL6hoxYRCF5qt/hOMBQZMklSyQhiSj/42DjOZaW5zHGQ79ckRZEiCqJmbuVqW0Cipg67 HUqM6NwvzknjoZfumD0EsDWky2rQk8V95FBdC47/Uuby8LU5LKL89IE6eR1pJqg+yeoL7k 7r4LZuTyX+eroaQ9n3shP9as3pZrr/Rcfc5Yl9e5SFYSnHjYC42SEntP/u8Vyv/6g3CWhG A0tAka8L9fmaug9cVUlD+nurdGZcOSry2MaAJEjF2nevZUz9cop7hPo2JaffRQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683836818; 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=Pu5rn0Lj3GPaFOEpQYl2FJqDZ7wbyRF6DrbdoAWbpOs=; b=QMBRet5368F6GWILimldqy0pYqPv7nNMTWw+jtEC2gC3yO7+4bY51gC03LNktVu7NEsQ/y 8ZmpqiAeaqbWQlPKdx6I2q09nyHNgJ3vVmTfdMf+m/Q8uFbm5BojFs6F7NznWtsalBPXcO oNzNSdmVM70KJ1r4vrcM/m2qF1URcnR28GirrR3Wv8eGxH3VdcV9NOZ8JcS/DeZ1YfWmEE 2wRWzwSjIX/PCk8itLafyeSEehsjttsd+a26VvDWYaeAtMxFcug2Efg69PtW9pr2oWPB2K B//lbEJ4n7663l608DVtYrQiY82aAhhxYXsU5duwmG0yr0cQOqI9NJvRViPQFw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683836818; a=rsa-sha256; cv=none; b=jWnNqM20/T97/QJnv0IQNPXIJZAqI8c8kTVf/0+NQ1t6oRCIkQRNC5OfrOg514JdWlaaLe V5pJ7kfMOMSuBjydeU+yX7qSqJ7MBl5CVqE/xiKR4B+8LhaTNPu+S1J8qGRV9JnlG8rYyM M4Q9my2HfSsmp7DS7LBVEgzD4/pfCN8uJconQY3dp5fRLog8GFfdZZyC4M/LkmUYGvNYEt 2YmJ32BeP8+j2Mrt/FJWNZ05Ra/ySRwJGs3BhSTtyofxg8qrUaJ9HiH6kQ4s3wQMr/QjST 9pxRhfI7IiHfQsvrACOKMkDy0Rz+2BuS5YdroBAsj5kzvJlkW6GESyuQJrgY0A== 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 4QHNjG1JJ2z16Js; Thu, 11 May 2023 20:26:58 +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 34BKQwwb052464; Thu, 11 May 2023 20:26:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34BKQwGk052463; Thu, 11 May 2023 20:26:58 GMT (envelope-from git) Date: Thu, 11 May 2023 20:26:58 GMT Message-Id: <202305112026.34BKQwGk052463@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ceri Davies Subject: git: 41a7d1606e - main - fdp-primer/writing-style: redo some parts of rev 2f4edf696b 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ceri X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 41a7d1606e49829d12e1ddcfe5c17401db06d7e6 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by ceri: URL: https://cgit.FreeBSD.org/doc/commit/?id=41a7d1606e49829d12e1ddcfe5c17401db06d7e6 commit 41a7d1606e49829d12e1ddcfe5c17401db06d7e6 Author: Ceri Davies AuthorDate: 2023-05-11 20:24:20 +0000 Commit: Ceri Davies CommitDate: 2023-05-11 20:24:20 +0000 fdp-primer/writing-style: redo some parts of rev 2f4edf696b --- .../content/en/books/fdp-primer/writing-style/_index.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc index 935025d090..fe9d704a8b 100644 --- a/documentation/content/en/books/fdp-primer/writing-style/_index.adoc +++ b/documentation/content/en/books/fdp-primer/writing-style/_index.adoc @@ -309,7 +309,7 @@ Similarly, every major vendor and company has specific rules on writing their br Care should be taken to be respectful to the brand value of others and to take time to write PostgreSQL, Node.js, Let's Encrypt etc. Missing brand names should be added to the [.filename]#.vale/styles/FreeBSD/BrandTerms.yml# in the `doc` repository. -. FreeBSD.ConsciousLanguage: This rule proposes use of conscious languages so that sensitive words pointing to the color, age, race, sexual orientation of people are avoided where possible. +. FreeBSD.ConsciousLanguage: This rule proposes use of conscious language so that sensitive words pointing to the color, age, race, or sexual orientation of people are avoided where possible. . FreeBSD.Contractions: Contracted words should not be used. This rule avoids all contractions and suggests full words. @@ -326,14 +326,14 @@ This rule proposes better wording. . FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL. . Vale.Avoid: Enforces the *DO NOT USE* vocabulary terms for The FreeBSD Project. -If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository. +If any word is found that should not be in the documentation, the word should be added to [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository. The list is empty at the moment. . Vale.Repetition: Same words are often typed twice when leaving the keyboard and rejoining the work again. This rule finds repeated words and warns the users. -. Vale.Spelling: At the moment there is a mix of en_US and en_UK spellings in the documentation and website. -Vale comes with an in built dictionary from which uses strictly en_US and do not accept the en_UK variant of any words. +. Vale.Spelling: At the moment there is a mix of en_US and en_GB spellings in the documentation and website. +Vale comes with an in built dictionary from which uses strictly en_US and do not accept the en_GB variant of any words. . Vale.Terms: Enforces the *PREFERRED* vocabulary terms for The FreeBSD Project. At the moment the list of terms is empty and the FreeBSD specific terms will be added gradually. From nobody Thu May 11 20:55:06 2023 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 4QHPKl1f5fz4B1Mk for ; Thu, 11 May 2023 20:55:07 +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 4QHPKl1DjTz424c; Thu, 11 May 2023 20:55:07 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683838507; 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=X4sBMqwbshL+6RDldmOzHVn2nIzNTb1Ntr+YkFblshg=; b=cMd6VLsUfA3QrQaiGyawgVvlfCngDHVdqr32W0O3+llu37lVZeyUteGHDyIx1XbAEhgry7 j1Bg6EzQEnQb9ADn/EjFJJVSRvJb+MtArYzgIuollEQCxLaAk+DfEQvUTrAsRp83nV4YCk KswvhJprZ7k4Ixs/SddxgLG+IOxHnag0Dg6SsI1J/Tjlh3VqLeNGWfYy0eyp8ppIDKWnyf naCsYHvBzD9aZF6HouEVg6uB6nW8722IDmDh/OZkZActL0+wMaQtsmIMyq1ojprAbuETSS h2d82aH/9otPTxY3A0HNrxo27ekH8YbEdxcyXmIcLiHofshiXb5zPPWGWfvokA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683838507; 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=X4sBMqwbshL+6RDldmOzHVn2nIzNTb1Ntr+YkFblshg=; b=EQy3xZeQZN+aBopCYzBFqZlqFDM9BSt3kBHCyh8jt9ibZyrL5erQv+IqgD8sAheRZHZm0w t1ZukKivSDyZYrPQST9a2d3Ea+5jIHoh1Hy2B5vOfIuHA2iikY++iWs9UoT2DIrCll+jfP WHrqb14+tkKgk6jSDjsOdbBKpEADVycmDm4PL5S7fqQ19J/MD1gKI8sfLHHeaWAj4bwce0 2zbeBCcrygDj7iylfeXwWukEi6YnsqxNMe0REX55OSY8a7XXJPprcY7h6Z6WDdbC/syTKu XEKRdUSeVP4fE0Gmm9sgi1tbLpvtw7z1r2pJLQBGHfNCATRhfL1m9Zhb6R3xtQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683838507; a=rsa-sha256; cv=none; b=jC4EmcECjIrOS8ogLhUE3DlngA+o032KVLra+2bq5uH8Po455uMKo+5U46JDw8MU+HlTYO ba4ApS7fio4a5gZj8fwQR0GPA3+SHy+2SHteP/9H17F5SlnSlLNMI7dzmcnuOPjb5e9CPL fJ8TP9qTH3tKDgLuCKiLBIdIaBBsKV3QE4J/smi2Wdr63YvtStSFdn6TTfjIb2C+k5FQf7 6b6sRv9Df8L1v24Q84qiD2xW74Ouf4O7bRNS5gom3aeaPr4aJkGlS/K6c8Vhxr+6q4iFM3 maR259G3gwHn1cnWo8v+69kTBVfeio6cpTIp5x603P/KKbgRhvHSELJu4WzsUg== 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 4QHPKl0Cjlz16rC; Thu, 11 May 2023 20:55:07 +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 34BKt696000855; Thu, 11 May 2023 20:55:06 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34BKt6Im000854; Thu, 11 May 2023 20:55:06 GMT (envelope-from git) Date: Thu, 11 May 2023 20:55:06 GMT Message-Id: <202305112055.34BKt6Im000854@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Ceri Davies Subject: git: 6ff9b4b44b - main - handbook/linuxemu: minor improvements to grammar, etc. 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ceri X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 6ff9b4b44b48bae15da7fdfb0bfd3fcbe59cb8f3 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by ceri: URL: https://cgit.FreeBSD.org/doc/commit/?id=6ff9b4b44b48bae15da7fdfb0bfd3fcbe59cb8f3 commit 6ff9b4b44b48bae15da7fdfb0bfd3fcbe59cb8f3 Author: Ceri Davies AuthorDate: 2023-05-11 20:48:45 +0000 Commit: Ceri Davies CommitDate: 2023-05-11 20:48:45 +0000 handbook/linuxemu: minor improvements to grammar, etc. --- .../content/en/books/handbook/linuxemu/_index.adoc | 36 +++++++++------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/documentation/content/en/books/handbook/linuxemu/_index.adoc b/documentation/content/en/books/handbook/linuxemu/_index.adoc index 79892d7cfa..0f21401e8d 100644 --- a/documentation/content/en/books/handbook/linuxemu/_index.adoc +++ b/documentation/content/en/books/handbook/linuxemu/_index.adoc @@ -78,7 +78,7 @@ To enable the Linux ABI at boot time, execute the following command: # sysrc linux_enable="YES" .... -Once enabled, it can be started without rebooting executing the following command: +Once configured, it can be enabled without rebooting by executing the following command: [source,shell] .... @@ -88,7 +88,7 @@ Once enabled, it can be started without rebooting executing the following comman This is enough for statically linked Linux binaries to work. The Linux service will load necessary kernel modules and mount filesystems expected by Linux applications under [.filename]#/compat/linux#. -They can be started in the same way native FreeBSD binaries can; they behave almost exactly like native processes and can be traced and debugged the usual way. +Linux binaries can then be started in the same way that native FreeBSD binaries can; they behave almost exactly like native processes and can be traced and debugged the usual way. The current content of [.filename]#/compat/linux# can be checked executing the following command: @@ -110,12 +110,12 @@ dr-xr-xr-x 1 root wheel 0 Apr 11 21:03 sys [[linux-userlands]] == Linux userlands -Linux software requires more than just an ABI to work. -In order to run Linux software a Linux userland must be installed first. +Most Linux software requires more than just an ABI to work, depending perhaps on common libraries. +In order to run such Linux software, a Linux userland must be installed first. [TIP] ==== -If all that is wanted is to run some software already included in the Ports tree, it can be installed via package manager and man:pkg[8] will automatically setup the required Linux userland. +If all that is wanted is to run some software already included in the Ports tree, it can be installed via the man:pkg[8] package manager which will automatically setup the required Linux userland. For example, to install Sublime Text 4, along with all the Linux libraries it depends on, run this command: @@ -177,7 +177,7 @@ To install debootstrap execute the following command: # pkg install debootstrap .... -man:debootstrap[8] needs man:linux[4] ABI enabled. +man:debootstrap[8] needs man:linux[4] ABI support to be enabled as per the instructions above. Once enabled, execute the following command to install Ubuntu or Debian in [.filename]#/compat/ubuntu#: [source,shell] @@ -216,7 +216,7 @@ Then set up mounts in [.filename]#/etc/fstab#. [TIP] ==== -If the contents of the home directory should be shared and to be able to run X11 applications, [.filename]#/home# and [.filename]#/tmp# should be mounted in the linux compat area using man:nullfs[5] for loopback. +If the contents of the home directory should be shared, or to be able to run X11 applications, [.filename]#/home# and [.filename]#/tmp# should be mounted in the linux compat area using man:nullfs[5] for loopback. The following example can be added to [.filename]#/etc/fstab#: @@ -261,7 +261,7 @@ The output should be similar to the following: Linux 3.17.0 x86_64 .... -Once inside the chroot, the system behaves as in a normal Ubuntu installation +Once inside the chroot, the system behaves as per a normal Ubuntu installation. While systemd doesn't work, the man:service[8] command works as usual. [TIP] @@ -357,8 +357,8 @@ This example will result in the following files on the FreeBSD system: .... If a Linux shared library already exists with a matching major revision number to the first column of the `ldd` output, it does not need to be copied to the file named in the last column, as the existing library should work. -It is advisable to copy the shared library if it is a newer version, though. -The old one can be removed, as long as the symbolic link points to the new one. +It is advisable to copy the shared library if it is a newer version. +The old one can be removed if the symbolic link points to the new one. For example, these libraries already exist on the FreeBSD system: @@ -384,24 +384,18 @@ However, it is safe to replace the existing [.filename]#libc.so# with the newer /compat/linux/lib/libc.so.4 -> libc.so.4.6.29 .... -Generally, one will need to look for the shared libraries that Linux binaries depend on only the first few times that a Linux program is installed on FreeBSD. +Generally, it is only necessary to look for the shared libraries that Linux binaries depend on the first few times that a Linux program is installed on FreeBSD. After a while, there will be a sufficient set of Linux shared libraries on the system to be able to run newly installed Linux binaries without any extra work. === Branding Linux ELF Binaries The FreeBSD kernel uses several methods to determine if the binary to be executed is a Linux one: it checks the brand in the ELF file header, looks for known ELF interpreter paths and checks ELF notes; finally, by default, unbranded ELF executables are assumed to be Linux anyway. -Should all those methods fail, an attempt to execute the binary might result in error message: +Should all those methods fail, an attempt to execute the binary might result in an error message: [source,shell] .... % ./my-linux-elf-binary -.... - -The output should be similar to the following: - -[.programlisting] -.... ELF binary type not known Abort .... @@ -425,11 +419,11 @@ Once installed, `root` can use this command to install a [.filename]#.rpm#: .... If necessary, `brandelf` the installed ELF binaries. -Note that this will prevent a clean uninstall. +Note that this will prevent a clean uninstall as the binaries are modified by the `brandelf` program. === Configuring the Hostname Resolver -If DNS does not work or this error appears: +When using Linux binaries, if DNS does not work or this error appears: [.programlisting] .... @@ -446,7 +440,7 @@ multi on .... This specifies that [.filename]#/etc/hosts# is searched first and DNS is searched second. -When [.filename]#/compat/linux/etc/host.conf# does not exist, Linux applications use [.filename]#/etc/host.conf# in the host system but they complain since that file does not exist in FreeBSD. +When [.filename]#/compat/linux/etc/host.conf# does not exist, Linux applications try to use [.filename]#/etc/host.conf# in the host system but they complain since that file does not exist in FreeBSD. Remove `bind` if a name server is not configured using [.filename]#/etc/resolv.conf#. [[linuxemu-misc]] From nobody Fri May 12 12:56:08 2023 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 4QHpfd0SRdz4B0CV for ; Fri, 12 May 2023 12:56:09 +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 4QHpfc73l5z3vZ1; Fri, 12 May 2023 12:56:08 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683896169; 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=FDPahU+kg6+0BnNwIT4/OG30XSa0531/OqKgbUKQGiM=; b=u/I7DfFh4Ul9/q4fiYhKoO3vz3HJWQDhsWTJSwnEvfwly7AWu1CzYyhHzNdpKj+bZbVUa6 aTzAG6G8+xduke6UbwEUqxLMN/M2lO1G8/KO1S3BGHQZhknhoAM60iXbFRh3H6Sxby9Jmu 7NjovKkEJS37oYop9/sEbzAdxNLySh+xmCxCpsLpe5khza3GyQrmu+5BifMDEx1pMssBO8 c2TxAsG+IgN/zdY6xxfiOtMMe7paQQJkv4976VgDTxvSMLg6NH4cCfRqbcK9awqYB3mcMw Q17RNe5ZCVDoNFQ6UiJIqBRgGvnj2XM2hFWRDUAKIgu0PXhl/l2W/Ais5go22Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683896169; 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=FDPahU+kg6+0BnNwIT4/OG30XSa0531/OqKgbUKQGiM=; b=o3mwWACrn5TDnDx/+MVMCqk9kpgPPZMpXCtJMo6sMpzJzWDn2fTiegCnzwUGtMgnz5tpfj yIDTFeeKG2UkYKW+XYl1L7YzBv1ri9MeJXoAZrXYWzxfCx0AnERDxEmwnaaRfS1+8n9r8w qmL9qlBgj91MB/L2oALh8GrCaUg4PLlAwM7FVGMTlUA3sF0IoE+FgVH/05F2msOxAUaiOd SKHtlI0Duh7HfGx/z99EUDcMgtggdCFDhNqw0xKTtgmgmpqoBlA+Yqc9u46jFIbgg5ygAS ArKTMqDWA/kn4yiW0alLq2EmmTL8dkTkoKFUXTtj4aMc/e3DU+rMC79H2YKixA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683896169; a=rsa-sha256; cv=none; b=RH9rA6OiqW0EjL9ydT9SYW+EwlKngIdQ493g4ipRKu1ntcRAqvmeH/RCCMY+WUgZsGzobp tviu3sSkrTTcf1BYVjuOHU8G2DuB9M1U2vbXl6eFkHsxcU8V/jZKJQDwQb4USNqiXCZ40w XXTzwa/p4S1apdOAYhzGoj/wdES/3T7VJ86IPBUiReMurd9x3KVpg9n62cCVQTmqHXZqA+ 5JfXD+wWQPrxlZmrCFLr8oXC0iJjd0o46lq9RYtZCbKCb++8njqJ86bjXqf0GWT+lcJdtg yXawYXvLdk7Mj7iBl4BUZOyslL81UTSFcrWkUbtzacxl7rmFrOgajxWDSNiDhA== 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 4QHpfc65YPzc3H; Fri, 12 May 2023 12:56:08 +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 34CCu8ks082843; Fri, 12 May 2023 12:56:08 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34CCu81c082842; Fri, 12 May 2023 12:56:08 GMT (envelope-from git) Date: Fri, 12 May 2023 12:56:08 GMT Message-Id: <202305121256.34CCu81c082842@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Muhammad Moinur Rahman Subject: git: 707a7e89ff - main - .vale/styles: Add terms from porters-handbook/versions 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bofh X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 707a7e89ff295d8d53cc70b06269ab7253e6a7dd Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bofh: URL: https://cgit.FreeBSD.org/doc/commit/?id=707a7e89ff295d8d53cc70b06269ab7253e6a7dd commit 707a7e89ff295d8d53cc70b06269ab7253e6a7dd Author: Muhammad Moinur Rahman AuthorDate: 2023-05-12 12:53:51 +0000 Commit: Muhammad Moinur Rahman CommitDate: 2023-05-12 12:55:41 +0000 .vale/styles: Add terms from porters-handbook/versions Add FreeBSD specific terms unavailable in the Dictionary from porters-handbook/versions section. Approved by: bcr carlavilla (mentor implicit) --- .vale/styles/Vocab/Terms/accept.txt | 149 +++++++++++++++++++++++++++++++++++- 1 file changed, 146 insertions(+), 3 deletions(-) diff --git a/.vale/styles/Vocab/Terms/accept.txt b/.vale/styles/Vocab/Terms/accept.txt index 7b081da1af..e9b7998ab4 100644 --- a/.vale/styles/Vocab/Terms/accept.txt +++ b/.vale/styles/Vocab/Terms/accept.txt @@ -1,32 +1,175 @@ (?i)bpf -APIs +(?:je|tc)malloc +AMCC\'s +APIs? +Adaptec +Belkin Biba +Broadcom DTDs +DTrace +FreeBSD +Heimdal +Hhook +KPIs? +Lua +MFC +Mellanox +Mylex +NVMe +Novell +OIDs? +Qlogic +Radeon Redistributions +SMBus +SMPng Safeport +Setkey +USB +VIMAGE +[Bn]inutil +[Cc]allouts? [Dd]atagram +[Dd]eallocat(?:e|ion) [Dd]evfs +[Dd]ummynet +[Ff]ramebuffer +[Jj]ourna(?:led|ling) +[Kk]help +[Kk]obj [Mm]map +[Mm]ulticast +[Nn]et(?:graph|map) [Uu]serland +[Vv]irtualiz(?:ation|es|ed|ing) [Vv]node +arg +armeb +ath +backout +backport +bool +bsdiff +busdma +byacc +cdev +cdevsw +config +conformant +const +cpufreq +crt(?:begin|end) +crypto +ctype +cutover +deanonymizing demultiplexer dereference +devclass +disklabel +dpcpu +drm +enums errno +fileops +filedesc +fusefs +gcc +glibc +gperf +gpreg +gtar +gzip(?:\'ed) +iconv +if(?:_bridge|lib|net) +inlining +inode ioctls +klds? +kqueue +krpc +kyua +ldconfig +libc +libdialog +libdwarf +libmap +libncurses +libtinfow +libunwind +libutil +lib(?:alias|elf|lzma|m|md|objc|pam|pcap|pthread|thr|ulog|utempter) +lldb? +llvm +lockless lookups +lzma +manpage +makefs mbuf -multicast +mips +mountd +mtree +multibyte multilabel -multithreaded +multithrea(?:d|ded|ding) +musl mutex namespace +ncurses +netisrs? +newbus +newsyslog +nfscommon +nfsd +nfsserver +openmp +passthrough +pcb +pfil +pmc +portsnap +powerpc +powerstate procfs pluggable +pkg_install +readline +reentrant +reimplement(?:ation|ed|ing) +rtld +s?rc +securelevels? +sed +sleepable +smbfs +stacksizes? statfs syscall +sysctl sysctl\'s +sysfs +tcpdump +tcsh +teardown +tickless +trapframe tunables +twe uid +unbreaking unloadable +unwiring +userspace +vectorizer +vflush +vfs +vfs_mount +vnet vp wakeup +xz +yacc +zfs +zlib From nobody Fri May 12 19:11:14 2023 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 4QHyzk11m7z4BMNN for ; Fri, 12 May 2023 19:11:30 +0000 (UTC) (envelope-from ceri@submonkey.net) Received: from mail-wm1-x333.google.com (mail-wm1-x333.google.com [IPv6:2a00:1450:4864:20::333]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "smtp.gmail.com", Issuer "GTS CA 1D4" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4QHyzj52RXz3G6N for ; Fri, 12 May 2023 19:11:29 +0000 (UTC) (envelope-from ceri@submonkey.net) Authentication-Results: mx1.freebsd.org; none Received: by mail-wm1-x333.google.com with SMTP id 5b1f17b1804b1-3f4249b7badso65338555e9.3 for ; Fri, 12 May 2023 12:11:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=submonkey-net.20221208.gappssmtp.com; s=20221208; t=1683918688; x=1686510688; h=to:in-reply-to:cc:references:message-id:date:subject:mime-version :from:content-transfer-encoding:from:to:cc:subject:date:message-id :reply-to; bh=RgOuzI9AKGnc55ZapJk1RsI2SZMzcUQMiucHkruwLT8=; b=oBoE3Z1eMjuzYy7GrDAPPQPyFgZ+uEPtVcWg86kvJIdG+88aBzoiqkgmOrrbBhpd/S 5MwEOuQGFbFIhOsHrHitG2BBQ+7ctV3n9TInMdcK/O86QiwSvwwrw4PNOP/a66nzxSHI k3RIO33TUY/TslIbpEGixGqiHqMhiiTb5T+/RyedN+KOZkFghi2dNo5GmsNVMTe+a6ys jcBv3PYtIsbqzsh/5ggQolG6BiYCi2J+1iMDphKRHYk/pOXUUV9DjBsH/ms+QPjxt/Yb ZUHjsZ6GXwQAdgGJI4ZXcb8q+w72/sn+qeA7+9Y61aijm7roXR+KoZB9KY/9kvMgBPI1 /ROw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683918688; x=1686510688; h=to:in-reply-to:cc:references:message-id:date:subject:mime-version :from:content-transfer-encoding:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=RgOuzI9AKGnc55ZapJk1RsI2SZMzcUQMiucHkruwLT8=; b=DxCPsMV8ZpIMejR+kZLZd8s5XXspbAMoTM61q/46Oj/4FUq/D4CJZoSG7guIMvAW5C L7NUL63qEx5iGn6456+dL38VWJcEVxCOEINq3EL7flwpPh2CcsO6wi5S4jytw1Fks3Va U6pdUIC8xNuxa0XRPP65aZS9qSMyoGpFDSWpf4RQGLyeVTxyUNPwmDNBEg3cVPhWNgml W4QdxDQFkP4me+6JIygQaXkR7g0NHcKajI5+celSkaYp6eHRCZ/ty28pvHNOCY1w/C/K N1qwcmv6Ff0OKRCAyd2rnycOYZHb8Kha87/HM6MHOfBrYsWXWmbROZbbmWGzCOoiEm4D RRlQ== X-Gm-Message-State: AC+VfDzvJOqLF5VQPbkENuGhnZ3XSPmSXV+yeU3S5iHtTUiiSntN3bvC lik29B1hj1QsMO8WZi/3/eLS+35QnbjHFebEdYk= X-Google-Smtp-Source: ACHHUZ5y57YWiTIKtyfWiksNDbsFfAkqB8rqtXPLeWiE7vG+ZEItJcxItKb1G7tA7ysK7vThpp10gg== X-Received: by 2002:a05:6000:1047:b0:307:7d31:1a7a with SMTP id c7-20020a056000104700b003077d311a7amr16846704wrx.13.1683918688025; Fri, 12 May 2023 12:11:28 -0700 (PDT) Received: from smtpclient.apple ([88.97.110.43]) by smtp.gmail.com with ESMTPSA id n2-20020a05600c294200b003f17eded97bsm29350300wmd.19.2023.05.12.12.11.27 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 12 May 2023 12:11:27 -0700 (PDT) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit From: Ceri Davies 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org Mime-Version: 1.0 (1.0) Subject: Re: git: 707a7e89ff - main - .vale/styles: Add terms from porters-handbook/versions Date: Fri, 12 May 2023 20:11:14 +0100 Message-Id: References: <202305121256.34CCu81c082842@gitrepo.freebsd.org> Cc: doc-committers@freebsd.org, dev-commits-doc-all@freebsd.org In-Reply-To: <202305121256.34CCu81c082842@gitrepo.freebsd.org> To: Muhammad Moinur Rahman X-Mailer: iPhone Mail (20F65) X-Rspamd-Queue-Id: 4QHyzj52RXz3G6N X-Spamd-Bar: ---- X-Spamd-Result: default: False [-4.00 / 15.00]; REPLY(-4.00)[]; ASN(0.00)[asn:15169, ipnet:2a00:1450::/32, country:US] X-Rspamd-Pre-Result: action=no action; module=replies; Message is reply to one we originated X-ThisMailContainsUnwantedMimeParts: N > On 12 May 2023, at 13:56, Muhammad Moinur Rahman wrote: > > +[Bn]inutil Is this one right? Ceri From nobody Fri May 12 19:13:45 2023 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 4QHz2S4Bwhz4BLyY for ; Fri, 12 May 2023 19:13:52 +0000 (UTC) (envelope-from bofh@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [96.47.72.83]) (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 "smtp.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4QHz2S3Sz1z3Fwx; Fri, 12 May 2023 19:13:52 +0000 (UTC) (envelope-from bofh@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683918832; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=V3FIYubxrYqO5Ewx6QyAOlyAVGxNx02+lAva152VcrM=; b=QnVdDLr37r2NYj31H6vUjKTKWFrGI4IknGm7IARmrg8Dw9j+vgW+B2PFRIGpstBUOIt06V H6T30hcufjN6vQXgHPsgV7Rk7V/Eqp5GKkNHaeq152kroHJFY9fO8MTsCDutJ/CC9q122i SsmD+OuCAuOxhZP7iDH8xkX650RTNhPo2RIfbCmnqGiLvYqrSF0is8lJJAgmxb/2Eb7/fB ylU0x9Znf05emi3IMz+sMe/TNZtYpDRBfphaXDJVplP7Al/5Ue2Z5ebQdIz6UGa8qAymMo Fd9ya+6Q8QPdg2w6FVFJerlTaEvque+Iyc6LqXyYSx+T/uL0hwT/OVlgsinZsA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683918832; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=V3FIYubxrYqO5Ewx6QyAOlyAVGxNx02+lAva152VcrM=; b=XqiAwB3G4/UEvPJTqK1pWCaOW+AdZpsdUOyrjzOk8yg8oNKf+BbA6S/KoU+IvsCOfZpRXm ZSUIoP1qMxBsuX+m3UH7UYHF5IFG4TB/6/Pfl5zccccgbg6DgxxUSsq/VRPHVoCfTnYouc r/C9Ltb/f7OYYY/Hu8bqk+pzOzz1BP2nQqiFK4vQWQo0U1C2X/o8JTtGxYssoitOPVzXdD tf3hDoobNOKbTmccIuEXgD4DHFdtCi7CbTO+/ga4xeww4kvxjVIwYJmxeVdzs+vIMH853D L3Dg8fVI8PsTEMB2TEe3sjcUZ46ll9fs6LjCLD+GQxb36bTMWtF97LhihisI+g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683918832; a=rsa-sha256; cv=none; b=X0RQX2wJcsvvuUYb1yqptc/UhPMBOJY1s3hqg4TJ+z30v5/evUKBAUCyQyg4b+mY+CodSa shI4uUyQ33N7jpGB9dTdFFZYuWcqwFQhSIY/Cy2WJTUHyFA6KzX68Sxw2wa5S+mcvJ2EXo gviKMNKc4A4OGGyjyUu04YUVI0lJNDxhjcwY4P/FbcI8bBOKVIKcgvFAXvUJvdWpoOEI5Z MST4VbiPSc6UAg+Kn8L/KlZobMeJGda9wlP+fn9cgE9nP2lsRZhsy9NFXx3segzhhtTNA0 gAjz4BYJ9JGpgxNtye+G3wDR97UQDhVPr08TwosvwZoJaU2uj+Ac8wOfLSElHw== Received: from mx.bofh.network (mx.bofh.network [IPv6:2a01:4f8:261:25de::227]) (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 ECDSA (P-256) client-digest SHA256) (Client CN "mx.bofh.network", Issuer "R3" (verified OK)) (Authenticated sender: bofh/mail) by smtp.freebsd.org (Postfix) with ESMTPSA id 4QHz2R5znFzvc0; Fri, 12 May 2023 19:13:51 +0000 (UTC) (envelope-from bofh@freebsd.org) Received: from smtpclient.apple (gw.office.cyso.net [95.97.78.194]) by mx.bofh.network (OpenSMTPD) with ESMTPSA id 74b07849 (TLSv1.2:ECDHE-ECDSA-AES256-GCM-SHA384:256:NO); Fri, 12 May 2023 19:13:49 +0000 (UTC) Content-Type: text/plain; charset=us-ascii 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.120.41.1.1\)) Subject: Re: git: 707a7e89ff - main - .vale/styles: Add terms from porters-handbook/versions From: Moin Rahman In-Reply-To: Date: Fri, 12 May 2023 21:13:45 +0200 Cc: doc-committers@freebsd.org, dev-commits-doc-all@freebsd.org Content-Transfer-Encoding: 7bit Message-Id: <47116FEE-091F-4F2F-B995-5694A4A71EB5@freebsd.org> References: <202305121256.34CCu81c082842@gitrepo.freebsd.org> To: Ceri Davies X-Mailer: Apple Mail (2.3696.120.41.1.1) X-ThisMailContainsUnwantedMimeParts: N > On May 12, 2023, at 9:11 PM, Ceri Davies wrote: > > > >> On 12 May 2023, at 13:56, Muhammad Moinur Rahman wrote: >> >> +[Bn]inutil > > Is this one right? > > Ceri :'( From nobody Fri May 12 19:44:49 2023 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 4QHzk95H8Cz4BNyG for ; Fri, 12 May 2023 19:44:49 +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 4QHzk951lzz3HcC; Fri, 12 May 2023 19:44:49 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683920689; 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=vffuOtt0kbbpyH7p0//cLM6mqEq79mZaqFN3diy7cGc=; b=WLCizFDVrHH+aXUeFPorbesksZcdRdF1Uy+0RZGw3/mMmw8iQzRVcq3Q4HMNAe/N+iQtcS 3IrQzboyoC3lkvruFr3SJuGxZR6+qIFj+0uTPkv0Adx6DCmjoRIDAHO2Mz5YUI8NV7fqUt Y5NGv4dPjzIQ9qMwRh/xEIYJ9LucEmeafCv/7EcnFyWvt1n9ow3PBSyHphtH8XCjLlW1LV WsrtsOIAWuTtG/c8QCEavHYw7DgLK53mZn53dM+3eQDE3Sgajza7DTB0rXIDAgNK1RTfHZ SLyhiDCOJRskl+krukFCwAqP5hv0j8r7k3uZRPxpectKC5T4YQmJuw1isY/J5w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1683920689; 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=vffuOtt0kbbpyH7p0//cLM6mqEq79mZaqFN3diy7cGc=; b=T4AjvAkKFBJPma+uPuHptQc+CtQHGPQ67SYIFdxWNHi7KBf9r7h8rqrxcXPV67Sup564bh LPdvRjtt95T7qG5EdHI5pAE8O0rCJ/7Y28KqlA0BFKcCOYRBUpaqCjlbI2EPpT1Fl6yWti gCC91wnfkaRXNuIEEaOumI/6gCdMpUWvCSgzU1lnTdBXk8elfGM3osYXlU3IUaALAIWZo+ DilDD6WjBGciPbWGX53ZQmi10JiuTXleetF2kyK7a2HjCaVaPFSpwemsUsnG1zzq2NdNrZ F1zfbPxFYud2wSgLdHXQTKUlCxHkvYlR+IPg9XuyZA4573D3+v+SGc+bNRSYLA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1683920689; a=rsa-sha256; cv=none; b=s5KMRHJnvAgS+CFPiXF/V6gwreYxGzmH+3IujSB2ACn1c/NnDPC/ivrv+ZNtOHWn2cv3BY XIklJqDuppvBHNP7tN7tJ6rndr9kG7WTYC5GjubYzW7E9yyqWmGIZiWj4mr7U8AFQwK9Sj /UKRIdu8QN0OVy728hfZGDjY1x6l7RdB9knXBSKnWesyWvXKsot+SAtSxzPjmMeuiYAmQG m92e23M19N3z3iO0aFKF2mh+pN5NxdTd5N8/+oLgdPEWaRRuBXpNQooI6eP1Bm0NdbvQPB AYmRB52+QB9W4SzExDX8CuEDq7JfZp1CMijPJNy52Ax36DhLIJhWQGfURHhZUw== 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 4QHzk943ggzp3t; Fri, 12 May 2023 19:44:49 +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 34CJinr7059433; Fri, 12 May 2023 19:44:49 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34CJindw059432; Fri, 12 May 2023 19:44:49 GMT (envelope-from git) Date: Fri, 12 May 2023 19:44:49 GMT Message-Id: <202305121944.34CJindw059432@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Edson Brandi Subject: git: bd3a381b0b - main - Article nanobsd translated to pt_BR and synced with doc tree version 98c736dd127a2096dc08252d1082300f2ec28ab5 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ebrandi X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: bd3a381b0b1fd8a5058772fb96acbb20a3aed89b Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by ebrandi: URL: https://cgit.FreeBSD.org/doc/commit/?id=bd3a381b0b1fd8a5058772fb96acbb20a3aed89b commit bd3a381b0b1fd8a5058772fb96acbb20a3aed89b Author: Edson Brandi AuthorDate: 2023-05-12 19:43:30 +0000 Commit: Edson Brandi CommitDate: 2023-05-12 19:43:30 +0000 Article nanobsd translated to pt_BR and synced with doc tree version 98c736dd127a2096dc08252d1082300f2ec28ab5 --- .../content/pt-br/articles/nanobsd/_index.adoc | 243 ++- .../content/pt-br/articles/nanobsd/_index.po | 1567 ++++++++++++++++++++ 2 files changed, 1739 insertions(+), 71 deletions(-) diff --git a/documentation/content/pt-br/articles/nanobsd/_index.adoc b/documentation/content/pt-br/articles/nanobsd/_index.adoc index a36ac3f521..1563861b50 100644 --- a/documentation/content/pt-br/articles/nanobsd/_index.adoc +++ b/documentation/content/pt-br/articles/nanobsd/_index.adoc @@ -1,8 +1,11 @@ --- -title: Introdução ao NanoBSD authors: - - author: Daniel Gerzo -copyright: 2006 Projeto de Documentação do FreeBSD + - + author: 'Daniel Gerzo' +copyright: '2006 The FreeBSD Documentation Project' +description: 'Este documento fornece informações sobre as ferramentas NanoBSD, que podem ser usadas para criar imagens de sistema FreeBSD para aplicações embarcadas, adequadas para uso em uma chave USB, cartão de memória ou outro meio de armazenamento em massa.' +tags: ["nanobsd", "guide", "embedded", "FreeBSD"] +title: 'Introdução ao NanoBSD' trademarks: ["freebsd", "general"] --- @@ -40,7 +43,7 @@ endif::[] [.abstract-title] Resumo -Este documento fornece informações sobre as ferramentas NanoBSD, que podem ser usadas para criar imagens do sistema FreeBSD para aplicativos embarcados, adequadas para uso em um cartão Compact Flash (ou outro meio de armazenamento em massa). +Este documento fornece informações sobre as ferramentas NanoBSD, que podem ser usadas para criar imagens de sistema FreeBSD para aplicações embarcadas, adequadas para uso em uma chave USB, cartão de memória ou outro meio de armazenamento em massa. ''' @@ -49,39 +52,39 @@ toc::[] [[intro]] == Introdução ao NanoBSD -O NanoBSD é uma ferramenta atualmente desenvolvida por Poul-Henning Kamp mailto:phk@FreeBSD.org[phk@FreeBSD.org]. Ele cria uma imagem do sistema FreeBSD para aplicativos embarcados, adequada para uso em um cartão Compact Flash (ou outro meio de armazenamento em massa). +O NanoBSD é uma ferramenta desenvolvida por {phk} e agora mantida por {imp}. Ela cria uma imagem do sistema FreeBSD para aplicações embarcadas, adequada para uso em uma chave USB, cartão de memória ou outro meio de armazenamento em massa. -Ele pode ser usado para construir imagens de instalação especializadas, projetadas para fácil instalação e manutenção de sistemas comumente chamados de "appliances". Os appliances têm seu hardware e software agrupados no produto, o que significa que todos os aplicativos são pré-instalados. O appliance é conectado a uma rede existente e pode começar a funcionar (quase) imediatamente. +Pode ser usado para construir imagens de instalação especializadas, projetadas para facilitar a instalação e manutenção de sistemas comumente chamados de "computer appliances". Os computer appliances têm seu hardware e software empacotados no produto, o que significa que todos os aplicativos estão pré-instalados. O aparelho é conectado a uma rede existente e pode começar a funcionar (quase) imediatamente. -Os recursos do NanoBSD incluem: +As características do NanoBSD incluem: -* Os Ports e os pacotes funcionam como no FreeBSD - Cada aplicativo pode ser instalado e usado em uma imagem do NanoBSD, da mesma forma que no FreeBSD. -* Nenhuma funcionalidade ausente - Se é possível fazer algo com o FreeBSD, é possível fazer a mesma coisa com o NanoBSD, a menos que o recurso ou os recursos específicos sejam explicitamente removidos do NanoBSD quando a imagem foi criada. -* Todo o sistema opera em modo read-only em tempo de execução - É seguro puxar o plugue de alimentação. Não há necessidade de executar man:fsck[8] após um desligamento abrupto do sistema. -* É fácil de criar e personalizar - Usando apenas um script de shell e um arquivo de configuração, é possível criar imagens reduzidas e personalizadas, satisfazendo qualquer conjunto arbitrário de requisitos. +* Os Ports e pacotes funcionam como no FreeBSD - Cada aplicação pode ser instalada e usada em uma imagem NanoBSD, da mesma forma que no FreeBSD. +* Nenhuma funcionalidade faltante - Se é possível fazer algo com o FreeBSD, é possível fazer a mesma coisa com o NanoBSD, a menos que a funcionalidade específica tenha sido explicitamente removida da imagem do NanoBSD quando ela foi criada. +* O sistema opera em modo read-only em tempo de execução - É seguro puxar o plugue de energia. Não há necessidade de executar o man:fsck[8] após um desligamento abrupto do sistema. +* É fácil de compilar e personalizar - Usando apenas um script de shell e um arquivo de configuração, é possível criar imagens reduzidas e personalizadas, satisfazendo qualquer conjunto arbitrário de requisitos. [[howto]] -== NanoBSD Howto +== Guia do NanoBSD [[design]] === O Design do NanoBSD -Quando a imagem estiver presente na midia, é possível inicializar o NanoBSD. O meio de armazenamento em massa é dividido em três partes por padrão: +Uma vez que a imagem está presente no meio de armazenamento, é possível inicializar o NanoBSD. O meio de armazenamento em massa é dividido em três partes por padrão: * Duas partições de imagem: `code#1` e `code#2`. -* A partição do arquivo de configuração, que pode ser montada no diretório [.filename]#/cfg# em tempo de execução. +* A partição do arquivo de configuração, que pode ser montada sob o diretório [.filename]#/cfg# em tempo de execução. Essas partições são normalmente montadas em modo read-only (somente leitura). -Os diretórios [.filename]#/etc# e [.filename]#/var# são discos criados em memória (malloc) pelo comando man:md[4]. +Os diretórios [.filename]#/etc# e [.filename]#/var# são discos man:md[4] (malloc). -A partição do arquivo de configuração persiste no diretório [.filename]#/cfg#. Ele contém arquivos para o diretório [.filename]#/etc# e é brevemente montado como read-only logo após a inicialização do sistema, portanto é necessário copiar os arquivos modificados de [.filename]#/etc# de volta para o [.filename]#/cfg# se as alterações precisarem ser mantidas após a reinicialização do sistema. +A partição do arquivo de configuração persiste no diretório [.filename]#/cfg#. Ele contém arquivos para o diretório [.filename]#/etc# e é montado brevemente como somente leitura logo após a inicialização do sistema. Portanto, é necessário copiar os arquivos modificados do diretório [.filename]#/etc# de volta para o diretório [.filename]#/cfg# se as alterações precisarem ser mantidas após a reinicialização do sistema. -.Fazendo Mudanças Persistentes no [.filename]#/etc/resolv.conf# +.Fazendo alterações persistentes no arquivo [.filename]#/etc/resolv.conf# [example] ==== -[source,shell] +[source, shell] .... # vi /etc/resolv.conf [...] @@ -89,45 +92,93 @@ A partição do arquivo de configuração persiste no diretório [.filename]#/cf # cp /etc/resolv.conf /cfg # umount /cfg .... + ==== [NOTE] ==== -A partição que contém o [.filename]#/cfg# deve ser montada somente no momento da inicialização ou quando for preciso sobrescrever os arquivos de configuração. +A partição que contém o diretório [.filename]#/cfg# deve ser montada somente no momento da inicialização e enquanto sobrescreve os arquivos de configuração. -Manter o [.filename]#/cfg# montado o tempo todo não é uma boa ideia, especialmente se o sistema NanoBSD for executado em um meio de armazenamento em massa que pode ser afetado negativamente por um grande número de gravações na partição (como quando o sistema de arquivos sincroniza os dados para os discos do sistema). +Manter o [.filename]#/cfg# montado o tempo todo não é uma boa idéia, especialmente se o sistema NanoBSD rodar em um meio de armazenamento em massa que pode ser afetado adversamente por um grande número de gravações na partição (como quando o sincronizador do sistema de arquivos libera dados para os discos do sistema). ==== === Construindo uma imagem NanoBSD -Uma imagem NanoBSD é construída usando um simples shell script [.filename]#nanobsd.sh#, que pode ser encontrado no diretório [.filename]#/usr/src/tools/tools/nanobsd#. Este script cria uma imagem, que pode ser copiada no meio de armazenamento usando o utilitário man:dd[1]. +Uma imagem NanoBSD é compilada usando um simples shell script [.filename]#nanobsd.sh#, que pode ser encontrado no diretório [.filename]#/usr/src/tools/tools/nanobsd#. Este script cria uma imagem, que pode ser copiada no meio de armazenamento usando o utilitário man:dd[1]. Os comandos necessários para construir uma imagem NanoBSD são: -[source,shell] +[source, shell] .... - # cd /usr/src/tools/tools/nanobsd <.> # sh nanobsd.sh <.> # cd /usr/obj/nanobsd.full <.> # dd if=_.disk.full of=/dev/da0 bs=64k <.> .... -<.> Altere o diretório atual para o diretório base do script de construção do NanoBSD. +<.> Altere o diretório atual para o diretório base do script de compilação do NanoBSD. -<.> Comece o processo de construção. +<.> Inicie o processo de compilação. -<.> Altere o diretório atual para o local onde as imagens construídas estão localizadas. +<.> Altere o diretório atual para o local onde as imagens compiladas estão localizadas. <.> Instale o NanoBSD no meio de armazenamento. +==== Opções ao compilar uma imagem NanoBSD + +Ao construir uma imagem NanoBSD, várias opções de compilação podem ser passadas para [.filename]#nanobsd.sh# na linha de comando. Essas opções podem ter um impacto significativo no processo de compilação. + +Algumas opções são para fins de verbosidade: + +* `-h`: imprime a página resumida de ajuda. +* `-q`: torna a saída mais silenciosa. +* `-v`: torna a saída mais detalhada (verbose) + +Algumas outras opções podem ser usadas para restringir o processo de compilação. Às vezes, não é necessário reconstruir tudo a partir das fontes, especialmente se uma imagem já foi compilada e apenas poucas alterações foram feitas. + +* `-k`: não compilar o kernel +* `-w`: não compilar o mundo (world) +* `-b`: não compilar nem o kernel e nem o mundo (world) +* `-i`: não compilar uma imagem de disco. Como um arquivo não será criado, não será possível usá-lo com o comando man:dd[1] para gravá-lo em um dispositivo de armazenamento. +* `-f`: não compilar uma imagem de disco para a primeira partição (o que é útil para fins de atualização) +* `-n`: adiciona `-DNO_CLEAN` as etapas `buildworld` e `buildkernel`. Além disso, todos os arquivos que já foram compilados em uma execução anterior são mantidos. + +Um arquivo de configuração pode ser usado para ajustar quantos elementos desejar. Carregue-o com `-c` + +As últimas opções são: + +* `-K`: não instalar um kernel. Uma imagem de disco sem um kernel não poderá executar uma sequência de inicialização normal. + +==== O Processo Completo de Compilação de Imagens + +O processo completo de compilação de imagens passa por muitas etapas. As etapas exatas dependerão das opções selecionadas ao iniciar o script. Supondo que o script seja executado sem opções específicas, isso é o que acontecerá. + +. `run_early_customize`: comandos que são definidos em um arquivo de configuração fornecido. +. `clean_build`: Apenas limpa o ambiente de compilação excluindo os arquivos previamente compilados. +. `make_conf_build`: Monta o arquivo make.conf a partir das variáveis `CONF_WORLD` e `CONF_BUILD`. +. `build_world`: Compila o mundo (world). +. `build_kernel`: Compila os arquivos do kernel. +. `clean_world`: Limpa o diretório de destino. +. `make_conf_install`: Monta o arquivo make.conf a partir das variáveis `CONF_WORLD` e `CONF_INSTALL`. +. `install_world`: Instala todos os arquivos construídos durante o `buildworld`. +. `install_etc`: Instala os arquivos necessários no diretório [.filename]#/etc#, com base no comando `make distribution`. +. `setup_nanobsd_etc`: a primeira configuração específica do NanoBSD ocorre nesta etapa. O diretório [.filename]#/etc/diskless# é criado e o sistema de arquivos raiz é definido como somente leitura. +. `install_kernel`: os arquivos do kernel e dos módulos são instalados. +. `run_customize`: todas as rotinas de personalização definidas pelo usuário serão chamadas. +. `setup_nanobsd`: uma estrutura especial de diretórios de configuração é configurada. O diretório [.filename]#/usr/local/etc# é movido para [.filename]#/etc/local# e um link simbólico é criado de volta de [.filename]#/etc/local# para [.filename]#/usr/local/etc#. +. `prune_usr`: os diretórios vazios de [.filename]#/usr# são removidos. +. `run_late_customize`: os últimos scripts personalizados podem ser executados neste ponto. +. `fixup_before_diskimage`: Lista todos os arquivos instalados em um metalog +. `create_diskimage`: cria a imagem de disco, com base nos parâmetros de geometria de disco fornecidos. +. `last_orders`: não faz nada por enquanto. + === Personalizando uma imagem NanoBSD -Este é provavelmente o recurso mais importante e interessante do NanoBSD. Este também é o lugar onde você passará a maior parte do tempo desenvolvendo com o NanoBSD. +Esta é provavelmente a característica mais importante e mais interessante do NanoBSD. É também onde você passará a maior parte do tempo ao desenvolver com o NanoBSD. -A execução do seguinte comando forçará o [.filename]#nanobsd.sh# a ler sua configuração do [.filename]#myconf.nano# localizado no diretório atual: +A invocação do seguinte comando forçará o [.filename]#nanobsd.sh# a ler sua configuração de [.filename]#myconf.nano# localizado no diretório atual: -[source,shell] +[source, shell] .... # sh nanobsd.sh -c myconf.nano .... @@ -139,21 +190,65 @@ A personalização é feita de duas maneiras: ==== Opções de configuração -Com as definições de configuração, é possível configurar as opções passadas tanto para o estágio `buildworld` quando para o `installworld` do processo de construção do NanoBSD, bem como opções internas passadas para o processo principal de construção do NanoBSD. Através destas opções, é possível reduzir o sistema para que ele caiba, por exemplo, em um cartão de memória de 64 MB. Você pode usar as opções de configuração para reduzir ainda mais o FreeBSD, até que ele consista apenas no kernel e em dois ou três arquivos na área de usuário. +Com as configurações de configuração, é possível configurar as opções passadas tanto para as etapas `buildworld` quanto `installworld` do processo de compilação do NanoBSD, bem como opções internas passadas para o processo de compilação principal do NanoBSD. Através dessas opções, é possível reduzir o sistema, para que ele caiba em tão pouco quanto 64MB. Você pode usar as opções de configuração para reduzir ainda mais o FreeBSD, até que consista apenas no kernel e em dois ou três arquivos no espaço do usuário. -O arquivo de configuração consiste em opções de configuração, que substituem os valores padrões. As diretivas mais importantes são: +O arquivo de configuração consiste em opções de configuração, que substituem os valores padrão. As diretivas mais importantes são: -* `NANO_NAME` - Nome da compilação (usada para construir os nomes do diretório de trabalho). -* `NANO_SRC` - Caminho para o diretório com o código fonte que será utilizado na construção da imagem. -* `NANO_KERNEL` - Nome do arquivo de configuração do kernel usado para construir o kernel. +* `NANO_NAME` - Nome da compilação (usado para construir os nomes dos diretórios de trabalho). +* `NANO_SRC` - Caminho para a árvore de código-fonte usada para compilar a imagem. +* `NANO_KERNEL` - Nome do arquivo de configuração do kernel usado para compilar o kernel. * `CONF_BUILD` - Opções passadas para o estágio `buildworld` da compilação. * `CONF_INSTALL` - Opções passadas para o estágio `installworld` da compilação. -* `CONF_WORLD` - Opções passadas para o estágio `buildworld` e o `installworld` da compilação. -* `FlashDevice` - define o tipo de mídia a ser usado. Verifique o [.filename]#FlashDevice.sub# para mais detalhes. +* `CONF_WORLD` - Opções passadas tanto para o estágio `buildworld` quanto para o estágio `installworld` da compilação. +* `FlashDevice` - Define qual tipo de mídia usar. Verifique [.filename]#FlashDevice.sub# para obter mais detalhes. + +Existem muitas outras opções de configuração que podem ser relevantes, dependendo do tipo de NanoBSD desejado. + +===== Personalização Geral + +Existem três estágios, por design, nos quais é possível fazer alterações que afetam o processo de compilação, apenas configurando uma variável no arquivo de configuração fornecido: + +* `run_early_customize`: antes de qualquer outra coisa acontecer. +* `run_customize`: depois que todos os arquivos padrões tiverem sido organizados +* `run_late_customize`: no final do processo, antes da compilação da imagem real do NanoBSD. + +Para personalizar uma imagem do NanoBSD em qualquer um desses passos, é melhor adicionar um valor específico a uma das variáveis correspondentes. + +A variável `NANO_EARLY_CUSTOMIZE` é usada no primeiro passo do processo de construção. Neste momento, não há um exemplo específico do que pode ser feito usando essa variável, mas isso pode mudar no futuro. + +A variável `NANO_CUSTOMIZE` é usada depois que os arquivos de configuração do kernel, world e etc foram instalados, e os arquivos etc foram configurados como uma instalação do NanoBSD. Portanto, é o passo correto no processo de compilação para ajustar opções de configuração e adicionar pacotes, como no exemplo cust_nobeastie. + +A variável `NANO_LATE_CUSTOMIZE` é usada imediatamente antes da criação da imagem do disco, portanto, é o momento final para fazer qualquer alteração. Lembre-se de que a rotina `setup_nanobsd` já foi executada e que os diretórios [.filename]#etc#, [.filename]#conf# e [.filename]#cfg# e seus subdiretórios já foram modificados, então não é o momento de alterá-los neste ponto. Em vez disso, é possível adicionar ou remover arquivos específicos. + +===== Opções de Inicialização + +Também existem variáveis que podem alterar a forma como a imagem do NanoBSD é inicializada. Duas opções são passadas para o man:boot0cfg[8] para inicializar o setor de boot da imagem do disco: + +* `NANO_BOOT0CFG` +* `NANO_BOOTLOADER` + +Com o `NANO_BOOTLOADER`, é possível escolher um arquivo de bootloader. As opções mais comuns são entre [.filename]#boot0sio# e [.filename]#boot0#, dependendo se o aparelho possui uma porta serial ou não. É melhor evitar fornecer um bootloader diferente, mas é possível fazê-lo. Para isso, é recomendável ter verificado o capítulo sobre o processo de inicialização no extref:{handbook}boot[Handbook do FreeBSD]. + +Com o `NANO_BOOT0CFG`, é possível ajustar o processo de inicialização, como selecionar em qual partição a imagem do NanoBSD será inicializada. É melhor verificar a página man:boot0cfg[8] antes de alterar o valor padrão dessa variável. Uma opção interessante para alterar é o tempo limite do procedimento de inicialização. Para fazer isso, a variável `NANO_BOOT0CFG` pode ser alterada para `"-o packet -s 1 -m 3 -t 36"`. Dessa forma, o processo de inicialização começaria após aproximadamente 2 segundos, porque é raro que seja desejado esperar 10 segundos antes de iniciar o boot. + +Bom saber: a variável `NANO_BOOT2CFG` é usada apenas na rotina `cust_comconsole`, que pode ser chamada no passo `NANO_CUSTOMIZE` se o aparelho tiver uma porta serial e toda a entrada e saída do console tiver que ser feita por meio dela. Certifique-se de verificar os parâmetros relevantes da porta serial, pois definir um valor incorreto pode torná-la inútil. + +===== Criação da Imagem do Disco + +No final do processo de inicialização está a criação da imagem do disco. Com essa etapa, o script do NanoBSD fornece um arquivo que pode ser simplesmente copiado para um disco do aparelho, e isso fará com que ele seja inicializado e iniciado. + +Existem muitas variáveis que precisam ser configuradas corretamente para que o script produza uma imagem de disco utilizável. + +* A variável `NANO_DRIVE` deve ser definida como o nome da unidade de mídia em tempo de execução. Geralmente, o valor padrão `ada0`, que representa o primeiro dispositivo `IDE`/`ATA`/`SATA` no aparelho, é esperado como o correto, mas um tipo diferente de armazenamento também pode ser usado - como uma chave USB, nesse caso seria `da0`. +* A variável `NANO_MEDIASIZE` deve ser definida como o tamanho (em setores de 512 bytes) da mídia de armazenamento que será usada. Se você definir isso incorretamente, é possível que a imagem do NanoBSD não inicialize e uma mensagem durante a inicialização avisará sobre a geometria de disco incorreta. + +* Os diretórios [.filename]#/etc#, [.filename]#/var# e [.filename]#/tmp# são alocados como discos man:md[4] (malloc) durante a inicialização; portanto, seus tamanhos podem ser ajustados para atender às necessidades do aparelho. A variável `NANO_RAM_ETCSIZE` define o tamanho do [.filename]#/etc# e a variável `NANO_RAM_TMPVARSIZE` define o tamanho tanto do diretório [.filename]#/var# quanto do diretório [.filename]#/tmp#, já que [.filename]#/tmp# está simbolicamente vinculado a [.filename]#/var/tmp#. Por padrão, ambos os tamanhos dos discos malloc são definidos em 20MB cada. Eles podem ser alterados, mas geralmente o [.filename]#/etc# não cresce muito em tamanho, portanto, 20MB é um bom ponto de partida, enquanto o [.filename]#/var# e especialmente o [.filename]#/tmp# podem aumentar muito de tamanho se não tiver cuidado. Para sistemas com restrição de memória, tamanhos menores de sistema de arquivos podem ser escolhidos. +* Como o NanoBSD é projetado principalmente para criar uma imagem de sistema para um aparelho, presume-se que a mídia de armazenamento usada seja relativamente pequena. Por esse motivo, o sistema de arquivos que é organizado é configurado com um tamanho de bloco pequeno (4Kb) e um tamanho de fragmento pequeno (512b). As opções de configuração do sistema de arquivos podem ser modificadas por meio da variável `NANO_NEWFS`, mas a sintaxe deve respeitar o formato do comando man:newfs[8]. Além disso, por padrão, o sistema de arquivos tem Soft Updates ativado. O extref:{handbook}[Handbook do FreeBSD] pode ser consultado para obter mais informações sobre isso. +* Os diferentes tamanhos das partições podem ser definidos por meio do uso de `NANO_CODESIZE`, `NANO_CONFSIZE` e `NANO_DATASIZE` como múltiplos de setores de 512 bytes. `NANO_CODESIZE` define o tamanho das duas primeiras partições da imagem: `code#1` e `code#2`. Elas devem ser grandes o suficiente para armazenar todos os arquivos que serão produzidos como resultado dos processos `buildworld` e `buildkernel`. `NANO_CONFSIZE` define o tamanho da partição do arquivo de configuração, portanto, não precisa ser muito grande, mas não a faça tão pequena que não possa armazenar todos os arquivos de configuração. Por fim, `NANO_DATASIZE` define o tamanho de uma partição opcional que pode ser usada no aparelho. A última partição pode ser usada, por exemplo, para manter arquivos criados dinamicamente no disco. ==== Funções Personalizadas -É possível ajustar o NanoBSD usando as funções do shell no arquivo de configuração. O exemplo a seguir ilustra o modelo básico de funções personalizadas: +É possível ajustar o NanoBSD usando funções de shell no arquivo de configuração. O exemplo a seguir ilustra o modelo básico de funções personalizadas: [.programlisting] .... @@ -164,7 +259,7 @@ cust_foo () ( customize_cmd cust_foo .... -Um exemplo mais útil de uma função de customização é o seguinte, o qual altera o tamanho padrão do diretório [.filename]#/etc# de 5MB para 30MB: +Um exemplo mais útil de uma função de personalização é o seguinte, que altera o tamanho padrão do diretório [.filename]#/etc# de 5MB para 30MB: [.programlisting] .... @@ -177,29 +272,25 @@ customize_cmd cust_etc_size Existem algumas funções de customização pré-definidas por padrão e prontas para uso: -* `cust_comconsole` -- Desabilita o man:getty[8] nos dispositivos VGA (os device nodes [.filename]#/dev/ttyv*#) e habilita o uso do console do sistema na serial COM1. -* `cust_allow_ssh_root` -- Permite que o `root` faça o login via man:sshd[8]. -* `cust_install_files` -- Instala arquivos do diretório [.filename]#nanobsd/Files#, que contém alguns scripts úteis para administração do sistema. +* `cust_comconsole` - Desabilita o man:getty[8] nos dispositivos VGA (os nós de dispositivo [.filename]#/dev/ttyv*#) e habilita o uso da porta serial COM1 como console do sistema. +* `cust_allow_ssh_root` - Permite que o usuário `root` faça login via man:sshd[8]. +* `cust_install_files` - Instala arquivos do diretório [.filename]#nanobsd/Files#, que contém alguns scripts úteis para administração do sistema. +* `cust_pkgng` - Instala pacotes do diretório [.filename]#nanobsd/Pkg#, (necessita também do pacote pkg-* para inicialização). ==== Adicionando Pacotes -Pacotes podem ser adicionados a uma imagem NanoBSD usando uma função customizada. A seguinte função irá instalar todos os pacotes localizados em [.filename]#/usr/src/files/tools/nanobsd/packages#: +Pacotes podem ser adicionados a uma imagem do NanoBSD para fornecer funcionalidades específicas no aparelho. Para fazer isso, você pode escolher uma das seguintes opções: -[.programlisting] -.... -install_packages () ( -mkdir -p ${NANO_WORLDDIR}/packages -cp /usr/src/tools/tools/nanobsd/packages/* ${NANO_WORLDDIR}/packages -cp $(which pkg-static) ${NANO_WORLDDIR}/ -chroot ${NANO_WORLDDIR} sh -c 'cd packages; /pkg-static add *;cd ..;' -rm -rf ${NANO_WORLDDIR}/packages ${NANO_WORLDDIR}/pkg-static -) -customize_cmd install_packages -.... +* Adicionar `cust_pkgng` à variável `NANO_CUSTOMIZE`, ou +* Adicionar o comando `'customize_cmd cust_pkgng'` em um arquivo de configuração personalizado. + +Ambos os métodos alcançam o mesmo resultado: executar a rotina `cust_pkgng`. Essa rotina percorrerá o diretório `NANO_PACKAGE_DIR` para encontrar todos os pacotes ou apenas a lista de pacotes na variável `NANO_PACKAGE_LIST`. + +É comum, ao instalar aplicativos por meio do pkg em um ambiente FreeBSD padrão, que o processo de instalação coloque arquivos de configuração no diretório [.filename]#usr/local/etc# e scripts de inicialização no diretório [.filename]#/usr/local/etc/rc.d#. Portanto, após a instalação dos pacotes necessários, eles precisam ser configurados para iniciar imediatamente. Para fazer isso, os arquivos de configuração necessários devem ser instalados nos diretórios corretos. Isso pode ser feito escrevendo rotinas dedicadas ou utilizando a rotina genérica `cust_install_files` para organizar os arquivos corretamente a partir do diretório [.filename]#/usr/src/tools/tools/nanobsd/Files#. Geralmente, também é necessário adicionar uma ou várias declarações no arquivo [.filename]#/etc/rc.conf# para cada pacote. ==== Exemplo do arquivo de configuração -Um exemplo completo de um arquivo de configuração para criar uma imagem NanoBSD personalizada pode ser: +Um exemplo completo de um arquivo de configuração para construir uma imagem personalizada do NanoBSD pode ser: [.programlisting] .... @@ -254,61 +345,71 @@ customize_cmd cust_allow_ssh_root customize_cmd cust_nobeastie .... +Todas as opções de compilação e instalação podem ser encontradas na página do manual man:src.conf[5], mas nem todas as opções podem ou devem ser usadas ao construir uma imagem do NanoBSD. As opções de compilação e instalação devem ser definidas de acordo com as necessidades da imagem sendo construída. + +Por exemplo, o cliente e servidor FTP podem não ser necessários. Adicionar `WITHOUT_FTP=TRUE` em um arquivo de configuração na seção `CONF_BUILD` evitará que eles sejam compilados. Além disso, se o aparelho NanoBSD não será usado para compilar programas, é possível adicionar `WITHOUT_BINUTILS=TRUE` na seção `CONF_INSTALL`; mas não na seção `CONF_BUILD`, pois eles serão usados para construir a imagem do NanoBSD. + +Não compilar um conjunto específico de programas - por meio de uma opção de compilação - reduz o tempo total de compilação e diminui o tamanho necessário para a imagem do disco, enquanto não instalar o mesmo conjunto específico de programas não reduz o tempo total de compilação. + === Atualizando o NanoBSD O processo de atualização do NanoBSD é relativamente simples: [.procedure] -. Crie uma nova imagem NanoBSD, como de costume. -. Carregue a nova imagem em uma partição não usada de um dispositivo NanoBSD em execução. -+ -A diferença mais importante deste passo da instalação inicial do NanoBSD é que agora, em vez de usar [.filename]#_. Disk.full# (que contém uma imagem do disco todo), a imagem [.filename]#\_.disk.image# está instalada (a qual contém uma imagem de uma única partição do sistema). +==== +. Construa uma nova imagem do NanoBSD, como de costume. +. Faça o upload da nova imagem para uma partição não utilizada de um aparelho NanoBSD em execução. ++ +A diferença mais importante deste passo em relação à instalação inicial do NanoBSD é que, em vez de usar o arquivo [.filename]#\_.disk.full# (que contém uma imagem do disco inteiro), é instalada a imagem [.filename]#_.disk.image# (que contém uma imagem de uma única partição do sistema). . Reinicie e inicie o sistema a partir da partição recém-instalada. . Se tudo correr bem, a atualização está concluída. . Se algo der errado, reinicie a partição anterior (que contém a imagem antiga que estava em funcionamento) para restaurar a funcionalidade do sistema o mais rápido possível. Corrija quaisquer problemas da nova compilação e repita o processo. +==== -Para instalar uma nova imagem no sistema NanoBSD, é possível usar o script [.filename]#updatep1# ou [.filename]#updatep2# localizado no diretório [.filename]#/root#, dependendo de qual partição o sistema atual está executando. +Para instalar uma nova imagem em um sistema NanoBSD em execução, é possível usar o script [.filename]#updatep1# ou [.filename]#updatep2#, localizados no diretório [.filename]#/root#, dependendo de qual partição o sistema atual está sendo executado. -De acordo com os serviços que estiverem disponíveis no servidor que contem a nova imagem NanoBSD e o tipo de transferência preferido, é possível seguir por uma destas três maneiras: +Dependendo dos serviços disponíveis no host que está servindo a nova imagem do NanoBSD e do tipo de transferência preferido, é possível examinar uma dessas três opções: -==== Usando man:ftp[1] +==== Usando o comando man:ftp[1] Se a velocidade de transferência estiver em primeiro lugar, use este exemplo: -[source,shell] +[source, shell] .... # ftp myhost get _.disk.image "| sh updatep1" .... -==== Usando man:ssh[1] +==== Usando o comando man:ssh[1] Se uma transferência segura for preferida, considere usar este exemplo: -[source,shell] +[source, shell] .... # ssh myhost cat _.disk.image.gz | zcat | sh updatep1 .... -==== Usando man:nc[1] +==== Usando o comando man:nc[1] -Tente este exemplo se o host remoto que contem a nova imagem não estiver executando o serviço man:ftpd[8] e nem o serviço man:sshd[8]: +Experimente este exemplo se o host remoto não estiver executando os serviços man:ftpd[8] ou man:sshd[8]: [.procedure] +==== . Primeiramente, abra um socket TCP em modo escuta no host que serve a imagem e envie a imagem para o cliente: + -[source,shell] +[source, shell] .... myhost# nc -l 2222 < _.disk.image .... + [NOTE] -==== -Certifique-se de que a porta usada não esteja bloqueada para receber conexões de entrada do host NanoBSD pelo firewall. -==== +====== +Verifique se a porta utilizada não está bloqueada pelo firewall para receber conexões originadas do host NanoBSD. +====== . Conecte-se ao host que está servindo a nova imagem e execute o script [.filename]#updatep1#: + -[source,shell] +[source, shell] .... # nc myhost 2222 | sh updatep1 .... +==== diff --git a/documentation/content/pt-br/articles/nanobsd/_index.po b/documentation/content/pt-br/articles/nanobsd/_index.po new file mode 100644 index 0000000000..634715dc8d --- /dev/null +++ b/documentation/content/pt-br/articles/nanobsd/_index.po @@ -0,0 +1,1567 @@ +# SOME DESCRIPTIVE TITLE +# Copyright (C) YEAR The FreeBSD Project +# This file is distributed under the same license as the FreeBSD Documentation package. +# Danilo G. Baio , 2021. +# Edson Brandi , 2023. +# "Danilo G. Baio" , 2023. +msgid "" +msgstr "" +"Project-Id-Version: FreeBSD Documentation VERSION\n" +"POT-Creation-Date: 2023-01-21 20:00-0300\n" +"PO-Revision-Date: 2023-05-12 19:10+0000\n" +"Last-Translator: Edson Brandi \n" +"Language-Team: Portuguese (Brazil) \n" +"Language: pt_BR\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=n > 1;\n" +"X-Generator: Weblate 4.17\n" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:1 +#: documentation/content/en/articles/nanobsd/_index.adoc:46 +#, no-wrap +msgid "This document provides information about the NanoBSD tools, which can be used to create FreeBSD system images for embedded applications, suitable for use on a USB key, memory card or other mass storage media." +msgstr "" +"Este documento fornece informações sobre as ferramentas NanoBSD, que podem " +"ser usadas para criar imagens de sistema FreeBSD para aplicações embarcadas, " +"adequadas para uso em uma chave USB, cartão de memória ou outro meio de " +"armazenamento em massa." + +#. type: Title == +#: documentation/content/en/articles/nanobsd/_index.adoc:1 +#: documentation/content/en/articles/nanobsd/_index.adoc:11 +#: documentation/content/en/articles/nanobsd/_index.adoc:52 +#, no-wrap +msgid "Introduction to NanoBSD" +msgstr "Introdução ao NanoBSD" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:44 +msgid "Abstract" +msgstr "Resumo" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:48 +msgid "'''" +msgstr "'''" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:56 +msgid "" +"NanoBSD is a tool developed by {phk} and now maintained by {imp}. It " +"creates a FreeBSD system image for embedded applications, suitable for use " +"on a USB key, memory card or other mass storage media." +msgstr "" +"O NanoBSD é uma ferramenta desenvolvida por {phk} e agora mantida por {imp}. " +"Ela cria uma imagem do sistema FreeBSD para aplicações embarcadas, adequada " +"para uso em uma chave USB, cartão de memória ou outro meio de armazenamento " +"em massa." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:60 +msgid "" +"It can be used to build specialized install images, designed for easy " +"installation and maintenance of systems commonly called \"computer appliances" +"\". Computer appliances have their hardware and software bundled in the " +"product, which means all applications are pre-installed. The appliance is " +"plugged into an existing network and can begin working (almost) immediately." +msgstr "" +"Pode ser usado para construir imagens de instalação especializadas, " +"projetadas para facilitar a instalação e manutenção de sistemas comumente " +"chamados de \"computer appliances\". Os computer appliances têm seu hardware " +"e software empacotados no produto, o que significa que todos os aplicativos " +"estão pré-instalados. O aparelho é conectado a uma rede existente e pode " +"começar a funcionar (quase) imediatamente." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:62 +msgid "The features of NanoBSD include:" +msgstr "As características do NanoBSD incluem:" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:64 +msgid "" +"Ports and packages work as in FreeBSD - Every single application can be " +"installed and used in a NanoBSD image, the same way as in FreeBSD." +msgstr "" +"Os Ports e pacotes funcionam como no FreeBSD - Cada aplicação pode ser " +"instalada e usada em uma imagem NanoBSD, da mesma forma que no FreeBSD." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:65 +msgid "" +"No missing functionality - If it is possible to do something with FreeBSD, " +"it is possible to do the same thing with NanoBSD, unless the specific " +"feature or features were explicitly removed from the NanoBSD image when it " +"was created." +msgstr "" +"Nenhuma funcionalidade faltante - Se é possível fazer algo com o FreeBSD, é " +"possível fazer a mesma coisa com o NanoBSD, a menos que a funcionalidade " +"específica tenha sido explicitamente removida da imagem do NanoBSD quando " +"ela foi criada." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:66 +msgid "" +"Everything is read-only at run-time - It is safe to pull the power-plug. " +"There is no necessity to run man:fsck[8] after a non-graceful shutdown of " +"the system." +msgstr "" +"O sistema opera em modo read-only em tempo de execução - É seguro puxar o " +"plugue de energia. Não há necessidade de executar o man:fsck[8] após um " +"desligamento abrupto do sistema." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:67 +msgid "" +"Easy to build and customize - Making use of just one shell script and one " +"configuration file it is possible to build reduced and customized images " +"satisfying any arbitrary set of requirements." +msgstr "" +"É fácil de compilar e personalizar - Usando apenas um script de shell e um " +"arquivo de configuração, é possível criar imagens reduzidas e " +"personalizadas, satisfazendo qualquer conjunto arbitrário de requisitos." + +#. type: Title == +#: documentation/content/en/articles/nanobsd/_index.adoc:69 +#, no-wrap +msgid "NanoBSD Howto" +msgstr "Guia do NanoBSD" + +#. type: Title === +#: documentation/content/en/articles/nanobsd/_index.adoc:72 +#, no-wrap +msgid "The Design of NanoBSD" +msgstr "O Design do NanoBSD" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:76 +msgid "" +"Once the image is present on the medium, it is possible to boot NanoBSD. " +"The mass storage medium is divided into three parts by default:" +msgstr "" +"Uma vez que a imagem está presente no meio de armazenamento, é possível " +"inicializar o NanoBSD. O meio de armazenamento em massa é dividido em três " +"partes por padrão:" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:78 +msgid "Two image partitions: `code#1` and `code#2`." +msgstr "Duas partições de imagem: `code#1` e `code#2`." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:79 +msgid "" +"The configuration file partition, which can be mounted under the [." +"filename]#/cfg# directory at run time." +msgstr "" +"A partição do arquivo de configuração, que pode ser montada sob o diretório [" +".filename]#/cfg# em tempo de execução." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:81 +msgid "These partitions are normally mounted read-only." +msgstr "" +"Essas partições são normalmente montadas em modo read-only (somente leitura)." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:83 +msgid "" +"The [.filename]#/etc# and [.filename]#/var# directories are man:md[4] " +"(malloc) disks." +msgstr "" +"Os diretórios [.filename]#/etc# e [.filename]#/var# são discos man:md[4] " +"(malloc)." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:86 +msgid "" +"The configuration file partition persists under the [.filename]#/cfg# " +"directory. It contains files for [.filename]#/etc# directory and is briefly " +"mounted read-only right after the system boot, therefore it is required to " +"copy modified files from [.filename]#/etc# back to the [.filename]#/cfg# " +"directory if changes are expected to persist after the system restarts." +msgstr "" +"A partição do arquivo de configuração persiste no diretório [.filename]#/cfg#" +". Ele contém arquivos para o diretório [.filename]#/etc# e é montado " +"brevemente como somente leitura logo após a inicialização do sistema. " +"Portanto, é necessário copiar os arquivos modificados do diretório [." +"filename]#/etc# de volta para o diretório [.filename]#/cfg# se as alterações " +"precisarem ser mantidas após a reinicialização do sistema." + +#. type: Block title +#: documentation/content/en/articles/nanobsd/_index.adoc:87 +#, no-wrap +msgid "Making Persistent Changes to [.filename]#/etc/resolv.conf#" +msgstr "" +"Fazendo alterações persistentes no arquivo [.filename]#/etc/resolv.conf#" + +#. type: delimited block . 4 +#: documentation/content/en/articles/nanobsd/_index.adoc:98 +#, no-wrap +msgid "" +"# vi /etc/resolv.conf\n" +"[...]\n" +"# mount /cfg\n" +"# cp /etc/resolv.conf /cfg\n" +"# umount /cfg\n" +msgstr "" +"# vi /etc/resolv.conf\n" +"[...]\n" +"# mount /cfg\n" +"# cp /etc/resolv.conf /cfg\n" +"# umount /cfg\n" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:105 +msgid "" +"The partition containing [.filename]#/cfg# should be mounted only at boot " +"time and while overriding the configuration files." +msgstr "" +"A partição que contém o diretório [.filename]#/cfg# deve ser montada somente " +"no momento da inicialização e enquanto sobrescreve os arquivos de " +"configuração." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:107 +msgid "" +"Keeping [.filename]#/cfg# mounted at all times is not a good idea, " +"especially if the NanoBSD system runs off a mass storage medium that may be " +"adversely affected by a large number of writes to the partition (like when " +"the filesystem syncer flushes data to the system disks)." +msgstr "" +"Manter o [.filename]#/cfg# montado o tempo todo não é uma boa idéia, " +"especialmente se o sistema NanoBSD rodar em um meio de armazenamento em " +"massa que pode ser afetado adversamente por um grande número de gravações na " +"partição (como quando o sincronizador do sistema de arquivos libera dados " +"para os discos do sistema)." + +#. type: Title === +#: documentation/content/en/articles/nanobsd/_index.adoc:109 +#, no-wrap +msgid "Building a NanoBSD Image" +msgstr "Construindo uma imagem NanoBSD" + +#. type: delimited block = 4 +#: documentation/content/en/articles/nanobsd/_index.adoc:113 +msgid "" +"A NanoBSD image is built using a simple [.filename]#nanobsd.sh# shell " +"script, which can be found in the [.filename]#/usr/src/tools/tools/nanobsd# " +"directory. This script creates an image, which can be copied on the storage " +"medium using the man:dd[1] utility." +msgstr "" +"Uma imagem NanoBSD é compilada usando um simples shell script [." +"filename]#nanobsd.sh#, que pode ser encontrado no diretório [.filename]#/usr/" +"src/tools/tools/nanobsd#. Este script cria uma imagem, que pode ser copiada " +"no meio de armazenamento usando o utilitário man:dd[1]." + +#. type: delimited block = 4 +#: documentation/content/en/articles/nanobsd/_index.adoc:115 +msgid "The necessary commands to build a NanoBSD image are:" +msgstr "Os comandos necessários para construir uma imagem NanoBSD são:" + +#. type: delimited block . 4 +#: documentation/content/en/articles/nanobsd/_index.adoc:122 +#, no-wrap +msgid "" +"# cd /usr/src/tools/tools/nanobsd <.>\n" +"# sh nanobsd.sh <.>\n" +"# cd /usr/obj/nanobsd.full <.>\n" +"# dd if=_.disk.full of=/dev/da0 bs=64k <.>\n" +msgstr "" +"# cd /usr/src/tools/tools/nanobsd <.>\n" +"# sh nanobsd.sh <.>\n" +"# cd /usr/obj/nanobsd.full <.>\n" +"# dd if=_.disk.full of=/dev/da0 bs=64k <.>\n" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:125 +msgid "" +"Change the current directory to the base directory of the NanoBSD build " +"script." +msgstr "" +"Altere o diretório atual para o diretório base do script de compilação do " +"NanoBSD." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:127 +msgid "Start the build process." +msgstr "Inicie o processo de compilação." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:129 +msgid "" +"Change the current directory to the place where the built images are located." +msgstr "" +"Altere o diretório atual para o local onde as imagens compiladas estão " +"localizadas." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:131 +msgid "Install NanoBSD onto the storage medium." +msgstr "Instale o NanoBSD no meio de armazenamento." + +#. type: Title ==== +#: documentation/content/en/articles/nanobsd/_index.adoc:132 +#, no-wrap +msgid "Options When Building a NanoBSD Image" +msgstr "Opções ao compilar uma imagem NanoBSD" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:136 +msgid "" +"When building a NanoBSD image, several build options can be passed to [." +"filename]#nanobsd.sh# on the command line. These options can have a " +"significant impact on the build process." +msgstr "" +"Ao construir uma imagem NanoBSD, várias opções de compilação podem ser " +"passadas para [.filename]#nanobsd.sh# na linha de comando. Essas opções " +"podem ter um impacto significativo no processo de compilação." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:138 +msgid "Some options are for verbosity purposes:" +msgstr "Algumas opções são para fins de verbosidade:" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:140 +msgid "`-h`: prints the help summary page." +msgstr "`-h`: imprime a página resumida de ajuda." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:141 +msgid "`-q`: makes output quieter." +msgstr "`-q`: torna a saída mais silenciosa." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:142 +msgid "`-v`: makes output more verbose" +msgstr "`-v`: torna a saída mais detalhada (verbose)" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:145 +msgid "" +"Some other options can be used to restrict the building process. Sometimes " +"it is not necessary to rebuild everything from sources, especially if an " +"image has already been built, and only little change is made." +msgstr "" +"Algumas outras opções podem ser usadas para restringir o processo de " +"compilação. Às vezes, não é necessário reconstruir tudo a partir das fontes, " +"especialmente se uma imagem já foi compilada e apenas poucas alterações " +"foram feitas." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:147 +msgid "`-k`: do not build the kernel" +msgstr "`-k`: não compilar o kernel" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:148 +msgid "`-w`: do not build world" +msgstr "`-w`: não compilar o mundo (world)" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:149 +msgid "`-b`: do not build either kernel and world" +msgstr "`-b`: não compilar nem o kernel e nem o mundo (world)" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:150 +msgid "" +"`-i`: do not build a disk image at all. As a file will not be created, it " +"will not be possible to man:dd[1] it to a storage media." +msgstr "" +"`-i`: não compilar uma imagem de disco. Como um arquivo não será criado, não " +"será possível usá-lo com o comando man:dd[1] para gravá-lo em um dispositivo " +"de armazenamento." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:151 +msgid "" +"`-f`: do not build a disk image of the first partition (which is useful for " +"upgrade purposes)" +msgstr "" +"`-f`: não compilar uma imagem de disco para a primeira partição (o que é " +"útil para fins de atualização)" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:152 +msgid "" +"`-n`: add `-DNO_CLEAN` to `buildworld`, `buildkernel`. Also, all the files " +"that have already been built in a previous run are kept." +msgstr "" +"`-n`: adiciona `-DNO_CLEAN` as etapas `buildworld` e `buildkernel`. Além " +"disso, todos os arquivos que já foram compilados em uma execução anterior " +"são mantidos." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:155 +msgid "" +"A configuration file can be used to tweak as many elements as desired. Load " +"it with `-c`" +msgstr "" +"Um arquivo de configuração pode ser usado para ajustar quantos elementos " +"desejar. Carregue-o com `-c`" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:157 +msgid "The last options are:" +msgstr "As últimas opções são:" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:159 +msgid "" +"`-K`: do not install a kernel. A disk image without a kernel will not be " +"able to achieve a normal boot sequence." +msgstr "" +"`-K`: não instalar um kernel. Uma imagem de disco sem um kernel não poderá " +"executar uma sequência de inicialização normal." + +#. type: Title ==== +#: documentation/content/en/articles/nanobsd/_index.adoc:160 +#, no-wrap +msgid "The Complete Image Building Process" +msgstr "O Processo Completo de Compilação de Imagens" + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:165 +msgid "" +"The complete image building process is going through a lot of steps. The " +"exact steps taken will depend on the chosen options when starting the " +"script. Assuming the script is run with no particular options, this is what " +"will happen." +msgstr "" +"O processo completo de compilação de imagens passa por muitas etapas. As " +"etapas exatas dependerão das opções selecionadas ao iniciar o script. " +"Supondo que o script seja executado sem opções específicas, isso é o que " +"acontecerá." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:167 +msgid "" +"`run_early_customize`: commands that are defined in a supplied configuration " +"file." +msgstr "" +"`run_early_customize`: comandos que são definidos em um arquivo de " +"configuração fornecido." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:168 +msgid "" +"`clean_build`: Just cleans the build environment by deleting the previously " +"built files." +msgstr "" +"`clean_build`: Apenas limpa o ambiente de compilação excluindo os arquivos " +"previamente compilados." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:169 +msgid "" +"`make_conf_build`: Assemble make.conffrom the `CONF_WORLD` and `CONF_BUILD` " +"variables." +msgstr "" +"`make_conf_build`: Monta o arquivo make.conf a partir das variáveis " +"`CONF_WORLD` e `CONF_BUILD`." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:170 +msgid "`build_world`: Build world." +msgstr "`build_world`: Compila o mundo (world)." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:171 +msgid "`build_kernel`: Build the kernel files." +msgstr "`build_kernel`: Compila os arquivos do kernel." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:172 +msgid "`clean_world`: Clean the destination directory." +msgstr "`clean_world`: Limpa o diretório de destino." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:173 +msgid "" +"`make_conf_install`: Assemble make.conf from the `CONF_WORLD` and " +"`CONF_INSTALL` variables." +msgstr "" +"`make_conf_install`: Monta o arquivo make.conf a partir das variáveis " +"`CONF_WORLD` e `CONF_INSTALL`." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:174 +msgid "`install_world`: Install all files built during `buildworld`." +msgstr "" +"`install_world`: Instala todos os arquivos construídos durante o " +"`buildworld`." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:175 +msgid "" +"`install_etc`: Install the necessary files in the [.filename]#/etc# " +"directory, based on the `make distribution` command." +msgstr "" +"`install_etc`: Instala os arquivos necessários no diretório [.filename]#/etc#" +", com base no comando `make distribution`." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:176 +msgid "" +"`setup_nanobsd_etc`: the first configuration specific to NanoBSD takes place " +"at this stage. The [.filename]#/etc/diskless# is created and the root " +"filesystem is defined as read-only." +msgstr "" +"`setup_nanobsd_etc`: a primeira configuração específica do NanoBSD ocorre " +"nesta etapa. O diretório [.filename]#/etc/diskless# é criado e o sistema de " +"arquivos raiz é definido como somente leitura." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:177 +msgid "`install_kernel`: the kernel and modules files are installed." +msgstr "`install_kernel`: os arquivos do kernel e dos módulos são instalados." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:178 +msgid "" +"`run_customize`: all the customizing routines defined by the user will be " +"called." +msgstr "" +"`run_customize`: todas as rotinas de personalização definidas pelo usuário " +"serão chamadas." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:179 +msgid "" +"`setup_nanobsd`: a special configuration directory layout is setup. The [." +"filename]#/usr/local/etc# gets moved to [.filename]#/etc/local# and a " +"symbolic link is created back from [.filename]#/etc/local# to [.filename]#/" +"usr/local/etc#." +msgstr "" +"`setup_nanobsd`: uma estrutura especial de diretórios de configuração é " +"configurada. O diretório [.filename]#/usr/local/etc# é movido para [." +"filename]#/etc/local# e um link simbólico é criado de volta de [.filename]#/" +"etc/local# para [.filename]#/usr/local/etc#." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:180 +msgid "`prune_usr`: the empty directories from [.filename]#/usr# are removed." +msgstr "`prune_usr`: os diretórios vazios de [.filename]#/usr# são removidos." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:181 +msgid "" +"`run_late_customize`: the very last custom scripts can be run at this point." +msgstr "" +"`run_late_customize`: os últimos scripts personalizados podem ser executados " +"neste ponto." + +#. type: Plain text +#: documentation/content/en/articles/nanobsd/_index.adoc:182 +msgid "`fixup_before_diskimage`: List all installed files in a metalog" +msgstr "" +"`fixup_before_diskimage`: Lista todos os arquivos instalados em um metalog" *** 1003 LINES SKIPPED *** From nobody Sat May 13 23:31:30 2023 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 4QJhjG43WSz49vn6 for ; Sat, 13 May 2023 23:31:30 +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 4QJhjG3KHYz4FqZ; Sat, 13 May 2023 23:31:30 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1684020690; 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=3bNPW863CZkNHnsICwZWJvQuznAhBmYguqmZAqelO7U=; b=AIUXKpPNhd6hsI8v1KO3dYtcjDs2c56bd5PdjKzbRBSwf/VLe0N7b2ImKSISuS0ikHAiWy A2ewTQ7MCwmEvkUPpgFVkbiHgoEoN11C7zjvvsSzAj/nhlm6rr0Qr7vLJ7C+LBoGrWawXu dqMqWTP+ZY0Hc2ux698Ya2wGHTaTs/fLKvwYdrxJ9jc8qrwSv6S3lpxjJch4ikqSx6UGLo q1t+9SSQ7dEs8rWNokvOsUC1nf2rr4obyGWm0odeUs8wAR/8YGipyqcX0E5q/hbGwHb38c I+lrL81EeDQ1erbPpIAnzrZRuUtoeSOOkI3TMql6/bCrt+9spwHUXOstctU2Cg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1684020690; 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=3bNPW863CZkNHnsICwZWJvQuznAhBmYguqmZAqelO7U=; b=TKf7amm7HUnYNidVK0j5G6xAovggIBoFnGs+8adGJPt/iOPrL97SC0rQALDpIh/FAOIX33 UsyLcMKmO9j0z6uZ0HMQABWrC3Ud7VL8MDaDCYiUM3qMTnzYZt3f/rzufLjwWN4lxhC0C9 x7oBI/CxDMabtLHINPCtpfxNHj/RNz3ZrrbQ9r0oLajS8i+EWXOg/7GfFwQbIGnjCTv/1x dTXo4CoEKTFcs88dql/M96mGz1mYG2ala/Mpsn7Rn7X3+5Z9WcCeJppvCHCbfC+o0UYbQK yDpChpArx5cXGs8imFTSPIaUvCUqr0tQmjvTDp+Rcx1slJ7DsTHArm+zupBHrA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1684020690; a=rsa-sha256; cv=none; b=ZtNhOYGxRW77HAsH3yvGxwjqFcU7BJbPvaGCPxkf7fp3Rkcd86SUaoS0CifYQAeI5cUeZr iMkSB6dSLyUNowyEwonHWcQ5A4O1r1cR2CBCubAht1J2wfrvAwz56PWfYBXh/DGO0SuWZP Q0P4yDdzs053GmPvTSj0zVH23z45/uSgLjA6jJ3fNqpPKQ6Fpq9bVc69Ox3P0rJJYKkWkO ooPXmeNTjFLPhI56ma69XyXWtVxNmLu3v0arrbVC61MoJPYQZj58kU3hsUVPSVPw9n4Nh2 cKldfkRJ7s9gBDh3n+0ue/ofxpepmJV1qfJy1H+ydZ3707M6kWBbi13ur2prZA== 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 4QJhjG2N7YzcGp; Sat, 13 May 2023 23:31:30 +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 34DNVUmB004702; Sat, 13 May 2023 23:31:30 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 34DNVU7J004701; Sat, 13 May 2023 23:31:30 GMT (envelope-from git) Date: Sat, 13 May 2023 23:31:30 GMT Message-Id: <202305132331.34DNVU7J004701@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Graham Perrin Subject: git: fae4bec720 - main - FreeBSD Licensing Policy: markup, punctuation 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: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: grahamperrin X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: fae4bec720c3d641187be76c7a77d5499b4962e7 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by grahamperrin: URL: https://cgit.FreeBSD.org/doc/commit/?id=fae4bec720c3d641187be76c7a77d5499b4962e7 commit fae4bec720c3d641187be76c7a77d5499b4962e7 Author: Graham Perrin AuthorDate: 2023-05-13 23:26:12 +0000 Commit: Graham Perrin CommitDate: 2023-05-13 23:26:12 +0000 FreeBSD Licensing Policy: markup, punctuation Partially fix https://bugs.freebsd.org/271399 – make it easier to assess what remains to be changed. PR: 271399 --- documentation/content/en/articles/license-guide/_index.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/documentation/content/en/articles/license-guide/_index.adoc b/documentation/content/en/articles/license-guide/_index.adoc index 248e615ea6..e6d91491dc 100644 --- a/documentation/content/en/articles/license-guide/_index.adoc +++ b/documentation/content/en/articles/license-guide/_index.adoc @@ -211,11 +211,12 @@ For further information see https://spdx.org/ and the following sections for how Entities that contribute fixes and enhancements to the software collection without an explicit license agree to license those changes under the terms that apply to the modified file(s). Project policy, in line with industry practice, only includes a copyright notice from significant contributors to the files in the collection. -There are four types of files in the FreeBSD software collection +There are four types of files in the FreeBSD software collection: + . Files that have only an explicit copyright notice and license. . Files that have both an explicit copyright notice and license, and a SPDX-License-Identifier tag. -. Files that have only a copyright notice and an SPDX-License-Identifier tag, but no explicit license -. Files that lack any copyright or license at all +. Files that have only a copyright notice and an SPDX-License-Identifier tag, but no explicit license. +. Files that lack any copyright or license at all. === Only Copyright and License @@ -252,7 +253,8 @@ When reading the license text that is detached from a file, a number of consider . Any reference to a copyright notice shall refer to the copyright notice constructed from the licensed file, not from any copyright notice in the license text file itself. Many SPDX files have sample copyright notices that are understood to be examples only. . When names of entities are referred to in the license text, they shall be construed to apply to the list of all copyright holders listed in the copyright notices of the licensed file. -For example, the BSD-4-clause license contains the phrase "This product includes software developed by the organization". The phrase 'the organization' should be replaced by the copyright holders. +For example, the BSD-4-clause license contains the phrase "This product includes software developed by the organization". +The phrase 'the organization' should be replaced by the copyright holders. . When the SPDX offers variations of the license, it is understood the license in the [.filename]#LICENSE/# file represents the exact version of the license selected. The SPDX standard exists to match families of licenses and these variations help match similar licenses that the SPDX organization believes to be legally identical.