From owner-dev-commits-doc-all@freebsd.org Mon May 10 08:30:59 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 86268630568 for ; Mon, 10 May 2021 08:30: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 4FdvQW3SBjz4sg6; Mon, 10 May 2021 08:30:59 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 5FF7D214BA; Mon, 10 May 2021 08:30:59 +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 14A8Ux8U012733; Mon, 10 May 2021 08:30:59 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 14A8UxYO012732; Mon, 10 May 2021 08:30:59 GMT (envelope-from git) Date: Mon, 10 May 2021 08:30:59 GMT Message-Id: <202105100830.14A8UxYO012732@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mathieu Arnold Subject: git: 28ad557ef6 - main - phb: Change instructions for new ports. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mat X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 28ad557ef678b8029c3a1a554a8790dc24a0f75c Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 10 May 2021 08:30:59 -0000 The branch main has been updated by mat: URL: https://cgit.FreeBSD.org/doc/commit/?id=28ad557ef678b8029c3a1a554a8790dc24a0f75c commit 28ad557ef678b8029c3a1a554a8790dc24a0f75c Author: Mathieu Arnold AuthorDate: 2021-05-10 08:30:31 +0000 Commit: Mathieu Arnold CommitDate: 2021-05-10 08:30:31 +0000 phb: Change instructions for new ports. --- .../en/articles/committers-guide/_index.adoc | 26 +++++++++++++--------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 9930532c42..5dff0376eb 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -3442,7 +3442,20 @@ When sending questions about this script to the {freebsd-ports}, please also CC ==== Any other things I need to know when I add a new port? Check the port, preferably to make sure it compiles and packages correctly. -This is the recommended sequence: + +The link:{porters-handbook}testing[Porters Handbook's Testing Chapter] contains more detailed instructions. +See the link:{porters-handbook}testing#testing-portclippy[Portclippy / Portfmt] and the link:{porters-handbook}testing#testing-poudriere[Poudriere] sections. + +You do not necessarily have to eliminate all warnings but make sure you have fixed the simple ones. + +If the port came from a submitter who has not contributed to the Project before, add that person's name to the link:{contributors}#contrib-additional[Additional Contributors] section of the FreeBSD Contributors List. + +Close the PR if the port came in as a PR. +To close a PR, change the state to `Issue Resolved` and the resolution as `Fixed`. + +[NOTE] +==== +If for some reason using link:{porters-handbook}testing#testing-poudriere[Poudriere] to test the new port is not possible, the bare minimum of testing includes this sequence: [source,shell] .... @@ -3455,15 +3468,8 @@ This is the recommended sequence: # make package .... -The link:{porters-handbook}[Porters Handbook] contains more detailed instructions. - -Use man:portlint[1] to check the syntax of the port. -You do not necessarily have to eliminate all warnings but make sure you have fixed the simple ones. - -If the port came from a submitter who has not contributed to the Project before, add that person's name to the link:{contributors}#contrib-additional[Additional Contributors] section of the FreeBSD Contributors List. - -Close the PR if the port came in as a PR. -To close a PR, change the state to `Issue Resolved` and the resolution as `Fixed`. +Note that poudriere is the reference for package building, it the port does not build in poudriere, it will be removed. +==== [[ports-qa-removing]] === Removing an Existing Port