From: Petr Machata <pmachata@redhat.com>
Date: Fri, 17 Sep 2010 16:40:55 +0000 (+0200)
Subject: dwarflint: Add a description of locstats
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=75fca96bcdd27490f70572de2e0ca8c7ac2a028f;p=thirdparty%2Felfutils.git

dwarflint: Add a description of locstats
---

diff --git a/dwarflint/check_nodebug.cc b/dwarflint/check_nodebug.cc
index fe9fbb0e3..56b0ca805 100644
--- a/dwarflint/check_nodebug.cc
+++ b/dwarflint/check_nodebug.cc
@@ -39,7 +39,7 @@ public:
        .groups ("@low")
        .description (
 "Checks that there are at least essential debuginfo sections present\n"
-"in the ELF file."));
+"in the ELF file.\n"));
     return &cd;
   }
 
diff --git a/dwarflint/locstats.cc b/dwarflint/locstats.cc
index e338fd428..2b9739300 100644
--- a/dwarflint/locstats.cc
+++ b/dwarflint/locstats.cc
@@ -43,7 +43,15 @@ namespace
     static checkdescriptor const *descriptor () {
       static checkdescriptor cd
 	(checkdescriptor::create ("locstats")
-	 .groups ("@nodefault"));
+	 .groups ("@nodefault")
+	 .description (
+"Computes a location info coverage statistics.  Goes through the whole\n"
+"DIE graph, looking at each variable and formal parameter, and\n"
+"determining scope coverage of its location information.  In other\n"
+"words for how big a part of scope we know, where the variable\n"
+"\"lives\".\n"
+" https://fedorahosted.org/pipermail/elfutils-devel/2010-July/001498.html\n"
+" https://fedorahosted.org/pipermail/elfutils-devel/2010-September/001602.html\n"));
       return &cd;
     }