View Issue Details [ Jump to Notes ]

[ Print ]

Project

Category

View Status

Date Submitted

Last Update

0012643

CMake

(No Category)

public

2011-12-29 17:56

2016-06-10 14:31

Reporter

Brian Helba

Assigned To

Kitware Robot

Priority

normal

Severity

feature

Reproducibility

have not tried

Status

closed

Resolution

moved

Platform

OS Version

Product Version

Target Version

Fixed in Version

Summary

0012643: Command to highlight cache entry in cmake-gui

Description

Command to highlight cache entry in cmake-gui

In cmake-gui (and in ccmake?), new cache entries from the most recent configure step are highlighted in red and appear in their own category.

It would be desirable to have a CMake command that causes given cache entry(s) to be highlighted in the same manner, possibly in a different color.

The proposed command would have no semantic effect on a CMake script, it would only increase the visibility of the cache entries to the user. Each new configure step would reset all previously highlighted entries to normal.

Possible syntax:
highlight_variables(<cache_variable> [<cache_variable> ...])

Steps To Reproduce

Such a feature would be useful when a certain variable is the cause of an error. Currently, when a variable needs user attention, the workflow is:
  - See that configure step failed / errors occurred
  - Carefully look through all error messages, trying to understand the error
  - Read the entire error message; hopefully the cache variable causing the error will be printed
  - Find the cache entries in the list, scanning through all other cache entries or typing in a search; both are slow
  - If the user's attention is distracted or other cache entries need to be examined, perform the previous step again

With this feature:
  - See that configure step failed / errors occurred
  - Notice that cache entry(s) are highlighted and in their own group
  - Fix the cache entry directly if it's obvious, or consult the error messages for further information

Additional Information

In addition to a standalone command, the 'message' command's API could be expanded to allow the same functionality for convenience:

  message([SEND_ERROR | STATUS | FATAL_ERROR]
          "message to display" ...)
          [HIGHLIGHT_VARIABLES <cache_variable> [<cache_variable> ...]]
         )

Tags

No tags attached.

Attached Files

Relationships

Notes
(0028089) Brad King (manager) 2012-01-02 13:24	We wouldn't need a separate command for this. The information can be specified as a cache entry property: http://www.cmake.org/cmake/help/cmake-2-8-docs.html#command:set_property [^] http://www.cmake.org/cmake/help/cmake-2-8-docs.html#section_PropertiesonCacheEntries [^] set_property(CACHE MY_VARIABLE PROPERTY GUI_HIGHLIGHT ${COLOR})

(0030343) David Cole (manager) 2012-08-11 21:09	Sending old, never assigned issues to the backlog. (The age of the bug, plus the fact that it's never been assigned to anyone means that nobody is actively working on it...) If an issue you care about is sent to the backlog when you feel it should have been addressed in a different manner, please bring it up on the CMake mailing list for discussion. Sign up for the mailing list here, if you're not already on it: http://www.cmake.org/mailman/listinfo/cmake [^] It's easy to re-activate a bug here if you can find a CMake developer who has the bandwidth to take it on, and ferry a fix through to our 'next' branch for dashboard testing.

(0041949) Kitware Robot (administrator) 2016-06-10 14:28	Resolving issue as `moved`. This issue tracker is no longer used. Further discussion of this issue may take place in the current CMake Issues page linked in the banner at the top of this page.

Issue History
Date Modified	Username	Field	Change
2011-12-29 17:56	Brian Helba	New Issue
2012-01-02 13:24	Brad King	Note Added: 0028089
2012-08-11 21:09	David Cole	Status	new => backlog
2012-08-11 21:09	David Cole	Note Added: 0030343
2016-06-10 14:28	Kitware Robot	Note Added: 0041949
2016-06-10 14:28	Kitware Robot	Status	backlog => resolved
2016-06-10 14:28	Kitware Robot	Resolution	open => moved
2016-06-10 14:28	Kitware Robot	Assigned To	=> Kitware Robot
2016-06-10 14:31	Kitware Robot	Status	resolved => closed