Patching Procedures

Last update: April 5, 2024 15:29 UTC (f182ee4f7)

gif

from Alice’s Adventures in Wonderland, Lewis Carroll

The Mad Hatter needs patches.

A distribution so widely used as this one eventually develops numerous barnacles as the result of porting to new systems, idiosyncratic new features and just plain bugs. In order to help keep order and make maintenance bearable, we ask that proposed changes to the distribution be submitted in the following form.

  1. Please submit patches to the Bug Tracker in the form of either unified-diffs (diff -u) or context-diffs (diff -c).

  2. Please include the output from config.guess in the description of your patch. If config.guess does not produce any output for your machine, please fix that, too!

  3. Please base the patch on the root directory of the distribution. The preferred procedure here is to copy your patch to the root directory and mumble

    patch -p <your_patch>

  4. Please avoid patching the RCS subdirectories; better yet, clean them out before submitting patches.

  5. If you have whole new files, as well as patches, wrap the files and patches in a shell script. If you need to compress it, use either GNU gzip or the stock Unix compress utility.

  6. Don’t forget the documentation that may be affected by the patch. Send us patches for the ./htm files as well.

  7. We would be glad to include your name, electric address and descriptive phrase in the Copyright page, if you wish.

Prior to ntp3-5.83 (releases up to and including ntp3.5f) a complete patch history back to the dark ages was kept in the ./patches directory, which might have been helpful to see if the same problem occurred in another port, etc. Patches were saved in that directory with file name in the form patch.nnn, where nnn was approaching 200. All patches in that directory have been made; so, if yours was there, it was in the distribution.

Since we have been getting multiple patches for some bugs, plus many changes are implemented locally, no two maintainers here use the same tools, and since we’re not using any bug-tracking software or even source code control, there is currently no tracking of specific changes.

The best way to see what’s changed between two distributions is to run a diff against them.

Thanks for your contribution and happy chime.