git: e1f62cbb8d - main - Committers-guide port section: remove addport
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Mon, 09 May 2022 09:04:25 UTC
The branch main has been updated by pizzamig (ports committer): URL: https://cgit.FreeBSD.org/doc/commit/?id=e1f62cbb8da6f1f70013559d83d76d1458d39ce7 commit e1f62cbb8da6f1f70013559d83d76d1458d39ce7 Author: Luca Pizzamiglio <pizzamig@FreeBSD.org> AuthorDate: 2022-05-09 08:54:54 +0000 Commit: Luca Pizzamiglio <pizzamig@FreeBSD.org> 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 <<ports-qa-add-new-extra,here>>, 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 <<port-commit-message-formats,setup git hooks for the ports tree as explained here>>; 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?