describe-module

Purpose
Print information about a module.

Package   :module-manager

Module   :module-manager

Arguments and values

Errors
Module module-name has not been defined.
A relative directory specification contains a circularity.

Description
The description is printed to the *standard-output* stream.

Files and patch files shown with an asterisk following their load time indicate that the source file has been modified since that file was loaded.

See also
    define-module

Examples
Describe the :gbbopen-test module before it has been loaded:

  > (describe-module :gbbopen-test)
  Module :gbbopen-test (not loaded)
    Requires: (:gbbopen-user)
    Fully expanded requires: (:module-manager :module-manager-user :portable-threads
                              :gbbopen-tools :gbbopen-core :os-interface :gbbopen-user)
    Source directory: <install-dir>/source/gbbopen/test/
    Compiled directory: <install-dir>/<platform-dir>/gbbopen/test/
    Forces recompile date: None
    Files:                 basic-tests (:reload)
    Patches:               basic-tests-p001 
                           basic-tests-p002 (:developing)
  >

Describe the :gbbopen-test module after it has been loaded:

  > (describe-module :gbbopen-test)
  Module :gbbopen-test (loaded)
    Requires: (:gbbopen-user)
    Fully expanded requires: (:module-manager :module-manager-user :portable-threads
                              :gbbopen-tools :gbbopen-core :os-interface :gbbopen-user)
    Source directory: <install-dir>/source/gbbopen/test/
    Compiled directory: <install-dir>/<platform-dir>/gbbopen/test/
    Forces recompile date: None
    Files:   Jun 27 05:22  basic-tests (:reload)
    Patches: Jun 27 05:22  basic-tests-p001 
             Jun 27 05:22* basic-tests-p002 (:developing)
  >

describe-module