diff options
author | Mike Frysinger <vapier@google.com> | 2019-06-13 01:54:46 -0400 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2019-07-12 17:23:53 +0000 |
commit | 87fb5a1894354ec0e34ccec427a9803e24157847 (patch) | |
tree | 39f3fe502643fa4f1c041d867bb8b9c40f0582ff | |
parent | ab85fe7c535bfa97c067354d8a23e39b849f6728 (diff) | |
download | git-repo-87fb5a1894354ec0e34ccec427a9803e24157847.tar.gz |
repo/main: add module docstrings
This should help people get some bearings in the codebase.
Change-Id: I951238fe617a3ecb04a47ead3809ec72c8fbf5a1
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/231232
Reviewed-by: David Pursehouse <dpursehouse@collab.net>
Tested-by: Mike Frysinger <vapier@google.com>
-rwxr-xr-x | main.py | 6 | ||||
-rwxr-xr-x | repo | 7 |
2 files changed, 13 insertions, 0 deletions
@@ -15,6 +15,12 @@ | |||
15 | # See the License for the specific language governing permissions and | 15 | # See the License for the specific language governing permissions and |
16 | # limitations under the License. | 16 | # limitations under the License. |
17 | 17 | ||
18 | """The repo tool. | ||
19 | |||
20 | People shouldn't run this directly; instead, they should use the `repo` wrapper | ||
21 | which takes care of execing this entry point. | ||
22 | """ | ||
23 | |||
18 | from __future__ import print_function | 24 | from __future__ import print_function |
19 | import getpass | 25 | import getpass |
20 | import imp | 26 | import imp |
@@ -1,6 +1,13 @@ | |||
1 | #!/usr/bin/env python | 1 | #!/usr/bin/env python |
2 | # -*- coding:utf-8 -*- | 2 | # -*- coding:utf-8 -*- |
3 | 3 | ||
4 | """Repo launcher. | ||
5 | |||
6 | This is a standalone tool that people may copy to anywhere in their system. | ||
7 | It is used to get an initial repo client checkout, and after that it runs the | ||
8 | copy of repo in the checkout. | ||
9 | """ | ||
10 | |||
4 | from __future__ import print_function | 11 | from __future__ import print_function |
5 | 12 | ||
6 | # repo default configuration | 13 | # repo default configuration |