revisit gentoo-related completions #4758

drwilly · 2018-02-28T12:41:15Z

add completion for emaint
improve completion for emerge
still incomplete, but an impovement regardless
improve completion for equery
add gentoo/portage-related auxiliary functions

- add completion for emaint - improve completion for emerge still incomplete, but an impovement regardless - improve completion for equery - add gentoo/portage-related auxiliary functions

faho · 2018-03-06T22:33:26Z

share/functions/__fish_portage_print_installed_pkgs.fish

@@ -0,0 +1,3 @@
+function __fish_portage_print_installed_pkgs --description 'Print all installed packages'
+	find /var/db/pkg -mindepth 2 -maxdepth 2 -type d -printf '%P\n' | sed 's/-[0-9][0-9.]*.*$//' | sort -u


fish will take care of the deduplication for you - no need to use sort.

Also we prefer our builtins over external commands like sed. Something like

find ... | string replace -r -- '-[0-9][0-9.]*.*$' ''

should work.

Fish's deduplication will only be done if the function is used as input for completion, correct?

Yes. What else do you want to use this for?

Well, there is __fish_print_packages, however I didn't quite understand what the purpose of that function is/was.

Completions. It prints packages for a variety of package managers, so you can theoretically have a tool that takes a name of a system package and complete it just by calling that function.

I don't think a tool like that actually exists, and I've wanted to split it up for a while - because right now if you e.g. have pacman installed (e.g. to create an archlinux container) and try to complete yum it'll suggest pacman's package names, because that's first in __fish_print_packages.

faho · 2018-03-06T22:34:33Z

share/functions/__fish_portage_print_repository_names.fish

@@ -0,0 +1,4 @@
+function __fish_portage_print_repository_names --description 'Print the names of all configured repositories'
+	# repos.conf may be a file or a directory
+	find /etc/portage/repos.conf -type f -exec sed -ne '/^[[:blank:]]*\[[[:alnum:]_][[:alnum:]_-]*\]/{s!^.*\[\(.*\)\].*$!\1!; /DEFAULT/!p}' '{}' +


What does the input here look like?

And what are you trying to extract?

(This goes for print_repository_paths as well)

The format is ini-like, as in

[repository] key = value # comment

In this case the part between [ ] is extracted, and the special "repository" DEFAULT removed from the output.
In the case of print_repository_paths the value of the key "location" is extracted.

Leave it like this for now. If the completions turn out to be slow, this is my guess. But I'd assume few people have hundreds of repository files configured.

It should be <5 for most people. Additionally, the files themselves are rather small.

Also should completion be slow I'd assume it's because gentoo's main repository alone contains ~20k packages.

faho · 2018-03-06T22:37:03Z

share/completions/equery.fish

+complete -c equery -s V -l version -d "display version information"
+
+## Subcommands
+complete -c equery -n '__fish_use_subcommand' -xa 'belongs'     -d '"'(_ 'list all packages owning file(s)')'"'


Descriptions are translated by default - no need to invoke _ at all.

Just -d 'List all packages owning files'.

Also:

Capitalize the first word

Keep descriptions short (i.e. no file(s), just files)

Good, that part was inherited and I left it in just in case.
Capitalization is done.
Descriptions are copy-pasted from the man-page.

faho · 2018-03-06T22:39:35Z

share/completions/equery.fish

+
+# which
+complete -c equery -n '__fish_seen_subcommand_from which' -s m -l include-masked    -d "return highest version ebuild available"


Is that actually the definition?

Can't I have a masked ebuild with a lower version number? From my combined four hours of using Gentoo, I recall seeing ebuilds with a version number of "9999" or something like that.

The definition is copypasted from equery which -h.
The man-page is a only little more elaborate: "Return the path to the hightest version ebuild available."

faho · 2018-03-06T22:40:41Z

share/completions/emerge.fish

+complete -c emerge -s l -l changelog    -d "show changelog of package. Use with --pretend"
+complete -c emerge      -l color        -d "colorized output" \
+	-xa "y n"
+complete -c emerge      -l colums       -d "Align output. Use with --pretend"


I think this is "columns".

faho · 2018-03-06T22:41:30Z

share/completions/emerge.fish

 #########################
-
+complete -c emerge -s A -l alert        -d "add a terminal bell character ('\a') to all interactive prompts"


Does the "interactive" add anything here? Or would just Add a bell ('\a') to all prompts suffice?

As far as I can tell, -A without -a (or any other flag that causes interaction) has no effect.

faho · 2018-03-06T22:42:19Z

share/completions/emaint.fish

+
+## Local opts
+# cleanlogs
+complete -c emaint -n '__fish_seen_subcommand_from cleanlogs' -s t -l time      -d "Delete logs older than NUM of days" \


We sometimes just generate a list of plausible numbers with seq - -xa "(seq 0 60)".

Ok … I guess.

faho · 2018-03-06T22:42:41Z

share/completions/emaint.fish

+complete -c emaint -n '__fish_use_subcommand' -xa 'binhost'     -d 'Scan and generate metadata indexes for binary packages.'
+complete -c emaint -n '__fish_use_subcommand' -xa 'cleanconfmem' -d 'Check and clean the config tracker list for uninstalled packages.'
+complete -c emaint -n '__fish_use_subcommand' -xa 'cleanresume' -d 'Discard emerge --resume merge lists'
+complete -c emaint -n '__fish_use_subcommand' -xa 'logs'        -d 'Check and clean old logs in the PORT_LOGDIR.'


No trailing "." in the descriptions please.

faho · 2018-03-06T22:43:21Z

share/completions/emaint.fish

+complete -c emaint -s c -l check        -d "Check for problems (a default option for most modules)"
+complete -c emaint      -l version      -d "show program's version number and exit"
+complete -c emaint -s f -l fix          -d "Attempt to fix problems (a default option for most modules)"
+complete -c emaint -s P -l purge        -d "Removes the list of previously failed merges. WARNING: Only use this option if you plan on manually fixing them or do not want them re-installed."


The warning's a bit long. Maybe just "DANGEROUS"?

Again, copied from emaint's usage output.
The flag isn't all that "dangerous" actually, it's more the help-message that is overly verbose.
Maybe just something along the lines of "see man-page"?

Yeah, that'll work. Also use the imperative "Remove the list", not "Removes".

faho · 2018-03-06T22:43:57Z

I'm very sorry for the delay! Reviewed now!

faho

More annoying grammar nitpicks.

faho · 2018-03-13T15:24:43Z

share/completions/emaint.fish

@@ -0,0 +1,32 @@
+## Global Opts
+complete -c emaint -s h -l help         -d "show this help message and exit"


Capitalization.

faho · 2018-03-13T15:25:03Z

share/completions/emaint.fish

+## Global Opts
+complete -c emaint -s h -l help         -d "show this help message and exit"
+complete -c emaint -s c -l check        -d "Check for problems (a default option for most modules)"
+complete -c emaint      -l version      -d "show program's version number and exit"


Capitalization.

Also just "Show version and exit" would suffice, I think.

faho · 2018-03-13T15:25:21Z

share/completions/emaint.fish

+complete -c emaint -s h -l help         -d "show this help message and exit"
+complete -c emaint -s c -l check        -d "Check for problems (a default option for most modules)"
+complete -c emaint      -l version      -d "show program's version number and exit"
+complete -c emaint -s f -l fix          -d "Attempt to fix problems (a default option for most modules)"


"Attempt to fix problems (default for most modules)"?

Don't ask me, I just copypaste messages.

https://gitweb.gentoo.org/proj/portage.git/tree/pym/portage/emaint/defaults.py#n6

That was a suggestion for improvement.

faho · 2018-03-13T15:26:09Z

share/completions/emerge.fish

-
+complete -c emerge -s A -l alert        -d "add a terminal bell character ('\a') to all interactive prompts"
+#complete -c emerge      -l alphabetical -d "Sort flag lists alphabetically"
+complete -c emerge -s a -l ask          -d "prompt the user before peforming the merge"


Capitalization.

faho · 2018-03-13T15:26:17Z

share/completions/emerge.fish

+# autounmask-keep-masks
+# autounmask-write
+complete -c emerge      -l backtrack
+complete -c emerge -s b -l buildpkg     -d "build a binary package additionally"


Capitalization.

faho · 2018-03-13T15:26:53Z

share/completions/emerge.fish

+complete -c emerge -s u -l update
+# use-ebuild-visibility
+# useoldpkg-atoms ATOMS
+complete -c emerge -s k -l usepkg       -d "use binary package if available"


Capitalization.

drwilly · 2018-03-13T20:25:52Z

I'm not the developer of either of these programs, and all of these messages are from the official documentation.

faho · 2018-03-13T21:16:25Z

I'm not the developer of either of these programs, and all of these messages are from the official documentation.

Sure. But this isn't the official documentation. This is a completion script for fish.

And these descriptions serve a different purpose than the official documentation. They are here to get you to quickly select the option you want.

That means that they shouldn't be outright wrong, but they should be short and to the point, especially because the shorter they are the more we can use additional columns, which allows for more flexible movement, which means you get the option quicker. (That even means that in some cases they can gloss over some things, but that's not even the case here)

And they should be consistently capitalized because that's just simply less distracting.

faho · 2018-03-14T12:15:47Z

share/completions/emaint.fish

@@ -1,32 +1,32 @@
 ## Global Opts
 complete -c emaint -s h -l help         -d "show this help message and exit"
-complete -c emaint -s c -l check        -d "Check for problems (a default option for most modules)"
+complete -c emaint -s c -l check        -d "check for problems"


Ummmhh.. other way around, please!

It should be "Check for problems", not "check for problems".

faho · 2018-03-23T18:42:43Z

Merged, thanks and sorry for the delay!

drwilly · 2018-03-24T17:45:41Z

No worries.

* revisit gentoo-related completions - add completion for emaint - improve completion for emerge still incomplete, but an impovement regardless - improve completion for equery - add gentoo/portage-related auxiliary functions * fix spelling * remove trailing '.' * remove old '_' invocation and capitalize descriptions * add number-completion * remove trailing '.' * shorter descriptions * replace sed with fish-builtin and drop deduplication * batch change capitalization (lower case) * indent equery descriptions * batch change capitalization (upper case)

revisit gentoo-related completions

5a33b8a

- add completion for emaint - improve completion for emerge still incomplete, but an impovement regardless - improve completion for equery - add gentoo/portage-related auxiliary functions

faho requested changes Mar 6, 2018

View reviewed changes

faho added enhancement completions labels Mar 6, 2018

faho added this to the fish-3.0 milestone Mar 6, 2018

drwilly added 7 commits March 7, 2018 01:05

fix spelling

d19b14b

remove trailing '.'

07411bd

remove old '_' invocation and capitalize descriptions

8cde4a9

add number-completion

14b1034

remove trailing '.'

e89096a

shorter descriptions

43336e7

replace sed with fish-builtin and drop deduplication

35e0cd4

faho requested changes Mar 13, 2018

View reviewed changes

drwilly added 2 commits March 14, 2018 11:27

batch change capitalization (lower case)

2a51b5a

indent equery descriptions

82277f8

faho reviewed Mar 14, 2018

View reviewed changes

batch change capitalization (upper case)

db792d3

faho merged commit 44e2c28 into fish-shell:master Mar 23, 2018

github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2020

		@@ -0,0 +1,3 @@
		function __fish_portage_print_installed_pkgs --description 'Print all installed packages'
		find /var/db/pkg -mindepth 2 -maxdepth 2 -type d -printf '%P\n' \| sed 's/-[0-9][0-9.].$//' \| sort -u


		# which
		complete -c equery -n '__fish_seen_subcommand_from which' -s m -l include-masked -d "return highest version ebuild available"

		#########################

		complete -c emerge -s A -l alert -d "add a terminal bell character ('\a') to all interactive prompts"

		@@ -0,0 +1,32 @@
		## Global Opts
		complete -c emaint -s h -l help -d "show this help message and exit"

revisit gentoo-related completions #4758

revisit gentoo-related completions #4758

Conversation

drwilly commented Feb 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

faho Mar 7, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drwilly Mar 6, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

faho commented Mar 6, 2018

faho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drwilly commented Mar 13, 2018

faho commented Mar 13, 2018

Choose a reason for hiding this comment

faho commented Mar 23, 2018

drwilly commented Mar 24, 2018

faho Mar 7, 2018 •

edited

drwilly Mar 6, 2018 •

edited