CMake:Module Maintainers: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
(Add myself as maintainer of FindGLEW)
Line 140: Line 140:
* Clement Creusot - creusot at cs dot york dot ac dot uk
* Clement Creusot - creusot at cs dot york dot ac dot uk
** [http://cmake.org/gitweb?p=cmake.git;a=blob;f=Modules/FindArmadillo.cmake FindArmadillo]
** [http://cmake.org/gitweb?p=cmake.git;a=blob;f=Modules/FindArmadillo.cmake FindArmadillo]
* Benjamin Eikel - cmake at eikel dot org
** [http://cmake.org/gitweb?p=cmake.git;a=blob;f=Modules/FindGLEW.cmake FindGLEW]

Revision as of 13:24, 24 September 2012

Introduction

If you want to add a new module to CMake, then you must volunteer to maintain it, or find someone that will. See the Call for maintainers announcement on the mailing list. This page contains a list of Module maintainer volunteers, and instructions on how to become a maintainer.

Please DO NOT ADD a Bug Tracker entry for a new Module request. Instead, volunteer to become a module maintainer. Module maintainers get developer access (see below).

Do not write find modules for packages that themselves build with CMake. Instead provide a CMake package configuration file with the package itself. See our tutorials on CMake Packages.

New Maintainer

Please follow these steps to become a module maintainer:

  1. Read the Modules/readme.txt file documenting module conventions
  2. Create a Mantis account on our issue tracker. Use a meaningful name rather than a handle or alias. We need to be able to assign issues to you when they are related to your module.
  3. Create a CDash account and subscribe to the CMake project to receive notification when your changes may have broken something. In your profile add "Your Name" as it appears in your "git config user.name" as a repository credential.
  4. Subscribe to the CMake Developers Mailing List and introduce yourself and the module. Wait for response, discussion, and acceptance before proceeding to the following steps.
  5. Read our Git instructions. See the account setup instructions to get Git push access. See the development instructions for a workflow summary.
  6. Update the list below to advertise yourself as a contributor.

Compatibility

If you are taking over maintenance of an existing module, please ensure that all changes maintain compatibility:

  • The set of documented output variables such as XXX_INCLUDE_DIRS must be maintained. If you add new output variables that supersede existing ones please document the old names as for compatibility only but still provide them.
  • The set of (un)documented input variables such as XXX_INCLUDE_DIR must be maintained. These variables typically appear as the first argument to commands like find_path which save them in the cache and allow the user to set them on the command line or interactively. Build scripts may set them to convince find modules to pick up the desired location for a package. If you change the way a package is found such that a cache variable is no longer needed, check whether the value is set and use it as a hint for the new approach.

Third-Party Modules

List

  • NOBODY!!! Please volunteer if you are able and willing. Need new maintainers for these modules:
    • Any Find*.cmake module distributed with CMake that is not already listed under a maintainer below.
  • Alan W. Irwin, irwin at beluga dot phys dot uvic dot ca
    • Ada
  • Matt Leotta, matt.leotta at gmail dot com
  • Clinton Stimpson clinton at elemtech dot com
  • Petr Gotthard, petr dot gotthard at honeywell dot com
  • Kovarththanan Rajaratnam, kovarththanan.rajaratnam at gmail dot com
  • James Bigler, nvidia.com - jbigler or jamesbigler - gmail dot com
  • Clement Creusot - creusot at cs dot york dot ac dot uk
  • Benjamin Eikel - cmake at eikel dot org
Retrieved from "https://public.kitware.com/Wiki/index.php?title=CMake:Module_Maintainers&oldid=48842"