mk/misc/developer.mk

   1 # $NetBSD: developer.mk,v 1.19 2011/09/15 21:45:52 wiz Exp $
   2 #
   3 # Public targets for developers:
   4 #
   5 # changes-entry-noupdate:
   6 #       Appends a correctly-formatted entry to the pkgsrc CHANGES file,
   7 #       and removes any TODO entries that were completed with this
   8 #       update from the TODO file.
   9 #       The CHANGES and TODO files are presumed to be up to date and writable.
  10 #       Note that the first assumption is often wrong and that the
  11 #       second is wrong for those that set CVSREAD.
  12 #
  13 #       Command-line variables:
  14 #
  15 #       CTYPE
  16 #               The type of entry to add. Must be one of "Added",
  17 #               "Updated", "Renamed" (when the PKGNAME has changed),
  18 #               "Moved" (when the package has a new directory, but the
  19 #               PKGNAME is still the same), or "Removed".
  20 #               The default is "Updated".
  21 #
  22 #       TO
  23 #               When a package is renamed, this is the new name of the
  24 #               package.
  25 #
  26 #       NETBSD_LOGIN_NAME
  27 #               The login name assigned by the NetBSD Project.
  28 #               The default is the local login name.
  29 #
  30 #       PKGSRC_CHANGES
  31 #               The path to the CHANGES file to which the entry
  32 #               is appended.
  33 #               The default is ${PKGSRCDIR}/doc/CHANGES-YYYY.
  34 #
  35 #       PKGSRC_TODO
  36 #               The path to the TODO file from which now possibly
  37 #               obsolete entries are removed
  38 #               The default is ${PKGSRCDIR}/TODO.
  39 #
  40 #       USE_NETBSD_REPO
  41 #               Explicitly use cvs.netbsd.org:/cvsroot for all cvs commands
  42 #               issues by changes-entry and co.
  43 #
  44 #       Example usage:
  45 #               % cd /usr/pkgsrc/category/package
  46 #               % make changes-entry CTYPE=Added
  47 #
  48 # changes-entry:
  49 #       Like changes-entry-noupdate, plus the CHANGES and TODO files
  50 #       are updated, and if not writable, "cvs edit" is done.
  51 #
  52 # commit-changes-entry:
  53 # cce:
  54 #       Like changes-entry, plus the CHANGES and TODO files are committed.
  55 #
  56 # Keywords: commit update add rename changes
  57 #
  58
  59 CTYPE?=                 Updated
  60 NETBSD_LOGIN_NAME?=     ${_NETBSD_LOGIN_NAME_cmd:sh}
  61
  62 PKGSRC_CHANGES_DIR=     ${PKGSRCDIR}/doc/
  63 PKGSRC_CHANGES_BASE=    CHANGES-${_CYEAR_cmd:sh}
  64 PKGSRC_CHANGES?=        ${PKGSRC_CHANGES_DIR}/${PKGSRC_CHANGES_BASE}
  65 PKGSRC_TODO?=           ${PKGSRC_CHANGES_DIR}/TODO
  66
  67 _CYEAR_cmd=             ${DATE} -u +%Y
  68 _CDATE_cmd=             ${DATE} -u +%Y-%m-%d
  69 _NETBSD_LOGIN_NAME_cmd= ${ID} -nu
  70
  71 USE_NETBSD_REPO?=       no
  72
  73 .if !empty(USE_NETBSD_REPO:M[Yy][Ee][Ss])
  74 _NB_CVSROOT=    -d ${NETBSD_LOGIN_NAME:Q}@cvs.NetBSD.org:/cvsroot
  75 .endif
  76
  77 .if !empty(CTYPE:tl:Mup*)                               # updated
  78 _CE_MSG1=       Updated ${PKGPATH} to ${PKGVERSION}
  79 .elif !empty(CTYPE:tl:Mrem*) || !empty(CTYPE:tl:Mrm)    # removed
  80 # XXX Check OLDNAME, and if so add " successor ${OLDNAME}".
  81 _CE_MSG1=       Removed ${PKGPATH}
  82 .elif !empty(CTYPE:tl:Madd*)                            # added
  83 _CE_MSG1=       Added ${PKGPATH} version ${PKGVERSION}
  84 .elif !empty(CTYPE:tl:Mren*) || !empty(CTYPE:tl:Mmov*) || !empty(CTYPE:tl:Mmv)
  85 .  if !defined(TO)
  86 _CE_ERRORS+=    "[developer.mk] The TO variable must be set."
  87 .  elif !exists(${PKGSRCDIR}/${TO})
  88 _CE_ERRORS+=    "[developer.mk] The package directory ${TO} does not exist."
  89 .  endif
  90 .  if !empty(CTYPE:M[Mm]*)
  91 _CE_MSG1=       Moved ${PKGPATH} to ${TO}
  92 .  else
  93 _CE_MSG1=       Renamed ${PKGPATH} to ${TO}
  94 .  endif
  95 .else
  96 _CE_ERRORS+=    "[developer.mk] Invalid value "${CTYPE:Q}" for CTYPE."
  97 .endif
  98 _CE_MSG2=       [${NETBSD_LOGIN_NAME} ${_CDATE_cmd:sh}]
  99 _CE_MSG=        ${_CE_MSG1} ${_CE_MSG2}
 100
 101 # XXX Accumulate commit message during each operation, so that a final
 102 # commit operation will have a sensible message with all of the
 103 # previous operations.
 104
 105 # XXX Fail if uid is 0, or perhaps != CVS meta files owner, to catch
 106 # the case of invoking these targets as root.
 107
 108 # Targets for the update, add, commit elementary operations.
 109 changes-entry-update: .PHONY ce-error-check
 110         @${STEP_MSG} "Updating ${PKGSRC_CHANGES:T} and ${PKGSRC_TODO:T}"
 111         ${RUN} cd ${PKGSRC_CHANGES_DIR} && cvs ${_NB_CVSROOT} update ${PKGSRC_CHANGES:T} ${PKGSRC_TODO:T}
 112         ${RUN} cd ${PKGSRC_CHANGES_DIR} && test -w ${PKGSRC_CHANGES:T} || cvs ${_NB_CVSROOT} edit ${PKGSRC_CHANGES:T}
 113         ${RUN} cd ${PKGSRC_CHANGES_DIR} && test -w ${PKGSRC_TODO:T} || cvs ${_NB_CVSROOT} edit ${PKGSRC_TODO:T}
 114
 115 changes-entry-add: .PHONY ce-error-check
 116         @${STEP_MSG} "Adding the change"
 117         ${RUN} ${ECHO} "        "${_CE_MSG:Q} >> ${PKGSRC_CHANGES}
 118
 119 todo-entry-remove:
 120         ${RUN} PKG_ADMIN=${PKG_ADMIN_CMD:Q} ${SH} ${PKGSRCDIR}/mk/scripts/remove_todo ${PKGSRC_TODO} ${PKGBASE} ${PKGVERSION}
 121
 122 changes-entry-commit: .PHONY ce-error-check
 123         @${STEP_MSG} "Committing the change"
 124         ${RUN} cd ${PKGSRC_CHANGES_DIR} && cvs ${_NB_CVSROOT} commit -m ${_CE_MSG1:Q} ${PKGSRC_CHANGES:T} ${PKGSRC_TODO:T}
 125
 126 ce-error-check: .PHONY
 127 .if defined(_CE_ERRORS) && !empty(_CE_ERRORS:M*)
 128         ${RUN} for msg in ${_CE_ERRORS}; do ${ERROR_MSG} "$$msg"; done; exit 1
 129 .else
 130         @${DO_NADA}
 131 .endif
 132
 133 # Public targets
 134 changes-entry-noupdate: .PHONY ce-error-check changes-entry-add todo-entry-remove
 135         @${DO_NADA}
 136
 137 changes-entry: .PHONY ce-error-check changes-entry-update changes-entry-add todo-entry-remove
 138         @${DO_NADA}
 139
 140 commit-changes-entry cce: .PHONY ce-error-check changes-entry-update changes-entry-add todo-entry-remove changes-entry-commit
 141         @${DO_NADA}