process_console command history #15

CosminGGeorgescu · 2023-01-09T21:19:03Z

Pull Request Overview

This pull request adds an easy-to-use Bash-like command history for the process console.

Added features

User can enable/disable the command history from the board's main.rs.
If enabled, user can scroll up or down by pressing up and down arrow keys respectively.
Pressing on accident up or down arrow saves the unfinished command and can be fetched back by going to the bottom of command history.
Modifying a command from history is also saved (if accidentally pressed up or down arrow).
Empty commands (whitespace-filled) don't get registered in the command history.
Invalid commands also are saved into the history structure.

Code size for IMIX binary build with enabled/disabled command history:

Build	.text	.bss	.dec
Tock master	174468	29592	204060
Enabled with default size	175492	28944	204436
Disabled	174292	28576	202868

Testing Strategy

The implementation of the command history was tested on the nrf52840dk and esp32-c3-devkitM-1 boards.

Files changed

capsules/process_console.rs
~ implementation for command history

boards/components/process_console.rs
~ added a new branch to process_console_component_static macro for easily enable/disable the command history

Documentation Updated

Updated the documentation in doc/Process_Console.md accordingly :

Code support on how to enable/disable the command history
How to use command history
Support for selecting a custom size for the command history

Formatting

Ran make prepush

First drat of TRD for license and copyright rules for the Tock project.

…ignore all files without license headers.

capsules/src/process_console.rs

valexandru · 2023-01-10T11:52:36Z

Also, a recommendation is to run make prepush before pushing the code.

capsules/src/process_console.rs

alexandruradovici · 2023-01-13T11:52:58Z

You can both chat using https://gitter.im/UPB-CS-OpenSourceUpstream/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link

alexandruradovici · 2023-01-13T14:39:20Z

Our suggestion is to do one of the following:

as this pull request is more complete, @MATrix22 clones this pull request branch from @CosminGGeorgescu, makes the changes to the data types and applies the const generics (<const ...>) to it, and resubmits the pull reqeuest
@CosminGGeorgescu gives access to @MATrix22 to his repository so that he can push the changes directly to this pull request

CosminGGeorgescu · 2023-01-13T16:03:33Z

I would go with the second bullet-point, if it's ok with you @MATrix22.

mihai-negru · 2023-01-13T16:06:37Z

I would go with the second bullet-point, if it's ok with you @MATrix22.

Yes, it is ok, i will try to make the modifications on Sunday if it's alright?

…ate examples, include "Copyright Tock Contributors" in the examples.

License policy 2023-01-23 core call updates

…ividual contributor copyright from the main example.

mihai-negru · 2023-01-13T23:28:16Z

I would go with the second bullet-point, if it's ok with you @MATrix22.

@CosminGGeorgescu I created this char room to discuss futher implementations

mihai-negru · 2023-01-14T09:38:36Z

Testing the implementation on the nrf52840dk chip I found that typing the same command multiple times when pressing the up arrow promts all the inserted commands multiple times even though they are the same, I think it would be better if the command equals to the previous command we should not to insert into the structure. @CosminGGeorgescu what do you thing about this?

CosminGGeorgescu · 2023-01-14T13:42:44Z

Intended as to mimic an unconfigured Bash. However, if @alexandruradovici or @valexandru object, a ignoredups / erasedups behaviour can be implemented.

alexandruradovici · 2023-01-14T13:50:13Z

@CosminGGeorgescu do you have any branch protection? @MATrix22 gers an error when trying to push to.

CosminGGeorgescu · 2023-01-14T14:01:32Z

@CosminGGeorgescu do you have any branch protection? @MATrix22 gers an error when trying to push to.

Should be good by now.

…ommand history is disabled

…ion for the ProcessConsole using custom COMMAND_HISTORY_LEN

…licts

…ing bytes

…d panic

…d, just the modifications were registred, not all command

…r down arrow key

…ces and remove unnecessary white spaces between command words

…ing + adding new bytes does not accumulate test between unfinished commands

alexandruradovici

Let's send this to upstream. When writing the pull request, please fill out the form from the pull request template and actually run the make prepush command.

CosminGGeorgescu · 2023-01-23T13:09:10Z

PR sent tock#3381.

alexandruradovici · 2023-01-23T13:10:18Z

Please write the full pull request message from here to upstream, including the code sizes and the fact that this changes does actually decrease code size if disabled.

Co-authored-by: Alexandru Radovici <msg4alex@gmail.com>

Instead of checking if the buffer is filled up, try to get the byte from the desired position. If returns Some(byte_buffer) update the byte from `EOL` to `byte`, if None returned do nothing. (P.S: the same functionality is achieved). Tested on `nrf52840dk` and works as expected.

Just changed the inner method to match the same style as the `insert_byte` method (also tested on the `nrf52840dk` board).

ppannuto and others added 10 commits November 5, 2022 09:57

trd: license and copyright policy

e2f9b0b

First drat of TRD for license and copyright rules for the Tock project.

Update license TRD based on comments

6d6954d

doc: trd: legal: remove periods in section names

21609c7

Add a license checking tool.

c8f5fcf

Add a -v flag that prints which files are checked, and temporarily …

af474a6

…ignore all files without license headers.

.lcignore typo fix

f858148

Addressed comments in trd-legal

32e240d

trd-legal: Require copyright notices

eee8996

Make debug buffer size configurable when using the component

abc3d68

Increase default debug buffer size to 2kB for all boards except hifive1

4027788

github-actions bot added the component label Jan 9, 2023

valexandru reviewed Jan 10, 2023

View reviewed changes

capsules/src/process_console.rs Outdated Show resolved Hide resolved

