doc: extensions: application: Add args for debug related commands

The same as flash-args for flash, we will add commands to debug,
debugserver, and attach to specify arguments in the document.

Signed-off-by: TOKITA Hiroshi <[email protected]>

Author: soburi

doc/_extensions/zephyr/application.py

@@ -44,6 +44,9 @@ class ZephyrAppCommandsDirective(Directive):
         'compact': directives.flag,
         'west-args': directives.unchanged,
         'flash-args': directives.unchanged,
+        'debug-args': directives.unchanged,
+        'debugserver-args': directives.unchanged,
+        'attach-args': directives.unchanged,
     }
 
     TOOLS = ['cmake', 'west', 'all']
@@ -76,6 +79,9 @@ def run(self):
         compact = 'compact' in self.options
         west_args = self.options.get('west-args', None)
         flash_args = self.options.get('flash-args', None)
+        debug_args = self.options.get('debug-args', None)
+        debugserver_args = self.options.get('debugserver-args', None)
+        attach_args = self.options.get('attach-args', None)
 
         if tool not in self.TOOLS:
             raise self.error(f'Unknown tool {tool}; choose from: {self.TOOLS}')
@@ -146,6 +152,9 @@ def run(self):
             'generator': generator,
             'west_args': west_args,
             'flash_args': flash_args,
+            'debug_args': debug_args,
+            'debugserver_args': debugserver_args,
+            'attach_args': attach_args,
             }
 
         if 'west' in tools:
@@ -199,6 +208,9 @@ def _generate_west(self, **kwargs):
         build_args = kwargs["build_args"]
         west_args = kwargs['west_args']
         flash_args = kwargs['flash_args']
+        debug_args = kwargs['debug_args']
+        debugserver_args = kwargs['debugserver_args']
+        attach_args = kwargs['attach_args']
         kwargs['board'] = None
         # west always defaults to ninja
         gen_arg = ' -G\'Unix Makefiles\'' if generator == 'make' else ''
@@ -207,6 +219,9 @@ def _generate_west(self, **kwargs):
         build_args = "".join(f" -o {b}" for b in build_args) if build_args else ""
         west_args = f' {west_args}' if west_args else ''
         flash_args = f' {flash_args}' if flash_args else ''
+        debug_args = f' {debug_args}' if debug_args else ''
+        debugserver_args = f' {debugserver_args}' if debugserver_args else ''
+        attach_args = f' {attach_args}' if attach_args else ''
         snippet_args = ''.join(f' -S {s}' for s in snippets) if snippets else ''
         shield_args = ''.join(f' --shield {s}' for s in shield) if shield else ''
         # ignore zephyr_app since west needs to run within
@@ -255,11 +270,11 @@ def _generate_west(self, **kwargs):
             elif goal == 'flash':
                 content.append(f'west flash{flash_args}{dst}')
             elif goal == 'debug':
-                content.append(f'west debug{dst}')
+                content.append(f'west debug{debug_args}{dst}')
             elif goal == 'debugserver':
-                content.append(f'west debugserver{dst}')
+                content.append(f'west debugserver{debugserver_args}{dst}')
             elif goal == 'attach':
-                content.append(f'west attach{dst}')
+                content.append(f'west attach{attach_args}{dst}')
             else:
                 content.append(f'west build -t {goal}{dst}')
 

doc/contribute/documentation/guidelines.rst

@@ -883,6 +883,21 @@ Application build commands
 
       If set, additional arguments to the flash invocation.
 
+   .. rst:directive:option:: debug-args
+      :type: string
+
+      If set, additional arguments to the debug invocation.
+
+   .. rst:directive:option:: debugserver-args
+      :type: string
+
+      If set, additional arguments to the debugserver invocation.
+
+   .. rst:directive:option:: attach-args
+      :type: string
+
+      If set, additional arguments to the attach invocation.
+
    .. rst:directive:option:: snippets
       :type: string