ENH: Add generators documentation

1 files changed, 17 insertions, 6 deletions

diff --git a/Source/CPack/cmCPackGenerators.cxx b/Source/CPack/cmCPackGenerators.cxx
index ed153af..79c0430 100644
--- a/Source/CPack/cmCPackGenerators.cxx
+++ b/Source/CPack/cmCPackGenerators.cxx
@@ -30,13 +30,22 @@
 //----------------------------------------------------------------------
 cmCPackGenerators::cmCPackGenerators()
 {
-  this->RegisterGenerator("TGZ", cmCPackTGZGenerator::CreateGenerator);
-  this->RegisterGenerator("STGZ", cmCPackSTGZGenerator::CreateGenerator);
-  this->RegisterGenerator("NSIS", cmCPackNSISGenerator::CreateGenerator);
-  this->RegisterGenerator("ZIP", cmCPackZIPGenerator::CreateGenerator);
-  this->RegisterGenerator("TZ", cmCPackTarCompressGenerator::CreateGenerator);
-  this->RegisterGenerator("PackageMaker",
+  this->RegisterGenerator("TGZ", "Tar GZip compression",
+    cmCPackTGZGenerator::CreateGenerator);
+  this->RegisterGenerator("STGZ", "Self extracting Tar GZip compression",
+    cmCPackSTGZGenerator::CreateGenerator);
+#ifdef _WIN32
+  this->RegisterGenerator("NSIS", "Null Soft Installer",
+    cmCPackNSISGenerator::CreateGenerator);
+#endif
+  this->RegisterGenerator("ZIP", "ZIP file format",
+    cmCPackZIPGenerator::CreateGenerator);
+  this->RegisterGenerator("TZ", "Tar Compress compression",
+    cmCPackTarCompressGenerator::CreateGenerator);
+#ifdef __APPLE__
+  this->RegisterGenerator("PackageMaker", "Mac OSX Package Maker compression",
     cmCPackPackageMakerGenerator::CreateGenerator);
+#endif
 }
 
 //----------------------------------------------------------------------
@@ -81,6 +90,7 @@ cmCPackGenericGenerator* cmCPackGenerators::NewGeneratorInternal(
 
 //----------------------------------------------------------------------
 void cmCPackGenerators::RegisterGenerator(const char* name,
+  const char* generatorDescription,
   CreateGeneratorCall* createGenerator)
 {
   if ( !name || !createGenerator )
@@ -90,4 +100,5 @@ void cmCPackGenerators::RegisterGenerator(const char* name,
     return;
     }
   this->GeneratorCreators[name] = createGenerator;
+  this->GeneratorDescriptions[name] = generatorDescription;
 }