Skip to content

[action] [PR:4266] [console] add config console escape#320

Merged
lizhijianrd merged 1 commit intoAzure:202603from
mssonicbld:cherry/msft-202603/4266
Apr 23, 2026
Merged

[action] [PR:4266] [console] add config console escape#320
lizhijianrd merged 1 commit intoAzure:202603from
mssonicbld:cherry/msft-202603/4266

Conversation

@mssonicbld
Copy link
Copy Markdown
Collaborator

What I did

Add escape char config to console feature.
In CONFIG_DB, an optional new entry under CONSOLE_SWITCH, "console_mgmt", is added, "default_escape_char" as the key and we expect a lower case letter as value. Similarly, an optional new entry under CONSOLE_PORT, and then each line, "escape_char" as the key and we also expect a lower case letter as value.
Commands are:

  1. config console default_escape (upper and lower case letters, or clear), e.g. config console default_escape k, config console default_escape B, config console default_escape clear.
  2. config console escape [LINE_NUMBER] (upper and lower case letters, or clear), e.g. config console escape 6 C, config console escape 5 clear
  3. show line --show-escape, e.g. show line --show-escape, show line -s -b
    Connect command work as usual, except that it will add --escape <escape_char> in the underlying picocom command if it is configured.

Additionally,

  1. some style change to old code to pass pre-commit check
  2. unit tests for new functions
  3. enhancement to old unit tests and its bug fix

How I did it

Implement them

How to verify it

Run the commands in dut.

Signed-off-by: Sonic Build Admin sonicbld@microsoft.com

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

<!--
    Please make sure you've read and understood our contributing guidelines:
    https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md

    ** Make sure all your commits include a signature generated with `git commit -s` **

    If this is a bug fix, make sure your description includes "closes #xxxx",
    "fixes #xxxx" or "resolves #xxxx" so that GitHub automatically closes the related
    issue when the PR is merged.

    If you are adding/modifying/removing any command or utility script, please also
    make sure to add/modify/remove any unit tests from the tests
    directory as appropriate.

    If you are modifying or removing an existing 'show', 'config' or 'sonic-clear'
    subcommand, or you are adding a new subcommand, please make sure you also
    update the Command Line Reference Guide (doc/Command-Reference.md) to reflect
    your changes.

    Please provide the following information:
-->

#### What I did
Add escape char config to console feature.
In CONFIG_DB, an optional new entry under CONSOLE_SWITCH, "console_mgmt", is added, "default_escape_char" as the key and we expect a lower case letter as value. Similarly, an optional new entry under CONSOLE_PORT, and then each line, "escape_char" as the key and we also expect a lower case letter as value.
Commands are:
1. config console default_escape (upper and lower case letters, or clear), e.g. config console default_escape k, config console default_escape B, config console default_escape clear.
2. config console escape [LINE_NUMBER] (upper and lower case letters, or clear), e.g. config console escape 6 C, config console escape 5 clear
3. show line --show-escape, e.g. show line --show-escape, show line -s -b
Connect command work as usual, except that it will add --escape <escape_char> in the underlying picocom command if it is configured.

Additionally,
1. some style change to old code to pass pre-commit check
2. unit tests for new functions
3. enhancement to old unit tests and its bug fix

#### How I did it
Implement them

#### How to verify it
Run the commands in dut.

Signed-off-by: Sonic Build Admin <sonicbld@microsoft.com>

#### Previous command output (if the output of a command-line utility has changed)

#### New command output (if the output of a command-line utility has changed)
@mssonicbld
Copy link
Copy Markdown
Collaborator Author

Original PR: sonic-net/sonic-utilities#4266

@mssonicbld
Copy link
Copy Markdown
Collaborator Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@lizhijianrd lizhijianrd merged commit 299cfa4 into Azure:202603 Apr 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants