Google Git
Sign in
gerrit/git-repo/4f21054c2841809da5e1e600b1cc765811288a80^!/.
commit
4f21054c2841809da5e1e600b1cc765811288a80
[log] [tgz]
author
Mike Frysinger <vapier@google.com>
Mon Jun 14 16:05:19 2021 -0400
committer
Mike Frysinger <vapier@google.com>
Tue Jun 15 06:07:37 2021 +0000
tree
326156bb4407124de07207847bd9e4587124e37d
parent
5ba2120362ceb49b89e0536108792fd7c824e28a [diff]
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>

diff --git a/command.py b/command.py
index 9b1220d..8e93029 100644
--- a/command.py
+++ b/command.py

@@ -43,11 +43,15 @@
   """Base class for any command line action in repo.
   """
 
-  common = False
   event_log = EventLog()
   manifest = None
   _optparse = None
 
+  # Whether this command is a "common" one, i.e. whether the user would commonly
+  # use it or it's a more uncommon command.  This is used by the help command to
+  # show short-vs-full summaries.
+  COMMON = False
+
   # Whether this command supports running in parallel.  If greater than 0,
   # it is the number of parallel jobs to default to.
   PARALLEL_JOBS = None

diff --git a/subcmds/abandon.py b/subcmds/abandon.py
index c7c127d..85d85f5 100644
--- a/subcmds/abandon.py
+++ b/subcmds/abandon.py

@@ -23,7 +23,7 @@
 
 
 class Abandon(Command):
-  common = True
+  COMMON = True
   helpSummary = "Permanently abandon a development branch"
   helpUsage = """
 %prog [--all | <branchname>] [<project>...]

diff --git a/subcmds/branches.py b/subcmds/branches.py
index 2dc102b..6d975ed 100644
--- a/subcmds/branches.py
+++ b/subcmds/branches.py

@@ -62,7 +62,7 @@
 
 
 class Branches(Command):
-  common = True
+  COMMON = True
   helpSummary = "View current topic branches"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/checkout.py b/subcmds/checkout.py
index 4d8009b..9b42948 100644
--- a/subcmds/checkout.py
+++ b/subcmds/checkout.py

@@ -20,7 +20,7 @@
 
 
 class Checkout(Command):
-  common = True
+  COMMON = True
   helpSummary = "Checkout a branch for development"
   helpUsage = """
 %prog <branchname> [<project>...]

diff --git a/subcmds/cherry_pick.py b/subcmds/cherry_pick.py
index fc4998c..7bd858b 100644
--- a/subcmds/cherry_pick.py
+++ b/subcmds/cherry_pick.py

@@ -21,7 +21,7 @@
 
 
 class CherryPick(Command):
-  common = True
+  COMMON = True
   helpSummary = "Cherry-pick a change."
   helpUsage = """
 %prog <sha1>

diff --git a/subcmds/diff.py b/subcmds/diff.py
index b400ccf..00a7ec2 100644
--- a/subcmds/diff.py
+++ b/subcmds/diff.py

@@ -19,7 +19,7 @@
 
 
 class Diff(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Show changes between commit and working tree"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/diffmanifests.py b/subcmds/diffmanifests.py
index 6f23b34..f6cc30a 100644
--- a/subcmds/diffmanifests.py
+++ b/subcmds/diffmanifests.py

@@ -31,7 +31,7 @@
   deeper level.
   """
 
-  common = True
+  COMMON = True
   helpSummary = "Manifest diff utility"
   helpUsage = """%prog manifest1.xml [manifest2.xml] [options]"""
 

diff --git a/subcmds/download.py b/subcmds/download.py
index 81d997e..523f25e 100644
--- a/subcmds/download.py
+++ b/subcmds/download.py

@@ -22,7 +22,7 @@
 
 
 class Download(Command):
-  common = True
+  COMMON = True
   helpSummary = "Download and checkout a change"
   helpUsage = """
 %prog {[project] change[/patchset]}...

diff --git a/subcmds/forall.py b/subcmds/forall.py
index 0cf3b6a..7c1dea9 100644
--- a/subcmds/forall.py
+++ b/subcmds/forall.py

@@ -41,7 +41,7 @@
 
 
 class Forall(Command, MirrorSafeCommand):
-  common = False
+  COMMON = False
   helpSummary = "Run a shell command in each project"
   helpUsage = """
 %prog [<project>...] -c <command> [<arg>...]

