From 87fb5a1894354ec0e34ccec427a9803e24157847 Mon Sep 17 00:00:00 2001 From: Mike Frysinger Date: Thu, 13 Jun 2019 01:54:46 -0400 Subject: [PATCH] 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 Tested-by: Mike Frysinger --- main.py | 6 ++++++ repo | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/main.py b/main.py index 54817776..5c546e82 100755 --- a/main.py +++ b/main.py @@ -15,6 +15,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +"""The repo tool. + +People shouldn't run this directly; instead, they should use the `repo` wrapper +which takes care of execing this entry point. +""" + from __future__ import print_function import getpass import imp diff --git a/repo b/repo index 75d27692..8ed147df 100755 --- a/repo +++ b/repo @@ -1,6 +1,13 @@ #!/usr/bin/env python # -*- coding:utf-8 -*- +"""Repo launcher. + +This is a standalone tool that people may copy to anywhere in their system. +It is used to get an initial repo client checkout, and after that it runs the +copy of repo in the checkout. +""" + from __future__ import print_function # repo default configuration