android/git-repo
1
Fork 0
mirror of https://gerrit.googlesource.com/git-repo synced 2024-12-21 07:16:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

replace javadoc docs with standard python style

Browse Source 
We don't use javadoc in this project, so clean up the few places
that slipped in with the gitc code.

Change-Id: Ia365fb2d1e3188ad16b2f65b1a3b7e8466001946
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/291262
Reviewed-by: Michael Mortensen <mmortensen@google.com>
Tested-by: Mike Frysinger <vapier@google.com>
This commit is contained in:
Mike Frysinger 2020-12-11 03:26:42 -05:00
parent 5e2f32fe13
commit 0a849b660f
2 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gitc_utils.py
View File

@ -45,7 +45,8 @@ def _set_project_revisions(projects):
should not be overly large. Recommend calling this function multiple times should not be overly large. Recommend calling this function multiple times
with each call not exceeding NUM_BATCH_RETRIEVE_REVISIONID projects. with each call not exceeding NUM_BATCH_RETRIEVE_REVISIONID projects.
@param projects: List of project objects to set the revionExpr for. Args:
projects: List of project objects to set the revionExpr for.
""" """
# Retrieve the commit id for each project based off of it's current # Retrieve the commit id for each project based off of it's current
# revisionExpr and it is not already a commit id. # revisionExpr and it is not already a commit id.
@ -73,7 +74,8 @@ def _manifest_groups(manifest):
This is the same logic used by Command.GetProjects(), which is used during This is the same logic used by Command.GetProjects(), which is used during
repo sync repo sync
@param manifest: The XmlManifest object Args:
manifest: The XmlManifest object
""" """
mp = manifest.manifestProject mp = manifest.manifestProject
groups = mp.config.GetString('manifest.groups') groups = mp.config.GetString('manifest.groups')
@ -85,9 +87,10 @@ def _manifest_groups(manifest):
def generate_gitc_manifest(gitc_manifest, manifest, paths=None): def generate_gitc_manifest(gitc_manifest, manifest, paths=None):
"""Generate a manifest for shafsd to use for this GITC client. """Generate a manifest for shafsd to use for this GITC client.
@param gitc_manifest: Current gitc manifest, or None if there isn't one yet. Args:
@param manifest: A GitcManifest object loaded with the current repo manifest. gitc_manifest: Current gitc manifest, or None if there isn't one yet.
@param paths: List of project paths we want to update. manifest: A GitcManifest object loaded with the current repo manifest.
paths: List of project paths we want to update.
""" """
print('Generating GITC Manifest by fetching revision SHAs for each ' print('Generating GITC Manifest by fetching revision SHAs for each '
@ -149,8 +152,9 @@ def generate_gitc_manifest(gitc_manifest, manifest, paths=None):
def save_manifest(manifest, client_dir=None): def save_manifest(manifest, client_dir=None):
"""Save the manifest file in the client_dir. """Save the manifest file in the client_dir.
@param client_dir: Client directory to save the manifest in. Args:
@param manifest: Manifest object to save. manifest: Manifest object to save.
client_dir: Client directory to save the manifest in.
""" """
if not client_dir: if not client_dir:
client_dir = manifest.gitc_client_dir client_dir = manifest.gitc_client_dir

6
repo
View File

@ -439,9 +439,11 @@ def get_gitc_manifest_dir():
def gitc_parse_clientdir(gitc_fs_path): def gitc_parse_clientdir(gitc_fs_path):
"""Parse a path in the GITC FS and return its client name. """Parse a path in the GITC FS and return its client name.
@param gitc_fs_path: A subdirectory path within the GITC_FS_ROOT_DIR. Args:
gitc_fs_path: A subdirectory path within the GITC_FS_ROOT_DIR.
@returns: The GITC client name Returns:
The GITC client name.
""" """
if gitc_fs_path == GITC_FS_ROOT_DIR: if gitc_fs_path == GITC_FS_ROOT_DIR:
return None return None