commit: d298478fd56ba44d8ef36436fcfad23e9f7be5d7
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org>
AuthorDate: Wed Mar 30 14:50:57 2016 +0000
Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org>
CommitDate: Sat Apr 16 23:29:41 2016 +0000
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=d298478f
repoman/modules/scan.py: Add docstrings
pym/repoman/modules/scan/scan.py | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/pym/repoman/modules/scan/scan.py b/pym/repoman/modules/scan/scan.py
index 4901500..d2a5f51 100644
--- a/pym/repoman/modules/scan/scan.py
+++ b/pym/repoman/modules/scan/scan.py
@@ -1,5 +1,10 @@
# -*- coding:utf-8 -*-
+'''
+moudules/scan.py
+Module specific package scan list generator
+'''
+
import logging
import os
import sys
@@ -8,6 +13,15 @@ from repoman.errors import caterror
def scan(repolevel, reposplit, startdir, categories, repo_settings):
+ '''Generate a list of pkgs to scan
+
+ @param repolevel: integer, number of subdirectories deep from the tree
root
+ @param reposplit: list of the path subdirs
+ @param startdir: the top level directory to begin scanning from
+ @param categories: list of known categories
+ @param repo_settings: repository settings instance
+ @returns: scanlist, sorted list of pkgs to scan
+ '''
scanlist = []
if repolevel == 2:
# we are inside a category directory
