docs: dropped separation between man1 and man9 in HAL component list

Author: hansu

.gitignore

@@ -13,8 +13,7 @@ build-stamp
 .tmp*
 # Ignore generated html files, 
 /docs/src/*/*.html
-docs/src/hal/components_gen1.adoc
-docs/src/hal/components_gen9.adoc
+docs/src/hal/components_gen.adoc
 # docs/html/.gitignore is for the html directory
 debian/*.debhelper.log
 rtlib/Module.symvers

docs/src/asciideps

@@ -11,7 +11,7 @@ includes () {
 	for f in `sed -ne "s|^include::\(.*\)\[\]$|$DIR/\1|p" "$1"`; do
 		# components_gen.adoc will contain only generated content
 		case "$f" in
-			*/components_gen*.adoc)
+			*/components_gen.adoc)
 			touch "$f"
 			;;
 		esac

docs/src/gen_complist.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # generate_complist()
-#       Compares the entries in the component list (components.adoc) with the 
+#       Compares the entries in the component list (components.adoc) with the
 #       available man pages and adds tables for missing components.
 # generate_links()
 #       Generates a copy of components.adoc with added links to the man pages for the components.
@@ -10,83 +10,59 @@
 import sys
 
 man1_path = '../docs/man/man1'
-man1_files = {f.replace('.1', '') for f in os.listdir(man1_path) if os.path.isfile(os.path.join(man1_path, f))}
+man1_files = {f for f in os.listdir(man1_path) if os.path.isfile(os.path.join(man1_path, f))}
 man9_path = '../docs/man/man9'
-man9_files = {f.replace('.9', '') for f in os.listdir(man9_path) if os.path.isfile(os.path.join(man9_path, f))}
-man = {'1':man1_files, '9':man9_files}
-doc1 = set()
-doc9 = set()
-components = {'1':doc1, '9':doc9}
-section_switch = '[[sec:realtime-components]]'
+man9_files = {f for f in os.listdir(man9_path) if os.path.isfile(os.path.join(man9_path, f))}
+man_files = man1_files.union(man9_files)
+complist_doc = set()
+miss_in_man = set()
 # complist_path = '../docs/src/hal/components.adoc'
 
 def generate_complist(complist_path):
     file1 = open(complist_path, 'r')
-    manpage = '1'
     for line in file1:
-        if section_switch in line:
-            manpage = '9'
-        
         if line[0] == '|' and line[1] != '=':
             splitted = line.split('|')
             if splitted[1].strip() != '':
                 if 'link:' in splitted[1]:
-                    comp = re.search('\[.*\]', splitted[1]).group()
+                    link = re.search('(?<=link:).*(?=\\[)', splitted[1]).group()
+                    comp_man = re.search("[a-zA-Z0-9-_\\.]+(?=\\.html)", link).group()
+                    if os.path.isfile(os.path.join('../docs/html/hal',link)):
+                        complist_doc.add(comp_man)
+                    else:
+                        print('gen_complist: Broken link:', link, file=sys.stderr)
+                        miss_in_man.add(comp_man.split(".")[0])
                 else:
-                    comp = splitted[1]
-                components[manpage].add(comp.strip('[] '))
-
+                    print("gen_complist: Component", splitted[1], "without link")
+                    miss_in_man.add(splitted[1])
     file1.close()
-    miss1 = man1_files.difference(doc1)
-    obs1 = doc1.difference(man1_files)
-    miss9 = man9_files.difference(doc9)
-    obs9 = doc9.difference(man9_files)
-    gen1_filename = '../docs/src/hal/components_gen1.adoc'
-    file2 = open(gen1_filename, 'w')
-    if len(miss1) > 0:
-        file2.write('=== Not categorized (auto generated)\n')
+    miss_in_list = man_files.difference(complist_doc)
+
+    gen_filename = '../docs/src/hal/components_gen.adoc'
+    file2 = open(gen_filename, 'w')
+    if len(miss_in_list) > 0:
+        file2.write('=== Not categorized (auto generated from man pages)\n')
         file2.write('[{tab_options}]\n|=======================\n')
