zsh-users/zsh-completions

cmake completion for --find-package lacks required -D arguments

Open

#593 opened on Sep 3, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Shell (6,175 stars) (693 forks)batch import
Bughelp wanted

Description

The current cmake completion does not suggest the -D arguments that are required when running --find-package. See also stackoverflow.

Essentially, when one uses --find-package, also -DNAME must be set. Otherwise cmake complains:

CMake Error at /usr/share/cmake-3.12/Modules/CMakeFindPackageMode.cmake:33 (message):
  Name of the package to be searched not specified.  Set the CMake variable
  NAME, e.g.  -DNAME=JPEG .

Further down the line one gets

CMake Error at /usr/share/cmake-3.12/Modules/CMakeFindPackageMode.cmake:37 (message):
  COMPILER_ID argument not specified.  In doubt, use GNU.

then

CMake Error at /usr/share/cmake-3.12/Modules/CMakeFindPackageMode.cmake:41 (message):
  LANGUAGE argument not specified.  Use C, CXX or Fortran.

and eventually

CMake Error at /usr/share/cmake-3.12/Modules/CMakeFindPackageMode.cmake:45 (message):
  MODE argument not specified.  Use either EXIST, COMPILE or LINK.

I.e. --find-package implies that -DNAME=, -DLANGUAGE=, -DCOMPILER_ID= and -DMODE= are provided. The possible values are spelled out in the error messages above.

I don't see how to add that myself to the current completion (given time constraints and priorities).

Contributor guide

Tech stack
shell
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic zsh completioncmake find package knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the existing cmake completion file (likely ` cmake`) in the repository. Add logic to suggest ` DNAME=`, ` DCOMPILER ID=`, ` DLANGUAGE=`, and ` DMODE=` options when ` find package` is present. The possible values are given in the error messages: NAME can be any package name, COMPILER ID can be GNU, Clang, etc., LANGUAGE can be C, CXX, Fortran, MODE can be EXIST, COMPILE, LINK. You may need to parse the existing completion to understand how to add these dynamically.