FreeBSD Porter's Handbook
Prev | Chapter 10 Upgrading an Individual Port | Next

# 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:

    YYYYMMDD:
      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.

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 end of the file to keep it in chronological order.

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

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

Prev | Home | Next
Upgrading an Individual Port | Up | Ports Security

For questions about the FreeBSD ports system, e-mail <ports@FreeBSD.org>.
For questions about this documentation, e-mail <doc@FreeBSD.org>.