-        for i in sorted(miss1):
+        for i in sorted(miss_in_list):
             file2.write('| ' + i + ' |||\n')
         file2.write('|=======================\n')
-    if len(obs1) > 0:
-        file2.write('\n=== Without man page (auto generated)\n')
+    if len(miss_in_man) > 0:
+        file2.write('\n=== Without man page or broken link (auto generated from component list)\n')
         file2.write('[{tab_options}]\n|=======================\n')
-        for i in sorted(obs1):
+        for i in sorted(miss_in_man):
             file2.write('| ' + i + ' |||\n')
         file2.write('|=======================\n')
     file2.close()
-    gen9_filename = '../docs/src/hal/components_gen9.adoc'
-    file3 = open(gen9_filename, 'w')
-    if len(miss9) > 0:
-        file3.write('=== Not categorized (auto generated)\n')
-        file3.write('[{tab_options}]\n|=======================\n')
-        for i in sorted(miss9):
-            file3.write('| ' + i + ' |||\n')
-        file3.write('|=======================\n')
-    if len(obs9) > 0:
-        file3.write('\n=== Without man page (auto generated)\n')
-        file3.write('[{tab_options}]\n|=======================\n')
-        for i in sorted(obs9):
-            file3.write('| ' + i + ' |||\n')
-        file3.write('|=======================\n')
-    file3.close()
-
-    generate_links(gen1_filename, '1', False, True)
-    generate_links(gen9_filename, '9', False, True)
 
-    print('gen_complist: Added {} uncategorized and {} obsolete entries to hal component list (man1)'.format(len(miss1), len(obs1)))
-    print('gen_complist: Added {} uncategorized and {} obsolete entries to hal component list (man9)'.format(len(miss9), len(obs9)))
+    generate_links(gen_filename, False, True)
+    print('gen_complist: Added {} uncategorized and {} obsolete entries to hal component list'.format(len(miss_in_list), len(miss_in_man)))
 
 
-def generate_links(filename, manpage='1', create_backup=True, add_descr=False):
+def generate_links(filename, create_backup=True, add_descr=False):
     file = open(filename, 'r')
     file_links = []
     links_added = 0
     for line in file:
-        if section_switch in line:
-            manpage = '9'
-        
         if line[0] == '|' and line[1] != '=':
             splitted = line.split('|')
 
@@ -95,22 +71,22 @@ def generate_links(filename, manpage='1', create_backup=True, add_descr=False):
                 if not os.path.isfile(os.path.join('../docs/html/hal',link)):
                     print('gen_complist_link: Broken link:', link)
             else:
-                comp = splitted[1].strip(' ')
-                if comp in man[manpage]:
-                    line = line.replace(comp, 'link:../man/man'+manpage+'/'+comp+'.'+manpage+'.html['+comp+']', 1)
+                comp_man = splitted[1].strip(' ')
+                if comp_man in man_files:
+                    comp, man = comp_man.split(".")
+                    line = line.replace(comp_man, 'link:../man/man'+man+'/'+comp_man+'.html['+comp+']', 1)
                     links_added += 1
                     if add_descr:
                         splitted = line.split('|')
-                        splitted[2] = extract_descr('../docs/man/man'+manpage+'/'+comp+'.'+manpage)\
+                        splitted[2] = extract_descr('../docs/man/man'+man+'/'+comp_man)\
                         .replace(comp + ' ', ' ',1).strip('\n -')
                         line = '|'.join(splitted)
         file_links.append(line)
-
     file.close()
 
     if links_added:
         if create_backup:
-            os.rename(filename, filename+'~')        
+            os.rename(filename, filename+'~')
         file = open(filename, 'w')
         for line in file_links:
             file.write(line)
@@ -122,7 +98,7 @@ def extract_descr(filename):
     file = open(filename, 'r')
     descr = ''
     in_descr = False
-    
+
     for line in file:
         if '.SH NAME' in line or '.SH "NAME' in line:
             in_descr = True