Re: [edk2-devel][edk2-staging/EdkRepo][PATCH v2 5/8] EdkRepo: Argument Strings Refactor - Sparse Command

["Nate DeSimone" <nathaniel.l.desimone@intel.com>]

Reviewed-by: Nate DeSimone <nathaniel.l.desimone@intel.com>

-----Original Message-----
From: Desimone, Ashley E <ashley.e.desimone@intel.com> 
Sent: Wednesday, November 6, 2019 2:40 PM
To: devel@edk2.groups.io
Cc: Desimone, Nathaniel L <nathaniel.l.desimone@intel.com>; Pandya, Puja <puja.pandya@intel.com>
Subject: [edk2-devel][edk2-staging/EdkRepo][PATCH v2 5/8] EdkRepo: Argument Strings Refactor - Sparse Command

Move all argument strings for sparse_command.py to edkrepo/commands/arguments/sparse_args.py

Signed-off-by: Ashley E Desimone <ashley.e.desimone@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Puja Pandya <puja.pandya@intel.com>
---
 edkrepo/commands/arguments/sparse_args.py | 16 ++++++++++++++++
 edkrepo/commands/sparse_command.py        |  8 ++++----
 edkrepo/common/argument_strings.py        |  4 ----
 3 files changed, 20 insertions(+), 8 deletions(-)  create mode 100644 edkrepo/commands/arguments/sparse_args.py

diff --git a/edkrepo/commands/arguments/sparse_args.py b/edkrepo/commands/arguments/sparse_args.py
new file mode 100644
index 0000000..167334c
--- /dev/null
+++ b/edkrepo/commands/arguments/sparse_args.py
@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+#
+## @file
+# sparse_args.py
+#
+# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR> # 
+SPDX-License-Identifier: BSD-2-Clause-Patent #
+
+''' Contains the help and description strings for arguments in the 
+sparse command meta data.
+'''
+
+COMMAND_DESCRIPTION = 'Displays the current sparse checkout status and enables changing the sparse checkout state.'
+ENABLE_HELP = 'Enables sparse checkout if supported in the project manifest file.'
+DISABLE_HELP = 'Disables sparse checkout if it is currently enabled.'
\ No newline at end of file
diff --git a/edkrepo/commands/sparse_command.py b/edkrepo/commands/sparse_command.py
index a20bd89..5d4ef90 100644
--- a/edkrepo/commands/sparse_command.py
+++ b/edkrepo/commands/sparse_command.py
@@ -8,7 +8,7 @@
 #
 
 from edkrepo.commands.edkrepo_command import EdkrepoCommand -from edkrepo.common.argument_strings import SPARSE_COMMAND_DESCRIPTION, SPARSE_ENABLE_HELP, SPARSE_DISABLE_HELP
+import edkrepo.commands.arguments.sparse_args as arguments
 from edkrepo.config.config_factory import get_workspace_path, get_workspace_manifest  from edkrepo.common.common_repo_functions import sparse_checkout_enabled, sparse_checkout, reset_sparse_checkout  from edkrepo.common.common_repo_functions import check_dirty_repos @@ -24,17 +24,17 @@ class SparseCommand(EdkrepoCommand):
     def get_metadata(self):
         metadata = {}
         metadata['name'] = 'sparse'
-        metadata['help-text'] = SPARSE_COMMAND_DESCRIPTION
+        metadata['help-text'] = arguments.COMMAND_DESCRIPTION
         args = []
         metadata['arguments'] = args
         args.append({'name': 'enable',
                      'positional': False,
                      'required': False,
-                     'help-text': SPARSE_ENABLE_HELP})
+                     'help-text': arguments.ENABLE_HELP})
         args.append({'name': 'disable',
                      'positional': False,
                      'required': False,
-                     'help-text': SPARSE_DISABLE_HELP})
+                     'help-text': arguments.DISABLE_HELP})
         return metadata
 
     def run_command(self, args, config):
diff --git a/edkrepo/common/argument_strings.py b/edkrepo/common/argument_strings.py
index e5146df..50e25ee 100644
--- a/edkrepo/common/argument_strings.py
+++ b/edkrepo/common/argument_strings.py
@@ -41,7 +41,3 @@ UPDATE_LOCAL_MANIFEST_DESCRIPTION = 'Updates the global manifest repository and  UPDATE_LOCAL_MANIFEST_HELP = 'Updates the local manifest file found in the <workspace>/repo directory prior to performing sync operations.'
 SYNC_OVERRIDE_HELP = 'Without this flag sync operations will not be completed if the updated manifest adds/removes repositories or if there are local commits on the target branch.'
 
-#Args for sparse_command.py
-SPARSE_COMMAND_DESCRIPTION = 'Displays the current sparse checkout status and allows for changing the sparse checkout state.'
-SPARSE_ENABLE_HELP = 'Enables sparse checkout if supported by the manifest.'
-SPARSE_DISABLE_HELP = 'Disables sparse checkout if enabled.'
--
2.16.2.windows.1