10.2. The Files UPDATING and MOVED

If upgrading the port requires special steps like changing configuration files or running a specific program, you should document this in the file /usr/ports/UPDATING. The format of an entry in this file is as follows:

  AFFECTS: users of portcategory/portname
  AUTHOR: Your name <Your email address>

  Special instructions

If you are including exact portmaster or portupgrading instructions, please make sure to get the shell escaping right.


It is recommended that the AFFECTS line contains a glob matching all the ports affected by the entry so that automated tools can parse it as easily as possible. If an update concerns all the existing BIND 9 versions the AFFECTS content should be users of dns/bind9*, it should not be users of BIND 9

The /usr/ports/MOVED file is used to list moved or removed ports. Each line in the file is made up of the name of the port, where the port was moved to, when, and why. If the port was removed, the section detailing where it was moved to can be left blank. Each section must be separated by the | (pipe) character, like so:

old name|new name (blank for deleted)|date of move|reason

The date should be entered in the form YYYY-MM-DD. New entries should be added to the top of the file to keep it in reverse chronological order (the latest entries first).

If a port was removed but has since been restored, delete the line in this file that states that it was removed.

If a port was renamed and then renamed back to its original name, you should add a new one with the intermediate name to the old name, and remove the old entry as to not create a loop.

The changes can be validated with Tools/scripts/MOVEDlint.awk.

All FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/

Questions that are not answered by the documentation may be sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.