[Buildroot] [PATCH 1/2] manual: add support to autogenerate *-list.txt
Samuel Martin
s.martin49 at gmail.com
Thu Nov 22 00:30:10 UTC 2012
* autogenerate the package-list.txt file without any git command
* add script searching for deprecated stuff and generating the doc
(support/script/deprecated.py)
Signed-off-by: Samuel Martin <s.martin49 at gmail.com>
---
docs/manual/manual.mk | 34 +++++++++++-
support/scripts/deprecated.py | 117 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 150 insertions(+), 1 deletion(-)
create mode 100755 support/scripts/deprecated.py
diff --git a/docs/manual/manual.mk b/docs/manual/manual.mk
index d664603..1daddb7 100644
--- a/docs/manual/manual.mk
+++ b/docs/manual/manual.mk
@@ -18,12 +18,44 @@ $(1): $(1)-$(3)
$(1)-$(3): $$(O)/docs/$(1)/$(1).$(4)
$$(O)/docs/$(1)/$(1).$(4): docs/$(1)/$(1).txt $$($(call UPPERCASE,$(1))_SOURCES)
- @echo "Generating $(5) $(1)..."
+ @$(call MESSAGE,"Generating $(5) $(1)...")
$(Q)mkdir -p $$(@D)
$(Q)a2x $(6) -f $(2) -d book -L -r $(TOPDIR)/docs/images \
-D $$(@D) $$<
endef
+clean-package-lists:
+ -rm -f $(TOPDIR)/docs/manual/package-list.txt
+ -rm -f $(TOPDIR)/docs/manual/deprecated-list.txt
+
+$(TOPDIR)/docs/manual/package-list.txt:
+ @$(call MESSAGE,"Generating package list...")
+ @echo -en "\
+ //\n\
+ // Autogenerated file\n\
+ //\n\n\
+ [[package-list]]\n\
+ Available packages\n\
+ ------------------\n\n\
+ // docs/manaual/pkg-list.txt is generated using the following command:\n\
+ // $ git grep -E '\\((autotools|cmake|generic)-package\\)' package/ | \\\n\
+ // cut -d':' -f1 | grep '\\.mk$$' | \\\n\
+ // sed -e 's;.*\\?/\\(.*\\?\\).mk;* \\1;' | \\\n\
+ // sort > docs/manual/pkg-list.txt\n\n\
+ " > $@
+ grep -rHE --color=never '\((autotools|cmake|generic)-package\)' \
+ $(TOPDIR)/package/ | \
+ cut -d':' -f1 | grep '\.mk$$' | \
+ sed -e 's;.*\?/\(.*\?\).mk;* \1;' | \
+ sort >> $@
+
+$(TOPDIR)/docs/manual/deprecated-list.txt:
+ @$(call MESSAGE,"Generating deprecated list...")
+ python2 $(TOPDIR)/support/scripts/deprecated.py > $@
+
+generate-doc-lists: clean-package-lists $(TOPDIR)/docs/manual/package-list.txt \
+ $(TOPDIR)/docs/manual/deprecated-list.txt
+
################################################################################
# GENDOC -- generates the make targets needed to build asciidoc documentation.
#
diff --git a/support/scripts/deprecated.py b/support/scripts/deprecated.py
new file mode 100755
index 0000000..491fddf
--- /dev/null
+++ b/support/scripts/deprecated.py
@@ -0,0 +1,117 @@
+#!/usr/bin/env python
+##
+## deprecated-packages.py
+##
+## Author(s):
+## - Samuel MARTIN <s.martin49 at gmail.com>
+##
+## Copyright (C) 2012 Samuel MARTIN
+##
+
+# Python 2.7 script searching for kconfig symbols depending on 'BR2_DEPRECATED'
+# and generating (printing to the standard output) the manual file in asciidoc.
+
+import os
+import re
+import sys
+
+
+NOT_SEARCHED = ('.git', 'configs', 'output', 'support')
+
+DEPR_SYMBOL = "BR2_DEPRECATED"
+
+_REGEX = r"config BR2_(.*?)\n" + \
+ "((.*?(?!config)(prompt|bool|string|int) \"(.*?)\".*?|[^\n]+)\n)*" + \
+ "(.*?(?!config )" + DEPR_SYMBOL + ".*?)\n" + \
+ "((.*?(?!config)(prompt|bool|string|int) \"(.*?)\".*?|[^\n]+)\n)*"
+
+REGEX = re.compile(_REGEX, flags=re.MULTILINE)
+
+def get_dir_list():
+ root = os.path.join(os.path.dirname(__file__), "..", "..")
+ root = os.path.abspath(root)
+ dirs = { 'buildroot': (root, False) }
+ for dir_ in os.listdir(root):
+ if dir_ in NOT_SEARCHED:
+ continue
+ dir__ = os.path.join(root, dir_)
+ if not os.path.isdir(dir__):
+ continue
+ dirs[dir_] = (dir__, True)
+ return dirs
+
+def find_deprecated(root, recursive):
+ deprecated = list()
+ for root_, _, files_ in os.walk(root):
+ if not recursive and root_ != root:
+ break
+ for file_ in files_:
+ if not file_.startswith("Config.in"):
+ continue
+ with open(os.path.join(root_, file_), "r") as f:
+ content = f.read()
+ if not DEPR_SYMBOL in content:
+ continue
+ found = REGEX.findall(content)
+ if found:
+ deprecated += found
+ return deprecated
+
+def find_all_deprecated(dirs):
+ deprecated = dict()
+ for key, search in dirs.iteritems():
+ root_path, recursive_search = search
+ deprecated[key] = find_deprecated(root_path, recursive_search)
+ return deprecated
+
+def generate_asciidoc(deprecated):
+ for cat, matches in deprecated.iteritems():
+ for i, match in enumerate(matches):
+ name = match[0].lower().replace("_", " ")
+ name = re.sub("^package ", "", name)
+ vers = re.sub(".*?(version )?([0-9].*)", r'\2', name)
+ if vers:
+ vers = re.sub(" ", ".", vers)
+ name = re.sub("(version )?([0-9].*)", vers, name)
+ symbol = match[4]
+ if not symbol:
+ symbol = match[9]
+ matches[i] = "\n** %-25s +[%s]+" % (name, symbol)
+ matches.sort()
+ deprecated[cat] = matches
+ output = """\
+//
+// Autogenerated file
+//
+
+[[deprecated]]
+Deprecated list
+---------------
+
+The following stuff are marked as _deprecated_ in Buildroot due to
+their status either too old or unmaintained.
+
+// Please check and sort by grepping the source running:
+//
+// $ git grep -EB4 'depends on BR2_DEPRECATED'
+//
+// and:
+//
+// $ git grep -EB4 'depends on BR2_DEPRECATED' | \\
+// grep -Eo '(:|-).*?(config|comment) BR2_.*'
+"""
+ for cat, matches in deprecated.iteritems():
+ if not matches:
+ continue
+ output += "\n\n* %s:\n" % cat.capitalize()
+ output += "".join(matches)
+ return output
+
+def main():
+ search_dirs = get_dir_list()
+ depr_lists = find_all_deprecated(search_dirs)
+ output = generate_asciidoc(depr_lists)
+ print output
+
+if __name__ == "__main__":
+ main()
--
1.8.0
More information about the buildroot
mailing list