Package checklist

all directories

• files should be -rw-r--r-- or -r--r--r--
• scripts should be -rwxr-xr-x
• directories should be -rwxr-xr-x

toplevel directory

• should contain only the files ChangeLog DEPEND Makefile VERSION DISTRIBUTION.
• DISTRIBUTION should contain one or more of: soc, ssc, world.
• ChangeLog should contain a list of open SPRs including their number.
• ChangeLog should contain a list of SPRs closed in the current release.
• ChangeLog should contain a description of the changes made in the current version. Start a new ChangeLog entry as follows:

  Version M.m.p - yyyy-mm-dd (Initials or name)
-------------
    + some text
    + some other text

  When you refer to an SPR, write SOC-SPR-xxxx or SSC-SPR-xxxx. If it is an SCR, write SAS-SCR-xxxx.

• DEPEND should contain the package names and versions required to build the current package. For instance:

  dal 1.200
cal 3.50
error 1.0


  Given your current SAS environment, you can only state that your package works with the version of the SAS packages that you have available. So you should update DEPEND accordingly.
  You may want to use the script updatedepend. This generates the file DEPEND.new that you should check and then rename DEPEND.

• If the package contains a task, DEPEND must contain taskmain.
• For each library in USEDLIBS statements in all Makefiles in the package, the corresponding package should be listed in DEPEND.
• Makefile should only contain a SUBDIRS and include $(SAS_DIR)/Make.include.
• should contain a subdir doc, src and test; others are allowed. If it is a task, should contain a subdir config.

config directory (only for tasks)

• should contain a Makefile that says CONFIGFILES=task.par.
• should contain a file task.par with a syntax as described in the documentation of packages param.
• There should not be a mode parameter.
• Prompt should not end in ": " or "?" or ".".
• File parameters should be type f.

doc directory

• should contain task_description.tex.
• Makefile should contain TEXDOCS=task.
• task_description.tex should closely follow the template created with the SAS task pkgmaker.

  src directory

  • There should be a Makefile and .cc and/or .f90 files.
  • The Makefile should contain (again, use what is generated by pkgmaker)
  • LIBS= and/or TASKS=
  • USEDLIBS=
  • _OBJS for all libs and tasks
  and nothing else.
  • For each entry in USEDLIBS the corresponding package should be listed in the DEPEND file
  • .f90 and .cc files should have a header stating the author, the file name, a copyright and a description.
  • .cc code should not contain a main program.
  • the task should do some scientific processing, not just dummy.
  • .f90 files should be a module.
  • each module should contain implicit none.
  • Variables and procedures should be lowerAndWordCapitalised.
  • Variable names should be meaningful (not x xx a aa aaa etc).
  • error codes should be unique and simple.
  • when using errstr, provide only the error code to the successive call to warning/error/fatal.

  test directory

  • Should contain a Makefile with non-empty TESTS=.
  • Should run the task.
  • Should verify the output, for example from a simple input.
  • Should test a few different inputs (e.g. options or input files).
  • Should exit with a non-zero exit status in case of an error.
  • Should not be sensitive to irrelevant changes in the output such as comments or added keywords.
  • Temporary files should be in CLEANFILES= in the Makefile.
  • The total size of the test files should not be more than about 200k.

  other subdirectories

  • If it is a source directory do the src check, if a test directory do the test checks, if a doc directory do the doc checks.
  • No directory should contain a mix of docs, tests and/or code.

  ---

  Updated on: January 16, 2001