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

list-commands not bold #3325

Open
Chemin1 opened this issue Dec 7, 2019 · 3 comments
Open

list-commands not bold #3325

Chemin1 opened this issue Dec 7, 2019 · 3 comments
Labels
bug

Comments

@Chemin1
Copy link
Contributor

@Chemin1 Chemin1 commented Dec 7, 2019

In the Docker container for running all tests.

Elektra compiled from ad0ac3d.
GNOME Terminal 3.28.2.

Does not work

doc/help/kdb-list-commands.md says there should be bold output but either I get an error or no bold output.

jenkins@0d2b25b79bdb:~/workspace/elektra-build-docker$ kdb -C always list-commands
The command kdb -C is not known
Usage: kdb <command> [args]

kdb is a program to manage Elektra's key database.
Please run a command with -H or --help as args to show a help text for
a specific command.

Known commands are:
cache	Enable, disable or clear the cache.
complete	Show suggestions how to complete key names.
convert	Convert configuration.
cp	Copy keys within the key database.
(...)
rm	Remove key(s) from key database.
set	Set the value of an individual key.
sget	Get the value of an individual key within a shell script.
shell	Start a kdb shell.
smount	Mount a new backend by specification. All necessary plugins will be loaded automatically, depending on the metadata.
spec-mount	Mount a new backend by specification. All necessary plugins will be loaded automatically, depending on the metadata.
test	Run key database test suite.
umount	Unmount backend from key database.
jenkins@0d2b25b79bdb:~/workspace/elektra-build-docker$ kdb list-commands -C always
cache
complete
convert
cp
editor
(...)
test
umount
@Chemin1 Chemin1 added the bug label Dec 7, 2019
@markus2330

This comment has been minimized.

Copy link
Contributor

@markus2330 markus2330 commented Dec 8, 2019

Thank you for reporting this bug!

says there should be bold output

Can you say what you read and what you expected?

I only see one occurrence of "bold" and it is next to the command-line option -v. For me the commands are bold if I add this option.

See: src/tools/kdb/listcommands.cpp

kdb -C always list-commands

The command must always be the first after kdb. I agree this could be more clear in the kdb man page.

Chemin1 added a commit to Chemin1/libelektra that referenced this issue Dec 8, 2019
Improve synopsis.
Make terms more consistent (also to existing GNU man pages)
and use more concise phrases.

Related to: ElektraInitiative#3325
@Chemin1 Chemin1 mentioned this issue Dec 8, 2019
5 of 16 tasks complete
@Chemin1

This comment has been minimized.

Copy link
Contributor Author

@Chemin1 Chemin1 commented Dec 8, 2019

After reading your answer I don't think that this is a bug anymore. I think my problem was that I thought that specifying-C (also when default) would turn the list bold every time. Now it is clear to me, that this is only true if -v is specified.

Even though this makes sense to distinguish it from the description coming from -v, I think it's also a bit strange that the color changes depending on other options than -C.

I rewrote the man page a bit to address for example my problem with the synopsis.

@Chemin1 Chemin1 closed this Dec 8, 2019
@markus2330

This comment has been minimized.

Copy link
Contributor

@markus2330 markus2330 commented Dec 9, 2019

I reopen as it not yet merged. Furthermore the second point "The command must always be the first after kdb." is not yet dealt with.

@markus2330 markus2330 reopened this Dec 9, 2019
Chemin1 added a commit to Chemin1/libelektra that referenced this issue Dec 16, 2019
Improve synopsis.
Make terms more consistent (also to existing GNU man pages)
and use more concise phrases.

Related to: ElektraInitiative#3325
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.