OpenBSD Porting Checklist

=================================================================== RCS file: /cvsrepo/anoncvs/cvs/www/Attic/checklist.html,v retrieving revision 1.44 retrieving revision 1.45 diff -c -r1.44 -r1.45 *** www/Attic/checklist.html 2002/07/06 09:32:07 1.44 --- www/Attic/checklist.html 2002/11/19 22:02:19 1.45 *************** *** 9,15 **** OpenBSD Porting Checklist !

--- 9,15 ---- OpenBSD Porting Checklist !

*************** *** 18,25 **** This document describes how to make or upgrade a port. It is a useful reminder of things to do. This is neither totally accurate nor perfect. ! Direct comments and questions to ! ports@openbsd.org .

! ports@openbsd.org

Check out a copy of the ports tree from cvs. You can find instructions on how to do this at --- 41,47 ---- It also means trying to keep them up-to-date, and to answer questions about them. !
Check out a copy of the ports tree from cvs. You can find instructions on how to do this at
*************** *** 51,67 **** Pick a place to put your port and create the basic infrastructure there. Use the template Makefile at /usr/ports/infrastructure/templates/Makefile.template. - -
NEED_VERSION is obsolete and should not be used in new ports. As you are a port developer, you are supposed to update your ports tree, including bsd.port.mk. -
-
- Create the directories patches, pkg.
- ! Create these empty files pkg/DESCR, pkg/PLIST
--- 51,63 ---- Pick a place to put your port and create the basic infrastructure there. Use the template Makefile at /usr/ports/infrastructure/templates/Makefile.template. NEED_VERSION is obsolete and should not be used in new ports. As you are a port developer, you are supposed to update your ports tree, including bsd.port.mk.
- Create the directories patches, pkg.
- ! Create the empty files pkg/DESCR, pkg/PLIST.
*************** *** 70,80 **** Fill in EXTRACT_SUFX if it's anything besides .tar.gz. Other examples are .tar.Z, or .tgz.
! Fill in DISTNAME which is the name of the file minus the extract suffix. E.g. if you have foo-1.0.tar.gz, DISTNAME is foo-1.0.
Fill in MASTER_SITES which is a URL to the directory where the distfile ! is kept. E.g. ftp://ftp.openbsd.org/pub/OpenBSD/distfiles/ . Don't forget ! the trailing slash. Try to have at least three distinct sites as well. Place the most easily accessible first as they are traversed in order.
Keep in mind that fetch references the file as --- 66,78 ---- Fill in EXTRACT_SUFX if it's anything besides .tar.gz. Other examples are .tar.Z, or .tgz.
! Fill in DISTNAME which is the name of the file minus the extract suffix. ! E.g., if you have foo-1.0.tar.gz, DISTNAME is foo-1.0.
Fill in MASTER_SITES which is a URL to the directory where the distfile ! is kept. E.g., ftp://ftp.openbsd.org/pub/OpenBSD/distfiles/. ! Don't forget the trailing slash. ! Try to have at least three distinct sites as well. Place the most easily accessible first as they are traversed in order.
Keep in mind that fetch references the file as *************** *** 82,88 **** set DISTNAME to point to the file directly.
You can check to see if you have filled these values in correctly by typing ! make fetch-all
For more complex ports, you have more options and tools available to you: --- 80,86 ---- set DISTNAME to point to the file directly.
You can check to see if you have filled these values in correctly by typing ! make fetch-all.
For more complex ports, you have more options and tools available to you: *************** *** 121,127 ****
Create a checksum in distinfo by typing make makesum. ! Then verify the checksum is correct by typing make checksum
- In some rare cases, files checksums can't be verified reliably. By all means, porters should try to find sites that are reliable. Communicating with the software author and the archive site maintainer at this stage is highly desirable. In the worst case, non-checksummable files can be --- 119,125 ----
- Create a checksum in distinfo by typing make makesum. ! Then verify the checksum is correct by typing make checksum.
  - In some rare cases, files checksums can't be verified reliably. By all means, porters should try to find sites that are reliable. Communicating with the software author and the archive site maintainer at this stage is highly desirable. In the worst case, non-checksummable files can be *************** *** 159,168 **** PERMIT_DISTFILES_CDROM tells us if we can mirror the distfiles on the cdrom.
  - PERMIT_DISTFILES_FTP tells us if we can mirror the distfiles on the ftp sites. !
  Set these values to Yes if it is permitted or to a comment string stating why it is not. Pay attention to any special conditions you may need to fulfill ! later on. E.g. some ports require to install a copy of the license. We recommend you place the license in /usr/local/share/DISTNAME/.
- --- 157,167 ---- PERMIT_DISTFILES_CDROM tells us if we can mirror the distfiles on the cdrom.
- PERMIT_DISTFILES_FTP tells us if we can mirror the distfiles on the ftp sites. !
!
Set these values to Yes if it is permitted or to a comment string stating why it is not. Pay attention to any special conditions you may need to fulfill ! later on. E.g., some ports require to install a copy of the license. We recommend you place the license in /usr/local/share/DISTNAME/.
*************** *** 227,233 ****
! Try setting SEPARATE_BUILD
- If the port can build with object files outside its source tree, this is cleaner (many programs using CONFIGURE_STYLE=gnu can), --- 226,232 ----
! Try setting SEPARATE_BUILD.
- ! Install the application with make install. If the port installs dynamic libraries, check their symbol tables with nm, as some mistaken software strips dynamic libraries, which may lead to weird failures later. On the other hand, executable binaries *************** *** 347,356 **** This file is a candidate packing list.
  Beware! The files are found by timestamp. This means it does NOT: !
  !
  list any files installed with `tar' as their timestamp ! will not change and thus won't be found by `find'
  Update the info/dir file if .info files are added. Also, be sure that the info/dir is not part of the PLIST. --- 344,352 ---- This file is a candidate packing list.
  Beware! The files are found by timestamp. This means it does NOT: !
  list any files installed with `tar' as their timestamp ! will not change and thus won't be found by `find'.
  Update the info/dir file if .info files are added. Also, be sure that the info/dir is not part of the PLIST. *************** *** 366,374 **** can be added to a port Makefile `post-install' rule.
  ! Ports that install shared libraries will have another file called PFRAG.shared. !
  !
  PLIST describes the files being independent of whether the architecture supports shared libraries or not.
  PFRAG.shared describes only the files being additionally installed on those architectures that support --- 362,369 ---- can be added to a port Makefile `post-install' rule.
  ! Ports that install shared libraries will have another file called PFRAG.shared. !
  PLIST describes the files being independent of whether the architecture supports shared libraries or not.
  PFRAG.shared describes only the files being additionally installed on those architectures that support *************** *** 379,395 ****
  
  ! Keep repeating uninstall and reinstall until perfect.
  Perfect is when everything installs and uninstalls in its proper location. `pkg_delete <pkg_name>' is used to uninstall. `sudo make reinstall' is used to reinstall. See the `pkg_create' man page for other commands that may be added ! to PLIST to ensure all is cleaned up. After an uninstall the command !
  find /usr/local -newer w-${PKGNAME}${FLAVOR_EXT}/fake-${MACHINE_ARCH}[-${FLAVOR}]/.install_started -print !
  should only list standard directory names.
  
  ! Test the packaging:
  After the port installs correctly issue the command make package to create a package. To test the package first do a pkg_delete and then do a --- 374,392 ----
  
  ! Keep repeating uninstall and reinstall until perfect. Perfect is when everything installs and uninstalls in its proper location. `pkg_delete <pkg_name>' is used to uninstall. `sudo make reinstall' is used to reinstall. See the `pkg_create' man page for other commands that may be added ! to PLIST to ensure all is cleaned up. After an uninstall the command: !
  ! $ find /usr/local -newer w-${PKGNAME}${FLAVOR_EXT}/fake-${MACHINE_ARCH}[-${FLAVOR}]/.install_started -print !
  ! should only list standard directory names.
  
  ! Test the packaging. After the port installs correctly issue the command make package to create a package. To test the package first do a pkg_delete and then do a *************** *** 404,414 **** Try to get others to test it on a variety of platforms for you.
  The DEC Alpha is good because it has only static libraries and because ! sizeof(int) != sizeof(long)
  Sun SPARC is good because it is very common and because its byte order is the reverse of i386; if you developed on SPARC, of course, you'd want it ! tested on i386).
  
  --- 401,411 ---- Try to get others to test it on a variety of platforms for you.
  The DEC Alpha is good because it has only static libraries and because ! sizeof(int) != sizeof(long).
  Sun SPARC is good because it is very common and because its byte order is the reverse of i386; if you developed on SPARC, of course, you'd want it ! tested on i386.
  
  *************** *** 417,423 ****
  
  Finally, include it in the "ports" tree. -
  If you do not have CVS access, ask someone on ports@openbsd.org to commit it. --- 414,419 ---- *************** *** 434,442 **** files, and the normal edit->commit cycle for changes. You might use something like this:
  ! cd kaffe1 ! make clean # you really really don't want to check in all of work! ! cvs -d cvs.openbsd.org:/cvs import -m 'kaffe port' ports/lang/kaffe1 \ YourName YourName_YYYY-MMM-DD
  
  --- 430,438 ---- files, and the normal edit->commit cycle for changes. You might use something like this:
  ! $ cd kaffe1 ! $ make clean # you really really don't want to check in all of work! ! $ cvs -d cvs.openbsd.org:/cvs import -m 'kaffe port' ports/lang/kaffe1 \ YourName YourName_YYYY-MMM-DD
  
  *************** *** 447,458 ****
  ports/lang/kaffe1 is the path relative to /cvs where the port lives
  ! YourName (replaced with your login name) is the "vendor tag". You imported it so you are the vendor.
  YourName_YYYY-MMM-DD (e.g., ian_2000-Jan-01) is the 'vendor release tag'. This is as good as any.
  As a real example, here is the output of checking in the Kaffe1 port, which one of us did on September 8, 1998:
  --- 443,455 ----
  ports/lang/kaffe1 is the path relative to /cvs where the port lives
  ! YourName (replaced with your login name) is the 'vendor tag'. You imported it so you are the vendor.
  YourName_YYYY-MMM-DD (e.g., ian_2000-Jan-01) is the 'vendor release tag'. This is as good as any.
  +
  As a real example, here is the output of checking in the Kaffe1 port, which one of us did on September 8, 1998:
  *************** *** 477,483 ****
  Last but not least, add a one-line entry for the new port ! in its parent directory's Makefile, i.e., for ports/lang/kaffe1, add it to ports/lang/Makefile.
  
  --- 474,480 ----
  Last but not least, add a one-line entry for the new port ! in its parent directory's Makefile, e.g., for ports/lang/kaffe1, add it to ports/lang/Makefile.
  
  *************** *** 485,491 **** of the software may be released. You should strive to keep your port up to date. In other words - iterate, test, test, iterate... !
  When updating a port, remember to handle dependencies! You shouldn't break any port that depends on yours. In case of problems, communicate with the maintainers of such ports. Likewise, be alert for dependency updates, and --- 482,488 ---- of the software may be released. You should strive to keep your port up to date. In other words - iterate, test, test, iterate... !
  
  When updating a port, remember to handle dependencies! You shouldn't break any port that depends on yours. In case of problems, communicate with the maintainers of such ports. Likewise, be alert for dependency updates, and *************** *** 497,502 **** www@openbsd.org !
  $OpenBSD: checklist.html,v 1.44 2002/07/06 09:32:07 pvalchev Exp $ --- 494,499 ---- www@openbsd.org !
  $OpenBSD: checklist.html,v 1.45 2002/11/19 22:02:19 jsyn Exp $