1 |
commit: 28d182722ce4941f455b54bd47a58e317a189e2a |
2 |
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
3 |
AuthorDate: Wed Mar 30 14:50:57 2016 +0000 |
4 |
Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Apr 25 15:28:53 2016 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=28d18272 |
7 |
|
8 |
repoman/modules/scan.py: Add docstrings |
9 |
|
10 |
pym/repoman/modules/scan/scan.py | 14 ++++++++++++++ |
11 |
1 file changed, 14 insertions(+) |
12 |
|
13 |
diff --git a/pym/repoman/modules/scan/scan.py b/pym/repoman/modules/scan/scan.py |
14 |
index 4901500..d2a5f51 100644 |
15 |
--- a/pym/repoman/modules/scan/scan.py |
16 |
+++ b/pym/repoman/modules/scan/scan.py |
17 |
@@ -1,5 +1,10 @@ |
18 |
# -*- coding:utf-8 -*- |
19 |
|
20 |
+''' |
21 |
+moudules/scan.py |
22 |
+Module specific package scan list generator |
23 |
+''' |
24 |
+ |
25 |
import logging |
26 |
import os |
27 |
import sys |
28 |
@@ -8,6 +13,15 @@ from repoman.errors import caterror |
29 |
|
30 |
|
31 |
def scan(repolevel, reposplit, startdir, categories, repo_settings): |
32 |
+ '''Generate a list of pkgs to scan |
33 |
+ |
34 |
+ @param repolevel: integer, number of subdirectories deep from the tree root |
35 |
+ @param reposplit: list of the path subdirs |
36 |
+ @param startdir: the top level directory to begin scanning from |
37 |
+ @param categories: list of known categories |
38 |
+ @param repo_settings: repository settings instance |
39 |
+ @returns: scanlist, sorted list of pkgs to scan |
40 |
+ ''' |
41 |
scanlist = [] |
42 |
if repolevel == 2: |
43 |
# we are inside a category directory |