diff options
author | Mike Frysinger <vapier@google.com> | 2021-06-14 16:05:19 -0400 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2021-06-15 06:07:37 +0000 |
commit | 4f21054c2841809da5e1e600b1cc765811288a80 (patch) | |
tree | 326156bb4407124de07207847bd9e4587124e37d /command.py | |
parent | 5ba2120362ceb49b89e0536108792fd7c824e28a (diff) | |
download | git-repo-4f21054c2841809da5e1e600b1cc765811288a80.tar.gz |
commands: document the "common" class attribute
Switch it to uppercase to make it clear it's a constant, and add
documentation so its usage is clear.
Change-Id: I6d281a66a90b5908b3131585c9945e88cfe815ea
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/309322
Reviewed-by: Raman Tenneti <rtenneti@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'command.py')
-rw-r--r-- | command.py | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -43,11 +43,15 @@ class Command(object): | |||
43 | """Base class for any command line action in repo. | 43 | """Base class for any command line action in repo. |
44 | """ | 44 | """ |
45 | 45 | ||
46 | common = False | ||
47 | event_log = EventLog() | 46 | event_log = EventLog() |
48 | manifest = None | 47 | manifest = None |
49 | _optparse = None | 48 | _optparse = None |
50 | 49 | ||
50 | # Whether this command is a "common" one, i.e. whether the user would commonly | ||
51 | # use it or it's a more uncommon command. This is used by the help command to | ||
52 | # show short-vs-full summaries. | ||
53 | COMMON = False | ||
54 | |||
51 | # Whether this command supports running in parallel. If greater than 0, | 55 | # Whether this command supports running in parallel. If greater than 0, |
52 | # it is the number of parallel jobs to default to. | 56 | # it is the number of parallel jobs to default to. |
53 | PARALLEL_JOBS = None | 57 | PARALLEL_JOBS = None |