FreeBSD Ports: Managing Custom Ports/Physical Categories
Managing Custom Ports/Physical Categories
This post describes a method of managing custom FreeBSD Ports involving creating a directory (a.k.a. a physical category) of subdirectories; Each an individual port containing necessary files, e.g. Makefile, etc.
I found this process, documented in the FreeBSD Committer’s Guide, to be confusing as the answer provided does not directly address the question. It describes moving a port as opposed to creating a new category/port, but it does encompass this process. Therefore, the answer is unclear and contains superfluous information.
We simplify the instructions for creating physical categories to augment the instructions for moving a Port. I assume the reader has previously prepared a port which exists on disk. Creating a port and working with version control systems is beyond the scope of this post.
Please bear in mind, My Git-fu is rudimentary at best. If others, more knowledgeable in this area, can comment on other ways to accomplish the same, please do.
The Use Case
Engineers and administrators deploying custom software may wish to build and distribute packages for these applications via FreeBSD’s Ports system. There are two options for using Ports; We will be addressing the latter in this post:
- Submit to the official FreeBSD Ports collection
- Create an internal custom Ports collection
We start by cloning FreeBSD Ports from GitHub and pulling a customized Ports collection (maintained internally) into our local FreeBSD Ports repository. We’ll finish by describing the process for pulling updates into the custom tree from each of the two repos.
Creating The Repo
- git clone https://www.github.com/freebsd/freebsd-ports.git
- cd freebsd-ports
- git remote add repo /path/to/local/repo
- git pull repo master
- cd $new_physical_category/$custom_port && make describe (optional, reports errors if they exist)
- run portlint on the port (Verifies correct state of Port)
- env PORTSDIR=/path/to/ports sh -e /path/to/ports/Tools/scripts/chkorigin.sh
- cd /path/to/combined/ports_tree && make checksubdirs && make index
Updating the Repo
- cd /path/to/local/freebsd-ports/clone
- git pull origin
- git pull repo master
If new physical categories and/or ports are added to the internal repo, steps 5 – 8 above need to be executed. Other changes may or may not require this.
This procedure creates a combined Ports collection from two sources, FreeBSD’s official Ports collection and a private collection. Once completed, normal operations can be performed on the resulting Ports tree as necessary such as installing applications or creating packages, etc.
One use of this repo is to commit to git and tag each commit as a new version of the custom Ports collection thus making them easily recallable.
Data and information described on this blog are for informational purposes only. The author of this blog provides no warranty/guarantee, expressed or implied, that this data and information will function as described here. Readers are expected to exercise due diligence when researching, developing, and deploying techniques and methods for use within their environments.
Comments posted are the explicit opinions of the comment poster themselves and does not necessarily reflect the views and opinions of the author of this blog.