Add manpage and utils

diff --git a/doc/createrepo_c.8.gz b/doc/createrepo_c.8.gz
new file mode 100644 (file)
index 0000000..0d5a121
Binary files /dev/null and b/doc/createrepo_c.8.gz differ

diff --git a/src/createrepo_c.c b/src/createrepo_c.c
index 26d838f..f2e4349 100644 (file)
--- a/src/createrepo_c.c
+++ b/src/createrepo_c.c
@@ -599,7 +599,7 @@ int main(int argc, char **argv) {
 
     user_data.package_count = package_count;
     g_thread_pool_set_max_threads(pool, cmd_options->workers, NULL);
-    g_message("Pool started");
+    g_message("Pool started (with %d workers)", cmd_options->workers);
 
 
     // Wait until pool is finished

diff --git a/utils/gen_manpage.sh b/utils/gen_manpage.sh
new file mode 100755 (executable)
index 0000000..6019b25
--- /dev/null
+++ b/utils/gen_manpage.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# /usr/share/man/man8/createrepo_c.8.gz
+
+EXPECTED_ARGS=2
+if [ $# -ne $EXPECTED_ARGS ]
+then
+    echo "Usage: `basename $0` <input_file> <outputdir>"
+    echo
+    echo "Example: `basename $0` ../src/cmd_parser.c ../doc/"
+    exit 1
+fi
+
+python gen_rst.py $1 | rst2man | gzip > $2/createrepo_c.8.gz

diff --git a/utils/gen_rst.py b/utils/gen_rst.py
new file mode 100755 (executable)
index 0000000..ee710c6
--- /dev/null
+++ b/utils/gen_rst.py
@@ -0,0 +1,157 @@
+#!/usr/bin/python
+
+import sys
+import re
+import datetime
+from optparse import OptionParser
+
+
+class Info(object):
+    def __init__(self, name, description=None, synopsis=None, copyright=None, options=None):
+        self.name = name
+        self.description = description
+        self.synopsis = synopsis
+        self.copyright = copyright
+        self.options = options  # list of dictionaries with keys ["long_name", "short_name", "description", "arg_description"]
+
+    def gen_rst(self):
+        rst  = ".. -*- coding: utf-8 -*-\n\n"
+        rst += "%s\n" % ("=" * len(self.name),)
+        rst += "%s\n" % self.name
+        rst += "%s\n\n" % ("=" * len(self.name),)
+
+        # Add synopsis
+        #if self.synopsis:
+        #    rst += ":Synopsis: %s\n\n" % self.synopsis
+
+        # Add description
+        if self.description:
+            rst += ":Subtitle: %s\n\n" % self.description
+
+        # Add copyright
+        if self.copyright:
+            rst += ":Copyright: %s\n" % self.copyright
+
+        # Add date
+        rst += ":Date: $Date: %s $\n\n" % datetime.datetime.strftime(datetime.datetime.utcnow(), format="%F %X")
+
+        # Add options
+        rst += "-------\n"
+        rst += "OPTIONS\n"
+        rst += "-------\n"
+
+        for command in self.options:
+            cmd  = ""
+            if command["short_name"]:
+                cmd += "-%s " % command["short_name"]
+            cmd += "--%s" % command["long_name"]
+            if command["arg_description"]:
+                cmd += " %s" % command["arg_description"]
+
+            rst += "%s\n" % cmd
+            rst += "%s\n" % ("-" * len(cmd))
+            rst += "%s\n" % command["description"]
+
+            rst += "\n"
+
+        return rst
+
+
+def parse_arguments_from_c_file(filename):
+    args = []
+
+    try:
+        content = open(filename, "r").read()
+    except IOException:
+        print "Error: Cannot open file %s" % filename
+        return args
+
+    re_cmd_entries = re.compile(r"static GOptionEntry[^{]*{(?P<entries>.*){\s*NULL\s*}", re.MULTILINE|re.DOTALL)
+    match = re_cmd_entries.search(content)
+    if not match:
+        print "Warning: Cannot find GOptionEntry section in %s" % filename
+        return args
+
+    re_single_entry = re.compile(r"""{\s*"(?P<long_name>[^"]*)"\s*,        # long name
+                                     \s*'?(?P<short_name>[^',]*)'?\s*,     # short name
+                                     \s*[^,]*\s*,                          # flags
+                                     \s*[^,]*\s*,                          # arg type
+                                     \s*[^,]*\s*,                          # arg data pointer
+                                     \s*("(?P<description>.*?)")\s*,       # description
+                                     \s*"?(?P<arg_description>[^"}]*)"?    # arg description
+                                  \s*},""", re.MULTILINE|re.DOTALL|re.VERBOSE)
+    raw_entries_str = match.group("entries")
+
+    start = 0
+    entry_match = re_single_entry.search(raw_entries_str)
+    i = 1
+    while entry_match:
+        long_name = entry_match.group("long_name").strip()
+        short_name = entry_match.group("short_name").strip()
+        description = entry_match.group("description").strip()
+        arg_description = entry_match.group("arg_description").strip()
+
+        # Normalize short name
+        if short_name and (short_name == "NULL" or short_name == "0"):
+            short_name = None
+
+        # Normalize description
+        description = description.replace('\\"', "\\\\'")
+        description = description.replace("\\\\'", '"')
+        description = description.replace('"', "")
+        description = description.replace('\n', '')
+        description = description.replace('\t', '')
+
+        # Remove multiple whitespaces from description
+        while True:
+            new_description = description.replace("  ", " ")
+            if new_description == description:
+                break
+            description = new_description
+        description = description.strip()
+
+        # Normalize arg_description
+        if arg_description and (arg_description == "NULL" or arg_description == "0"):
+            arg_description = None
+
+        # Store option into list
+        args.append({'long_name': long_name,
+                     'short_name': short_name,
+                     'description': description,
+                     'arg_description': arg_description
+                     })
+
+        # Continue to next option
+        i += 1
+        start += entry_match.end(0)
+        entry_match = re_single_entry.search(raw_entries_str[start:])
+    # End while
+
+    print >> sys.stderr, "Loaded %2d arguments" % (i,)
+    return args
+
+
+
+if __name__ == "__main__":
+    parser = OptionParser('usage: %prog [options] <filename>')
+    #parser.add_option('-o', '--outputdir', help="...")
+    options, args = parser.parse_args()
+
+    if len(args) < 1:
+        print >> sys.stderr, "Error: Must specify a input filename. (Example: ../src/cmd_parser.c)"
+        sys.exit(1)
+
+    args = parse_arguments_from_c_file(args[0])
+
+    NAME="createrepo_c"
+
+    info = Info(NAME,
+                description="C implementation of createrepo",
+                synopsis="%s [options] <directory>" % (NAME,),
+                options=args)
+    ret = info.gen_rst()
+    if not ret:
+        print >> sys.stderr, "Error: Rst has not been generated"
+        sys.exit(1)
+
+    print ret