Commit Graph

26 Commits

Author SHA1 Message Date
Brad King 7038a93a7e Modules/readme.txt: Update steps to add module documentation
Replace the old module documentation instructions with steps to add
reStructuredText documentation that will be built by Sphinx.
2013-10-16 09:22:39 -04:00
Alex Neundorf 5479251b3b Modules/readme.txt: make lines a bit shorter for easier readability
This patch doesn't make them 79 characters long, but at least gets rid
of really long lines.  While at it, fix spelling of "relevant".

Alex
2013-03-28 10:39:14 -04:00
Alex Neundorf 140692d84c Modules/readme.txt: switch from "XXX" to "Xxx"
Using XXX as name of the package is ambiguous, since it can be
interpreted as "ALLUPPERCASE" and also as "ExactCase (if the name
is already ALLUPPERCASE)".
After extensive discussion there is the conclusion that ExactCase
is intended, so using a CamelCased name makes that more obvious.

Alex
2013-03-28 10:38:49 -04:00
Alex Neundorf e2b1630830 Document CMAKE_FIND_PACKAGE_NAME
Alex
2012-10-04 21:54:40 +02:00
Alex Neundorf ae4ab62569 find_package: add support for a <package>_NOT_FOUND_MESSAGE variable
If a config-file sets <package>_FOUND to FALSE, it can now give a reason
using the variable <package>_NOT_FOUND_MESSAGE, which is used by cmFindPackage
and FPHSA.

Alex
2012-09-28 09:21:36 -04:00
Alex Neundorf 6508a8c804 Modules/readme.txt: fix typo
Alex
2012-09-28 09:20:38 -04:00
Alex Neundorf 34108cd3b3 find_package: add documentation for OPTIONAL_COMPONENTS
This patch adds documentation for OPTIONAL_COMPONENTS to cmFindPackage.cxx,
and also extends Modules/readme.txt significantly with regard to how
components should be handled.

Alex
2012-03-19 10:53:36 -04:00
Brad King ede46d9d91 Modules: Add comment and copyright notice validation to readme.txt
Document for module authors how to format the copyright notice and
test it.  Also provide a hint for previewing the module documentation
formatting.
2011-04-01 13:46:36 -04:00
Kovarththanan Rajaratnam f233a9b3af Remove spurious tabs 2010-04-09 22:02:16 +02:00
Mathieu Malaterre 59ce04d4f8 STYLE: minor documentation + typo 2009-11-02 11:50:33 -05:00
Bill Hoffman 86c3a39e86 Fix bug#9619 add a link to module maintainers page in readme.txt for Modules 2009-09-30 09:53:48 -04:00
Brad King 0d34d44917 STYLE: Note find_package COMPONENTS in modules doc
This mentions the COMPONENTS option of find_package in the module author
documentation file "Modules/readme.txt".  See issue #8539.
2009-02-16 10:33:09 -05:00
Brad King 994262e5cc ENH: Improve find_package version numbering
Make the number of version components specified explicitly available.
Set variables for unspecified version components to "0" instead of
leaving them unset.  This simplifies version number handling for find-
and config-modules.  Also support a fourth "tweak" version component
since some packages use them.
2008-09-10 10:11:48 -04:00
Brad King 41c2895b75 ENH: Added version support to Config mode of find_package command.
- Added EXACT option to request an exact version.
  - Enforce version using check provided by package.
  - Updated FindPackageTest to test versioning in config mode.
2008-01-28 20:38:48 -05:00
Brad King f41b1e8e91 ENH: Implement version support in the find_package command module mode. Version numbers provided to the command are converted to variable settings to tell the FindXXX.cmake module what version is requested. This addresses issue #1645. 2008-01-21 08:48:33 -05:00
Alexander Neundorf c7770b8edb ENH: use the new FIND_PACKAGE_HANDLE_STANDARD_ARGS() macro in most of the
not-too-complicated modules
-remove unnecessary default search paths used in the FIND_XXX() calls

Alex
2007-07-19 09:00:51 -04:00
Brad King cc7bfeb6e4 ENH: Added XXX_RUNTIME_LIBRARY_DIRS as a suggested variable. 2006-11-01 09:06:27 -05:00
Brad King 3a757c253d STYLE: Fixed typo: INCLUDE_DIR->INCLUDE_DIRS. 2006-10-10 16:03:34 -04:00
Brad King 46d266047c ENH: Added documentation about XXX_FIND_COMPONENTS for FIND_PACKAGE. 2006-07-21 15:16:23 -04:00
Brad King 48571e9d80 STYLE: Added note about singular versus plural name for XXX_INCLUDE_DIRS. Added XXX_LIBRARY_DIRS and XXX_YY_INCLUDE_DIR conventions. 2006-07-18 13:16:38 -04:00
Brad King 9f625beab6 ENH: Added optional component list to the REQUIRED option of the FIND_PACKAGE command. This addresses bug#2771. 2006-01-27 13:07:23 -05:00
Bill Hoffman 9891260a6d ENH: add support for watcom wmake and wcl386 2006-01-17 10:21:45 -05:00
Bill Hoffman b7fa820118 ENH: add documentation support for modules 2005-12-14 13:51:08 -05:00
Ian Scott 28117a2e4a Add important missing word to documentation 2002-09-06 11:00:51 -04:00
Ian Scott 3d17c97f21 More detailed information about consistent FindXXX.cmake files 2002-09-06 10:55:55 -04:00
Ian Scott 63d64d5780 Define a single expected format for the values defined in every FindXXX.cmake file.
Upgrade all the QT functionality to use the new FindXXX.cmake format
Add a module for AVIFile.
2002-09-02 07:03:43 -04:00