11.2. UPDATING and MOVED

11.2. `UPDATING` and `MOVED`
Prev	Chapter 11. Upgrading a Port	Next

11.2. `UPDATING` and `MOVED`

11.2.1. `/usr/ports/UPDATING`

If upgrading the port requires special steps like changing configuration files or running a specific program, it must be documented in this file. The format of an entry in this file is:

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

  Special instructions

Tip:

When including exact portmaster, portupgrade, and/or pkg instructions, please make sure to get the shell escaping right. For example, do not use:

# pkg delete -g -f docbook-xml* docbook-sk* docbook[2345]??-* docbook-4*

As shown, the command will only work with bourne shells. Instead, use the form shown below, which will work with both bourne shell and c-shell:

# pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*

Note:

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 must be users of dns/bind9*, it must not be users of BIND 9

11.2.2. `/usr/ports/MOVED`

This 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, when, and why. If the port was removed, the section detailing where it was moved 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 must be entered in the form YYYY-MM-DD. New entries are added to the end of the list to keep it in chronological order, with the oldest entry at the top of the list.

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, add a new one with the intermediate name to the old name, and remove the old entry as to not create a loop.

Note:

Any changes must be validated with Tools/scripts/MOVEDlint.awk.

If using a ports directory other than /usr/ports, use:

% cd /home/user/ports
% env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk