github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 03:03:57 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

create_manpage_completions.py: Do not overstrip commands with dots

Browse Source 
The best effort parser over-eagerly strips all extensions off a manual
page file's basename, hence commands containing dots will output
completions for a different command.

Prominent examples are the mkfs.*(8) and fsck.*(8) families, e.g.
completions for mkfs.xfs.8.gz are generated for the command `mkfs`
is not only incorrect but can also filename collisions in case .fish
files for multiple commands are put into the same directory.

Thus do not strip everything past the first dot from the left, but
instead merely strip expected extensions from the right.
This commit is contained in:
Klemens Nanni 2022-05-29 05:31:32 +02:00 committed by Johannes Altmanninger
parent cf2ca56e34
commit 32d646a548
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
share/tools/create_manpage_completions.py
View File

@ -929,9 +929,15 @@ def parse_and_output_man_pages(paths, output_directory, show_progress):
for manpage_path in paths:
index += 1
# Get the "base" command, e.g. gcc.1.gz -> gcc
# Get the "base" command, e.g. mkfs.xfs.8.gz -> mkfs.xfs
man_file_name = os.path.basename(manpage_path)
CMDNAME = man_file_name.split(".", 1)[0]
# 1. strip the optional compressor suffix
CMDNAME, extension = os.path.splitext(man_file_name)
# 2. strip mandatory section nu:ber
if CMDNAME.endswith((".1", ".2", ".3", ".4", ".5", ".6", ".7", ".8", ".9")):
CMDNAME, extension = os.path.splitext(CMDNAME)
# 3. XXX strip optional version(?) number?
# see comment above `already_output_completions = {}` line
# Show progress if we're doing that
if show_progress: