From nobody Mon May 09 09:04:25 2022 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 CF6E11AD9A4B for ; Mon, 9 May 2022 09:04:25 +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 4KxZx55VJVz4mNQ; Mon, 9 May 2022 09:04:25 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1652087065; 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=HGwqLMehXErNuWGaZBehklu9+CREpHOtDztmETuLBBI=; b=EL/+tHMJW1CS8uXqWzeN6KJCh5ZkB8wbySXQOemGylsYyRvyohNpQKFstHL6XuOFNTv7Kh hNb8nENeFQ41mEJl1RPdMDR/1ANJc5HYxnVOLlUGuPAG13ihI44DVETlVBhp5PO0XJfWHa RqFaoHtd+blGmEOTjSZ9LATQ00WJSEQyxsTfkDwttiNtjNTGApYAP76mpejbMWi3AFfda8 O5AvCwLn9Ufjz2HH4Mk697pvi0rJlsysbupX07IHqesgaQT07M5AOjeoSXAiXQHdfic4jF Fu38BqBj7zdcM7pqWjHLNIwbk7MbaEq8lK6n1wOa63XHsrvKuPkfqZnsY4yZbw== 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 990315FBD; Mon, 9 May 2022 09:04:25 +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 24994PZx048819; Mon, 9 May 2022 09:04:25 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 24994PmC048818; Mon, 9 May 2022 09:04:25 GMT (envelope-from git) Date: Mon, 9 May 2022 09:04:25 GMT Message-Id: <202205090904.24994PmC048818@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Luca Pizzamiglio Subject: git: e1f62cbb8d - main - Committers-guide port section: remove addport 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: pizzamig X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: e1f62cbb8da6f1f70013559d83d76d1458d39ce7 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1652087065; 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=HGwqLMehXErNuWGaZBehklu9+CREpHOtDztmETuLBBI=; b=rrAWN0bjEf3Ao6E9qT4kDrld6Y7vZdfGYzdaPW91oOABtQqe7nOUpv4nxuG8lNPNuKSsdt 0HMn+T2zdZd1XOrWQmMMWkwyHpcnAe6c71Wju1rSWGXTBTaMDKrhSrWZpwBluFFA025bDt 8p4V8vrVLUavKUiVO/fEiGMwl6rnln+xpbWLz6ExG33vvcMNBIuHuv/wmHghmVWDBceDwM LPMS3+2xWzsLXJrvsfuQ+bNyVQCv+oVKZxvARuRIDnu88t1S7aT3tBEDas2LArDHsNnvmC 0F9m2ChhTaW91uyFPRvWlPnUgnh5YMJsBhKKa6SRYv57W4dIhA4hdtPKYjm1og== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1652087065; a=rsa-sha256; cv=none; b=rWhBJzoNFRVeh+khGb9PDZLr50Nx6ieLfuGzdHlOUThzYezeR4qLahWJU+cepeDQXYdaMC FJMb+7txuTbaP16UaXFshG2K/ZLKUMUA2uyN5s16L6Bd0L5X8fa3gsmmR89PCwsOX1JR26 QxWLP/OyOfXdMS0rkZ89qSVHS7HIcJkhYB/ZRXXgdd9uO8Ko4r0K7q8BIDOQK8ztgNJ+4d JA2TPk3u5cuQj2HFD/WIKe8axKnpat9A8mnCFN8TfajcPI/1fWA+ehimcAPHB2yC7pTJWB d8HFLmwgxOvvfHu6v55kxCJWUmHjzWZA53J0tjUezQOJp+Nfb4e5Ej95mdDuuw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by pizzamig (ports committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=e1f62cbb8da6f1f70013559d83d76d1458d39ce7 commit e1f62cbb8da6f1f70013559d83d76d1458d39ce7 Author: Luca Pizzamiglio AuthorDate: 2022-05-09 08:54:54 +0000 Commit: Luca Pizzamiglio CommitDate: 2022-05-09 08:54:54 +0000 Committers-guide port section: remove addport Summary: The script addport is not working anymore, it's based on SVN and it's quite hard to port it to git. Before its removal, we want to remove its references in the documentation. Related bugzilla entry: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261378 Reviewers: tcberner, se Differential Revision: https://reviews.freebsd.org/D35071 --- .../en/articles/committers-guide/_index.adoc | 25 ++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 07465d5f81..7b61b2a9f0 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -670,6 +670,7 @@ There is also a mirror on GitHub, see extref:{handbook}/mirrors[External mirrors The 'current' branch is 'main' . The quarterly branches are named 'yyyyQn' for year 'yyyy' and quarter 'n'. +[[port-commit-message-formats]] ===== Commit message formats A hook is available in the ports repository to help you write up your commit messages in https://cgit.freebsd.org/ports/tree/.hooks/prepare-commit-msg[.hooks/prepare-commit-message]. @@ -3666,13 +3667,25 @@ For a platform to be promoted to a higher tier, any missing support guarantees m [[ports-qa-add-new]] ==== How do I add a new port? -First, please read the section about repository copies. +Adding a port to the tree is relatively simple. Once the port is ready to be added, as explained later <>, you need to add the port's directory entry in the category's [.filename]#Makefile#. +In this [.filename]#Makefile#, ports are listed in alphabetical order and added to the `SUBDIR` variable, like this: -The easiest way to add a new port is the `addport` script located in the [.filename]#ports/Tools/scripts# directory. -It adds a port from the directory specified, determining the category automatically from the port [.filename]#Makefile#. -It also adds an entry to the port's category [.filename]#Makefile#. -It was written by `{mharo}`, `{will}`, and `{garga}`. -When sending questions about this script to the {freebsd-ports}, please also CC `{crees}`, the current maintainer. +[.programlisting] +.... + SUBDIR += newport +.... + +Once the port and its category's Makefile are ready, the new port can be committed: +[source,shell] +.... +% git add category/Makefile category/newport +% git commit +% git push +.... +[TIP] +==== +Don't forget to <>; a specific hook has been developed to verify the category's [.filename]#Makefile#. +==== [[ports-qa-add-new-extra]] ==== Any other things I need to know when I add a new port?