CosminGGeorgescu force-pushed the process_console_history branch from ba4b649 to f44fb38 Compare January 10, 2023 11:35

valexandru reviewed Jan 10, 2023

View reviewed changes

capsules/src/process_console.rs Outdated Show resolved Hide resolved

capsules/src/process_console.rs Outdated Show resolved Hide resolved

capsules/src/process_console.rs Outdated Show resolved Hide resolved

CosminGGeorgescu requested a review from valexandru January 11, 2023 15:59

alexandruradovici requested changes Jan 13, 2023

View reviewed changes

capsules/src/process_console.rs Outdated Show resolved Hide resolved

jrvanwhy added 3 commits January 13, 2023 09:59

2023-01-23 core call updates: allow exceptions for vendored docs, upd…

bca7400

…ate examples, include "Copyright Tock Contributors" in the examples.

Merge pull request tock#3377 from jrvanwhy/doc-copy-license

c09022c

License policy 2023-01-23 core call updates

License headers: allow multiple newlines after the header, remove ind…

762ac74

…ividual contributor copyright from the main example.

alexandruradovici added the needs-rebase The pull request needs to be rebased due to conflicts with the master. label Jan 14, 2023

mihai-negru and others added 18 commits January 21, 2023 20:09

Solved the issue witht he PartialEq for the Command Structure

e66b900

Updated PartialEq trait implementation for the Command Structure

5ad7d93

Moved matching commas to the end of the macro args list

d0f0795

Updated Command write method

910fd17

Added a guard if in order not to check for up and down arrow if the c…

a9f6150

…ommand history is disabled

Copied the ProcessConsole from the upstream adnd added new documentat…

9f33463

…ion for the ProcessConsole using custom COMMAND_HISTORY_LEN

Deleted ProcessConsole documentation, because is causing merging conf…

10f364f

…licts

Added documentation for the history utility in the Process_Console.md

306f5f3

Run make ci-job-markdown-toc and seemed to be successful

d7de3ff

retain unsend command upon browsing

de2f256

Solved panic for COMMAND_HISTORY_LEN == 0 and buffer overflow on writ…

b8bbef4

…ing bytes

Reset the history index to None when enter is pressed

6d26239

Solved acummulation of unfinished command into the buyffer that cause…

fb0862a

…d panic

Solved Issue: When scrolling in the history if one command is modifie…

177b126

…d, just the modifications were registred, not all command

Modified the documentation to inform about accidents by pressing up o…

c14c34b

…r down arrow key

Modified the CUSTOM_HISTORY_LEN to COMMAND_HISTORY_LEN in docs

72fb232

Solved Issue: Do not register an unfinished command full of white spa…

10093b9

…ces and remove unnecessary white spaces between command words

Solved Issue: deleting bytes register command as unfinished and delet…

3726a3e

…ing + adding new bytes does not accumulate test between unfinished commands

mihai-negru force-pushed the process_console_history branch from 2ceb400 to 3726a3e Compare January 21, 2023 20:12

alexandruradovici removed the needs-rebase The pull request needs to be rebased due to conflicts with the master. label Jan 23, 2023

alexandruradovici previously approved these changes Jan 23, 2023

View reviewed changes

alexandruradovici added the upstream This pull request was opened in the upstream reposiotry label Jan 23, 2023

Update doc/Process_Console.md

f0cefb0

Co-authored-by: Alexandru Radovici <msg4alex@gmail.com>

CosminGGeorgescu dismissed alexandruradovici’s stale review via f0cefb0 January 27, 2023 14:15

mihai-negru added 2 commits February 1, 2023 15:32

Updated delete_last_byte method.

d750937

Just changed the inner method to match the same style as the `insert_byte` method (also tested on the `nrf52840dk` board).

alexandruradovici closed this Feb 8, 2023

mihai-negru deleted the process_console_history branch February 20, 2023 06:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

process_console command history #15

process_console command history #15

CosminGGeorgescu commented Jan 9, 2023 •

edited

Loading

valexandru commented Jan 10, 2023

alexandruradovici commented Jan 13, 2023

alexandruradovici commented Jan 13, 2023

CosminGGeorgescu commented Jan 13, 2023

mihai-negru commented Jan 13, 2023

mihai-negru commented Jan 13, 2023

mihai-negru commented Jan 14, 2023

CosminGGeorgescu commented Jan 14, 2023

alexandruradovici commented Jan 14, 2023

CosminGGeorgescu commented Jan 14, 2023 •

edited

Loading

alexandruradovici left a comment

CosminGGeorgescu commented Jan 23, 2023

alexandruradovici commented Jan 23, 2023

process_console command history #15

process_console command history #15

Conversation

CosminGGeorgescu commented Jan 9, 2023 • edited Loading

Pull Request Overview

Added features

Code size for IMIX binary build with enabled/disabled command history:

Testing Strategy

Files changed

Documentation Updated

Formatting

valexandru commented Jan 10, 2023

alexandruradovici commented Jan 13, 2023

alexandruradovici commented Jan 13, 2023

CosminGGeorgescu commented Jan 13, 2023

mihai-negru commented Jan 13, 2023

mihai-negru commented Jan 13, 2023

mihai-negru commented Jan 14, 2023

CosminGGeorgescu commented Jan 14, 2023

alexandruradovici commented Jan 14, 2023

CosminGGeorgescu commented Jan 14, 2023 • edited Loading

alexandruradovici left a comment

Choose a reason for hiding this comment

CosminGGeorgescu commented Jan 23, 2023

alexandruradovici commented Jan 23, 2023

CosminGGeorgescu commented Jan 9, 2023 •

edited

Loading

CosminGGeorgescu commented Jan 14, 2023 •

edited

Loading