diff --git a/subcmds/gitc_delete.py b/subcmds/gitc_delete.py
index 54b956f..df74946 100644
--- a/subcmds/gitc_delete.py
+++ b/subcmds/gitc_delete.py

@@ -19,7 +19,7 @@
 
 
 class GitcDelete(Command, GitcClientCommand):
-  common = True
+  COMMON = True
   visible_everywhere = False
   helpSummary = "Delete a GITC Client."
   helpUsage = """

diff --git a/subcmds/gitc_init.py b/subcmds/gitc_init.py
index 23a4ebb..e705b61 100644
--- a/subcmds/gitc_init.py
+++ b/subcmds/gitc_init.py

@@ -23,7 +23,7 @@
 
 
 class GitcInit(init.Init, GitcAvailableCommand):
-  common = True
+  COMMON = True
   helpSummary = "Initialize a GITC Client."
   helpUsage = """
 %prog [options] [client name]

diff --git a/subcmds/grep.py b/subcmds/grep.py
index 6cb1445..8ac4ba1 100644
--- a/subcmds/grep.py
+++ b/subcmds/grep.py

@@ -29,7 +29,7 @@
 
 
 class Grep(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Print lines matching a pattern"
   helpUsage = """
 %prog {pattern | -e pattern} [<project>...]

diff --git a/subcmds/help.py b/subcmds/help.py
index 0989b99..821f6bf 100644
--- a/subcmds/help.py
+++ b/subcmds/help.py

@@ -24,7 +24,7 @@
 
 
 class Help(PagedCommand, MirrorSafeCommand):
-  common = False
+  COMMON = False
   helpSummary = "Display detailed help on a command"
   helpUsage = """
 %prog [--all|command]
@@ -73,7 +73,7 @@
 
     commandNames = list(sorted([name
                                 for name, command in all_commands.items()
-                                if command.common and gitc_supported(command)]))
+                                if command.COMMON and gitc_supported(command)]))
     self._PrintCommands(commandNames)
 
     print(

diff --git a/subcmds/info.py b/subcmds/info.py
index f7cf60f..6c1246e 100644
--- a/subcmds/info.py
+++ b/subcmds/info.py

@@ -25,7 +25,7 @@
 
 
 class Info(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Get info on the manifest branch, current branch or unmerged branches"
   helpUsage = "%prog [-dl] [-o [-c]] [<project>...]"
 

diff --git a/subcmds/init.py b/subcmds/init.py
index 4182262..750facb 100644
--- a/subcmds/init.py
+++ b/subcmds/init.py

@@ -31,7 +31,7 @@
 
 
 class Init(InteractiveCommand, MirrorSafeCommand):
-  common = True
+  COMMON = True
   helpSummary = "Initialize a repo client checkout in the current directory"
   helpUsage = """
 %prog [options] [manifest url]

diff --git a/subcmds/list.py b/subcmds/list.py
index 68bcd5e..8d0c564 100644
--- a/subcmds/list.py
+++ b/subcmds/list.py

@@ -16,7 +16,7 @@
 
 
 class List(Command, MirrorSafeCommand):
-  common = True
+  COMMON = True
   helpSummary = "List projects and their associated directories"
   helpUsage = """
 %prog [-f] [<project>...]

diff --git a/subcmds/manifest.py b/subcmds/manifest.py
index 965c36e..00587d8 100644
--- a/subcmds/manifest.py
+++ b/subcmds/manifest.py

@@ -20,7 +20,7 @@
 
 
 class Manifest(PagedCommand):
-  common = False
+  COMMON = False
   helpSummary = "Manifest inspection utility"
   helpUsage = """
 %prog [-o {-|NAME.xml}] [-m MANIFEST.xml] [-r]

diff --git a/subcmds/overview.py b/subcmds/overview.py
index b28367b..63f5a79 100644
--- a/subcmds/overview.py
+++ b/subcmds/overview.py

@@ -19,7 +19,7 @@
 
 
 class Overview(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Display overview of unmerged project branches"
   helpUsage = """
 %prog [--current-branch] [<project>...]

diff --git a/subcmds/prune.py b/subcmds/prune.py
index 236b647..584ee7e 100644
--- a/subcmds/prune.py
+++ b/subcmds/prune.py

@@ -19,7 +19,7 @@
 
 
 class Prune(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Prune (delete) already merged topics"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/rebase.py b/subcmds/rebase.py
index 9ce4ecb..7c53eb7 100644
--- a/subcmds/rebase.py
+++ b/subcmds/rebase.py

@@ -27,7 +27,7 @@
 
 
 class Rebase(Command):
-  common = True
+  COMMON = True
   helpSummary = "Rebase local branches on upstream branch"
   helpUsage = """
 %prog {[<project>...] | -i <project>...}

diff --git a/subcmds/selfupdate.py b/subcmds/selfupdate.py
index 388881d..282f518 100644
--- a/subcmds/selfupdate.py
+++ b/subcmds/selfupdate.py

@@ -21,7 +21,7 @@
 
 
 class Selfupdate(Command, MirrorSafeCommand):
-  common = False
+  COMMON = False
   helpSummary = "Update repo to the latest version"
   helpUsage = """
 %prog

diff --git a/subcmds/smartsync.py b/subcmds/smartsync.py
index c7d1d4d..d91d59c 100644
--- a/subcmds/smartsync.py
+++ b/subcmds/smartsync.py

@@ -16,7 +16,7 @@
 
 
 class Smartsync(Sync):
-  common = True
+  COMMON = True
   helpSummary = "Update working tree to the latest known good revision"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/stage.py b/subcmds/stage.py
index ff0f173..0389a4f 100644
--- a/subcmds/stage.py
+++ b/subcmds/stage.py

@@ -28,7 +28,7 @@
 
 
 class Stage(InteractiveCommand):
-  common = True
+  COMMON = True
   helpSummary = "Stage file(s) for commit"
   helpUsage = """
 %prog -i [<project>...]

diff --git a/subcmds/start.py b/subcmds/start.py
index ff2bae5..2addaf2 100644
--- a/subcmds/start.py
+++ b/subcmds/start.py

@@ -25,7 +25,7 @@
 
 
 class Start(Command):
-  common = True
+  COMMON = True
   helpSummary = "Start a new branch for development"
   helpUsage = """
 %prog <newbranchname> [--all | <project>...]

diff --git a/subcmds/status.py b/subcmds/status.py
index 1b48dce..5b66954 100644
--- a/subcmds/status.py
+++ b/subcmds/status.py

@@ -24,7 +24,7 @@
 
 
 class Status(PagedCommand):
-  common = True
+  COMMON = True
   helpSummary = "Show the working tree status"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/sync.py b/subcmds/sync.py
index 67d9c11..b15d947 100644
--- a/subcmds/sync.py
+++ b/subcmds/sync.py

@@ -66,7 +66,7 @@
 
 class Sync(Command, MirrorSafeCommand):
   jobs = 1
-  common = True
+  COMMON = True
   helpSummary = "Update working tree to the latest revision"
   helpUsage = """
 %prog [<project>...]

diff --git a/subcmds/upload.py b/subcmds/upload.py
index fc389e4..c48deab 100644
--- a/subcmds/upload.py
+++ b/subcmds/upload.py

@@ -55,7 +55,7 @@
 
 
 class Upload(InteractiveCommand):
-  common = True
+  COMMON = True
   helpSummary = "Upload changes for code review"
   helpUsage = """
 %prog [--re --cc] [<project>]...

diff --git a/subcmds/version.py b/subcmds/version.py
index 1d9abb5..09b053e 100644
--- a/subcmds/version.py
+++ b/subcmds/version.py

@@ -25,7 +25,7 @@
   wrapper_version = None
   wrapper_path = None
 
-  common = False
+  COMMON = False
   helpSummary = "Display the version of repo"
   helpUsage = """
 %prog