Changeset View
Changeset View
Standalone View
Standalone View
documentation/content/en/articles/committers-guide/_index.adoc
| Show First 20 Lines • Show All 664 Lines • ▼ Show 20 Lines | |||||||||
| The cgit repository web interface for use with web browsers is at https://cgit.FreeBSD.org/ports/ . | The cgit repository web interface for use with web browsers is at https://cgit.FreeBSD.org/ports/ . | ||||||||
| The production Git repository is at https://git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or anongit@git.FreeBSD.org:ports.git). | The production Git repository is at https://git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or anongit@git.FreeBSD.org:ports.git). | ||||||||
| There is also a mirror on GitHub, see extref:{handbook}/mirrors[External mirrors, mirrors] for an overview. | There is also a mirror on GitHub, see extref:{handbook}/mirrors[External mirrors, mirrors] for an overview. | ||||||||
| The 'current' branch is 'main' . | The 'current' branch is 'main' . | ||||||||
| The quarterly branches are named 'yyyyQn' for year 'yyyy' and quarter 'n'. | The quarterly branches are named 'yyyyQn' for year 'yyyy' and quarter 'n'. | ||||||||
| [[port-commit-message-formats]] | |||||||||
| ===== 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]. | 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]. | ||||||||
| It can be enabled by running ``git config --add core.hooksPath .hooks``. | It can be enabled by running ``git config --add core.hooksPath .hooks``. | ||||||||
| The main point being that a commit message should be formatted in the following way: | The main point being that a commit message should be formatted in the following way: | ||||||||
| .... | .... | ||||||||
| ▲ Show 20 Lines • Show All 2,980 Lines • ▼ Show 20 Lines | |||||||||
| == Ports Specific FAQ | == Ports Specific FAQ | ||||||||
| [[ports-qa-adding]] | [[ports-qa-adding]] | ||||||||
| === Adding a New Port | === Adding a New Port | ||||||||
| [[ports-qa-add-new]] | [[ports-qa-add-new]] | ||||||||
| ==== How do I add a new port? | ==== 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: | |||||||||
0mpUnsubmitted Done Inline Actions
0mp: 1. Please keep one sentence per line.
2. Use backticks around SUBDIR. | |||||||||
| The easiest way to add a new port is the `addport` script located in the [.filename]#ports/Tools/scripts# directory. | [.programlisting] | ||||||||
| 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#. | SUBDIR += newport | ||||||||
| 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. | |||||||||
| 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#. | |||||||||
Done Inline Actions
pauamma_gundo.com: https://webaim.org/techniques/hypertext/#alpha_links | |||||||||
Done Inline ActionsMissing dot at the end. 0mp: Missing dot at the end. | |||||||||
| ==== | |||||||||
| [[ports-qa-add-new-extra]] | [[ports-qa-add-new-extra]] | ||||||||
| ==== Any other things I need to know when I add a new port? | ==== 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. | Check the port, preferably to make sure it compiles and packages correctly. | ||||||||
| The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] contains more detailed instructions. | The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] contains more detailed instructions. | ||||||||
| See the extref:{porters-handbook}testing[Portclippy / Portfmt, testing-portclippy] and the extref:{porters-handbook}testing[Poudriere, testing-poudriere] sections. | See the extref:{porters-handbook}testing[Portclippy / Portfmt, testing-portclippy] and the extref:{porters-handbook}testing[Poudriere, testing-poudriere] sections. | ||||||||
| ▲ Show 20 Lines • Show All 308 Lines • Show Last 20 Lines | |||||||||