View Issue Details [ Jump to Notes ] | [ Print ] | ||||||||
ID | Project | Category | View Status | Date Submitted | Last Update | ||||
0014108 | CMake | CMake | public | 2013-04-23 03:53 | 2016-06-10 14:31 | ||||
Reporter | chen bin | ||||||||
Assigned To | Kitware Robot | ||||||||
Priority | high | Severity | tweak | Reproducibility | always | ||||
Status | closed | Resolution | moved | ||||||
Platform | all platforms | OS | OS Version | ||||||
Product Version | CMake 2.8.9 | ||||||||
Target Version | Fixed in Version | ||||||||
Summary | 0014108: add test to cover assumption of the cmake --help-command output | ||||||||
Description | I assume the `cmake --help-command mycommand` third is always the description of command. Please KEEP this convention. because my emacs plugin company-cmake are dependent on this. https://github.com/company-mode/company-cmake [^] company-cmake make auto-complete in emacs when writing cmake script possible. Please contact me by email if you want to break this convention in the future. | ||||||||
Tags | No tags attached. | ||||||||
Attached Files | |||||||||
Relationships | |||||||||||
|
Relationships |
Notes | |
(0032924) Eric NOULARD (developer) 2013-04-23 04:11 |
Why would you file a bug/feature request for that purpose while you can gently ask on the CMake developer mailing list? That said, I don't think any reason for which this convention may be broken. By the way, this holds for ctest and cpack as well. There are other effort on the CMake+emacs side: https://github.com/Lindydancer/cmake-font-lock [^] + the cmake mode which is currently in <CMakeSource>/Docs subdirectory. |
(0032926) chen bin (reporter) 2013-04-23 07:07 edited on: 2013-04-23 07:08 |
because issue could be tracked. It's common practice in jira and github to record everything in issue tracker. |
(0032927) Brad King (manager) 2013-04-23 08:07 |
The best way to ensure the convention is kept is to submit a patch adding a test case that verifies it. That way if something breaks the convention it will result in a test failure. |
(0032929) chen bin (reporter) 2013-04-23 19:51 edited on: 2013-04-23 19:53 |
Yes, tdd is a great idea. I think it won't take cmake's talented c++ developer 5 minutes to write down a such test case. I'm a lisp developer and not familiar with cmake internals. It could take me days to write a test case. |
(0032935) Brad King (manager) 2013-04-24 16:18 |
Having thought about this more I think we cannot promise that the --help-command output will remain stable forever. It is meant for human consumption. Instead we could add a "plumbing" command-line option specifically meant to get documentation for machine consumption. |
(0032937) chen bin (reporter) 2013-04-24 22:44 |
do what's most convenient for you. I'm totally fine if you decide to change the output in the future if you could notify me in some way (by email <chenbin.sh AT gmail> or bug tracker at github/company-cmake). |
(0032938) chen bin (reporter) 2013-04-24 22:46 |
btw, could you update wiki on emacs support? |
(0032943) Brad King (manager) 2013-04-25 11:11 |
Re 0014108:0032938: I've factored out the Emacs information from http://www.cmake.org/Wiki/CMake_Editors_Support [^] into its own page at http://www.cmake.org/Wiki/CMake/Editors/Emacs [^] and added a link to company-mode and the CMake completion support repo. |
(0042270) 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. |
Notes |
Issue History | |||
Date Modified | Username | Field | Change |
2013-04-23 03:53 | chen bin | New Issue | |
2013-04-23 04:07 | Eric NOULARD | Description Updated | |
2013-04-23 04:11 | Eric NOULARD | Note Added: 0032924 | |
2013-04-23 04:12 | Eric NOULARD | Relationship added | related to 0013664 |
2013-04-23 04:13 | Eric NOULARD | Relationship added | related to 0013548 |
2013-04-23 07:07 | chen bin | Note Added: 0032926 | |
2013-04-23 07:08 | chen bin | Note Edited: 0032926 | |
2013-04-23 08:07 | Brad King | Note Added: 0032927 | |
2013-04-23 19:51 | chen bin | Note Added: 0032929 | |
2013-04-23 19:52 | chen bin | Note Edited: 0032929 | |
2013-04-23 19:53 | chen bin | Note Edited: 0032929 | |
2013-04-24 08:47 | Brad King | Severity | minor => tweak |
2013-04-24 08:47 | Brad King | Status | new => backlog |
2013-04-24 08:47 | Brad King | Summary | assumption of the cmake --help-command output => add test to cover assumption of the cmake --help-command output |
2013-04-24 16:18 | Brad King | Note Added: 0032935 | |
2013-04-24 22:44 | chen bin | Note Added: 0032937 | |
2013-04-24 22:46 | chen bin | Note Added: 0032938 | |
2013-04-25 11:11 | Brad King | Note Added: 0032943 | |
2016-06-10 14:28 | Kitware Robot | Note Added: 0042270 | |
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 |
Issue History |
Copyright © 2000 - 2018 MantisBT Team |