aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-14 13:19:47 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-02-14 13:19:47 +0000
commit884c420ae598e097bf0090fecd8f4c102352b62e (patch)
tree5da79291cf8ad126eb62264f250eb4dda47ebf55
parent3a03ad6c8a09c2dbcdc4da2d5bacfbae16c4cb94 (diff)
downloadpaludis-884c420ae598e097bf0090fecd8f4c102352b62e.tar.gz
paludis-884c420ae598e097bf0090fecd8f4c102352b62e.tar.xz
Add descriptions to QA checks
-rw-r--r--paludis/qa/changelog_check.hh5
-rw-r--r--paludis/qa/check.hh4
-rw-r--r--paludis/qa/file_name_check.hh5
-rw-r--r--paludis/qa/file_permissions_check.hh5
-rw-r--r--paludis/qa/glep_31_check.hh5
-rw-r--r--paludis/qa/has_ebuilds_check.hh5
-rw-r--r--paludis/qa/has_misc_files_check.hh5
-rw-r--r--paludis/qa/metadata_check.hh5
-rw-r--r--paludis/qa/package_name_check.hh5
9 files changed, 44 insertions, 0 deletions
diff --git a/paludis/qa/changelog_check.hh b/paludis/qa/changelog_check.hh
index 15257e1..4de3fd0 100644
--- a/paludis/qa/changelog_check.hh
+++ b/paludis/qa/changelog_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that the ChangeLog is a regular file";
+ }
};
static const FileCheckMaker::RegisterMaker register_changelog_check(
diff --git a/paludis/qa/check.hh b/paludis/qa/check.hh
index 61b868b..47ab5b4 100644
--- a/paludis/qa/check.hh
+++ b/paludis/qa/check.hh
@@ -21,6 +21,7 @@
#define PALUDIS_GUARD_PALUDIS_QA_CHECK_HH 1
#include <paludis/instantiation_policy.hh>
+#include <string>
/** \file
* Declarations for the paludis::qa::Check class.
@@ -44,6 +45,9 @@ namespace paludis
Check();
virtual ~Check();
+
+ public:
+ virtual std::string describe() const = 0;
};
}
}
diff --git a/paludis/qa/file_name_check.hh b/paludis/qa/file_name_check.hh
index decb36a..6679c82 100644
--- a/paludis/qa/file_name_check.hh
+++ b/paludis/qa/file_name_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that the file name is legal";
+ }
};
static const FileCheckMaker::RegisterMaker register_file_name_check(
diff --git a/paludis/qa/file_permissions_check.hh b/paludis/qa/file_permissions_check.hh
index 14bf511..756e67a 100644
--- a/paludis/qa/file_permissions_check.hh
+++ b/paludis/qa/file_permissions_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that file and directory permissions are sane";
+ }
};
static const FileCheckMaker::RegisterMaker register_file_permissions_check(
diff --git a/paludis/qa/glep_31_check.hh b/paludis/qa/glep_31_check.hh
index 2a4771a..aeb040b 100644
--- a/paludis/qa/glep_31_check.hh
+++ b/paludis/qa/glep_31_check.hh
@@ -39,6 +39,11 @@ namespace paludis
static const std::string & identifier();
static void check_utf8(std::istream &, CheckResult &);
+
+ virtual std::string describe() const
+ {
+ return "Checks that files conform to GLEP 31";
+ }
};
static const FileCheckMaker::RegisterMaker register_glep_31_check(
diff --git a/paludis/qa/has_ebuilds_check.hh b/paludis/qa/has_ebuilds_check.hh
index e32d6c3..eb56403 100644
--- a/paludis/qa/has_ebuilds_check.hh
+++ b/paludis/qa/has_ebuilds_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that there are ebuilds present";
+ }
};
static const PackageDirCheckMaker::RegisterMaker register_has_ebuilds_check(
diff --git a/paludis/qa/has_misc_files_check.hh b/paludis/qa/has_misc_files_check.hh
index 62d0f06..99bbae6 100644
--- a/paludis/qa/has_misc_files_check.hh
+++ b/paludis/qa/has_misc_files_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that ChangeLog, metadata.xml, files/ exist";
+ }
};
static const PackageDirCheckMaker::RegisterMaker register_misc_files_check(
diff --git a/paludis/qa/metadata_check.hh b/paludis/qa/metadata_check.hh
index b1dd447..3a1e7a3 100644
--- a/paludis/qa/metadata_check.hh
+++ b/paludis/qa/metadata_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that metadata.xml is valid";
+ }
};
static const FileCheckMaker::RegisterMaker register_metadata_check(
diff --git a/paludis/qa/package_name_check.hh b/paludis/qa/package_name_check.hh
index d74fa56..1386f80 100644
--- a/paludis/qa/package_name_check.hh
+++ b/paludis/qa/package_name_check.hh
@@ -36,6 +36,11 @@ namespace paludis
CheckResult operator() (const FSEntry &) const;
static const std::string & identifier();
+
+ virtual std::string describe() const
+ {
+ return "Checks that the category/package name is valid";
+ }
};
static const PackageDirCheckMaker::RegisterMaker register_package_name_check(