[MDEV-15913] Make cmake comments more consistent Created: 2018-04-18  Updated: 2018-07-19  Resolved: 2018-07-19

Status: Closed
Project: MariaDB Server
Component/s: OTHER
Affects Version/s: None
Fix Version/s: N/A

Type: Bug Priority: Trivial
Reporter: Terry Tibbles Assignee: Unassigned
Resolution: Not a Bug Votes: 0
Labels: None


 Description   

Hello,

If you run 'cmake -LAH' in the source directory, you get a description of the cmake options, but the capitalisation of the descriptions are not consistent, making it hard to find the options you need.

For example, I was trying to find the option to disable compiling Mroonga, as it was causing problems during compile time on my machine. I ran the command above, and filtered for mroonga, groonga, [Gg]roonga, and it was only when I filtered for MROONGA that I found what I was looking for ('PLUGIN_MROONGA:STRING=DYNAMIC').

The entries in 'cmake -LAH' are as follows:

// How to build plugin MROONGA. Options are: NO STATIC DYNAMIC YES AUTO.
PLUGIN_MROONGA:STRING=DYNAMIC

If the description was: How to build plugin Mroonga..., I may have found it. Can this be updated?

Thanks.



 Comments   
Comment by Elena Stepanova [ 2018-04-18 ]

I would highly recommend doing case-insensitive search, it would solve your problem completely.

Comment by Terry Tibbles [ 2018-04-20 ]

So you're saying it's not inconsistent?

Comment by Elena Stepanova [ 2018-07-19 ]

I'm saying it's the matter of opinion. Whatever we change it to, there will be people who think it should be different.
As for the consistency, they actually look surprisingly consistent to me:

$ cmake . -LAH | grep 'How to build'
 
// How to build plugin ARCHIVE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin ARIA. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AUDIT_NULL. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AUTH_0X0100. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AUTH_ED25519. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AUTH_SOCKET. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AUTH_TEST_PLUGIN. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin AWS_KEY_MANAGEMENT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin BLACKHOLE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin CLIENT_ED25519. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin CONNECT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin CRACKLIB_PASSWORD_CHECK. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin DAEMON_EXAMPLE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin DEBUG_KEY_MANAGEMENT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin DIALOG_EXAMPLES. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin DISKS. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin EXAMPLE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin EXAMPLE_KEY_MANAGEMENT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin FEDERATED. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin FEDERATEDX. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin FEEDBACK. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin FILE_KEY_MANAGEMENT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin FTEXAMPLE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin HANDLERSOCKET. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin INNOBASE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin LOCALES. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin METADATA_LOCK_INFO. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin PARTITION. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin PERFSCHEMA. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin QA_AUTH_CLIENT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin QA_AUTH_INTERFACE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin QA_AUTH_SERVER. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin QUERY_CACHE_INFO. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin QUERY_RESPONSE_TIME. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin ROCKSDB. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SEMISYNC_MASTER. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SEMISYNC_SLAVE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SEQUENCE. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SERVER_AUDIT. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SIMPLE_PASSWORD_CHECK. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SPHINX. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SPIDER. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin SQL_ERRLOG. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin TEST_SQL_DISCOVERY. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin TOKUDB. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin USER_VARIABLES. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin WSREP_INFO. Options are: NO STATIC DYNAMIC YES AUTO.
// How to build plugin XTRADB. Options are: NO STATIC DYNAMIC YES AUTO.

Generated at Thu Feb 08 08:24:58 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.