Update odo debug --help screen #3963

cdrage · 2020-09-15T20:06:49Z

What type of PR is this?

/kind cleanup

What does does this PR do / why we need it:

Updates the debug output of odo debug --help to the following:

github.com/openshift/odo  debugging-docs-update ✔                                                                                                                                                                                                                                                                                                                      53m
▶ ./odo debug --help
Debug allows you to remotely debug your application.

Usage:
  odo debug [flags]
  odo debug [command]

Aliases:
  debug, d

Examples:
  # Listen on default port and forwarding to the default port in the pod
  odo debug port-forward

  # Listen on the 5000 port locally, forwarding to default port in the pod
  odo debug port-forward --local-port 5000

  # Get information regarding any debug session of the component
  odo debug info

Available Commands:
  info         Displays debug info of a component
  port-forward Forward one or more local ports to a pod

Flags:
  -h, --help   Help for debug

Additional Flags:
  -v, --v Level              Number for the log level verbosity. Level varies from 0 to 9 (default 0).
      --vmodule moduleSpec   Comma-separated list of pattern=N settings for file-filtered logging

Use "odo debug [command] --help" for more information about a command.

Which issue(s) this PR fixes:

Closes #3871

PR acceptance criteria:

Unit test
Integration test
Documentation
I have read the test guidelines

How to test changes / Special notes to the reviewer:

mik-dass · 2020-09-16T09:07:03Z

pkg/odo/cli/debug/portforward.go

-			Forward a local port to a remote port on the pod where the application is listening for a debugger.
-
-			By default the local port and the remote port will be same. To change the local port you can use --local-port argument and to change the remote port use "odo config set DebugPort <port>"   		  
+	portforwardLong = templates.LongDesc(`Forward a local port to a remote port on the pod where the application is listening for a debugger. By default the local port and the remote port will be same. To change the local port you can use --local-port argument and to change the remote port use "odo config set DebugPort <port>"   		  


For devfile components, config set doesn't work.

[mrinaldas@localhost project]$ odo config set DebugPort 5858 ✗ unknown parameter :'debugport' is not a configurable parameter in the devfile

It has been changed to env set for devfile components.

Thanks! Updated.

**What type of PR is this?** /kind cleanup **What does does this PR do / why we need it**: Updates the debug output of `odo debug --help` to the following: ```sh github.com/openshift/odo debugging-docs-update ✔ 53m ▶ ./odo debug --help Debug allows you to remotely debug your application. Usage: odo debug [flags] odo debug [command] Aliases: debug, d Examples: # Listen on default port and forwarding to the default port in the pod odo debug port-forward # Listen on the 5000 port locally, forwarding to default port in the pod odo debug port-forward --local-port 5000 # Get information regarding any debug session of the component odo debug info Available Commands: info Displays debug info of a component port-forward Forward one or more local ports to a pod Flags: -h, --help Help for debug Additional Flags: -v, --v Level Number for the log level verbosity. Level varies from 0 to 9 (default 0). --vmodule moduleSpec Comma-separated list of pattern=N settings for file-filtered logging Use "odo debug [command] --help" for more information about a command. ``` **Which issue(s) this PR fixes**: Fixes #? **PR acceptance criteria**: - [ ] Unit test - [ ] Integration test - [ ] Documentation - [ ] I have read the [test guidelines](https://github.com/openshift/odo/blob/master/docs/dev/test-architecture.adoc) **How to test changes / Special notes to the reviewer**:

girishramnani · 2020-09-16T18:15:07Z

/approve

openshift-ci-robot · 2020-09-16T18:15:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: girishramnani

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [girishramnani]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kadel · 2020-09-18T12:21:28Z

/lgtm

openshift-bot · 2020-09-18T14:29:45Z

/retest