Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding verbose mode. #789

Closed
wants to merge 6 commits into from

Conversation

aquilamacedo
Copy link
Collaborator

This commit adds support for the verbose parameter within kw build. The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: #179

@aquilamacedo
Copy link
Collaborator Author

Hi @rodrigosiqueira.

I've started implementing the verbose parameter in kw build, do you have any recommendations for something I can change/add?

src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
@aquilamacedo
Copy link
Collaborator Author

Hi @rodrigosiqueira.

I dedicated the commits to another pull request. When you merge, I'll update that pull request to continue the verbose option.

@aquilamacedo aquilamacedo force-pushed the verbose_mode branch 2 times, most recently from 120e7b4 to 499a491 Compare March 20, 2023 18:23
@aquilamacedo
Copy link
Collaborator Author

Hi @rodrigosiqueira. :)

I started to add verbose mode in some parts of the build, but I'm still implementing it for other parameters.

@rodrigosiqueira
Copy link
Collaborator

Any update here?

@aquilamacedo
Copy link
Collaborator Author

Hi @rodrigosiqueira.

The --verbose option works for all build options except in the --info parameter. I wondered if it is worth implementing, as the only commands running in the build_info function are the commands created by get_kernel_release() and get_kernel_versions(). What do you think?

documentation/man/features/build.rst Outdated Show resolved Hide resolved
documentation/man/features/env.rst Outdated Show resolved Hide resolved
@rodrigosiqueira
Copy link
Collaborator

Hi @rodrigosiqueira.

The --verbose option works for all build options except in the --info parameter. I wondered if it is worth implementing, as the only commands running in the build_info function are the commands created by get_kernel_release() and get_kernel_versions(). What do you think?

I think it is worth it. Check get_kernel_* function, and you will see that we are forcing SILENT.

@aquilamacedo aquilamacedo marked this pull request as ready for review March 23, 2023 21:27
@rodrigosiqueira
Copy link
Collaborator

Hi @aquilamacedo , could you finish this PR?

@aquilamacedo
Copy link
Collaborator Author

Hi @aquilamacedo , could you finish this PR?

yes, I'm almost done updating _kw.

documentation/man/features/build.rst Outdated Show resolved Hide resolved
src/build.sh Outdated Show resolved Hide resolved
src/kw_env.sh Show resolved Hide resolved
@aquilamacedo aquilamacedo force-pushed the verbose_mode branch 4 times, most recently from d060439 to 89b302d Compare April 15, 2023 14:50
src/build.sh Outdated Show resolved Hide resolved
src/build.sh Outdated
Comment on lines 369 to 370
--verbose | -v)
options_values['VERBOSE']=1
shift
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a simple unit test for this new parameter (same idea for all the commits in this PR).

@@ -83,6 +84,9 @@ OPTIONS
build process, including configuration files and script output. This option also
considers whether or not the user is using kw env.

-v, \--verbose:
Verbose mode allows the user to see the commands executed under the hood.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use something more formal in the documentation. Something like this:

Verbose mode. Causes kw to print debugging messages about its progress. This is helpful in debugging issues.

(Same idea for all commits)

src/kw_env.sh Show resolved Hide resolved
src/kw_env.sh Outdated Show resolved Hide resolved
src/backup.sh Show resolved Hide resolved
documentation/man/features/mail.rst Outdated Show resolved Hide resolved
src/mail.sh Show resolved Hide resolved
This commit adds support for the verbose parameter within `kw build`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
This commit adds support for the verbose parameter within `kw env`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
This commit adds support for the verbose parameter within `kw backup`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
This commit adds support for the verbose parameter within `kw mail`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
This commit adds support for the verbose parameter within `kw explore`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
This commit adds support for the verbose parameter within `kw drm`.
The verbose parameter gives details of the commands that are executed behind the scenes.

Note: This is part of the issue: kworkflow#179

Signed-off-by: Aquila Macedo <aquilamacedo@riseup.net>
@rodrigosiqueira
Copy link
Collaborator

Merged! Thanks

@aquilamacedo aquilamacedo changed the title src: build: Adding verbose mode. Adding verbose mode. Jun 8, 2023
@aquilamacedo aquilamacedo deleted the verbose_mode branch June 7, 2024 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants