Command line options

THIS PAGE IS IN ITS EARLY STAGE OF WRITING!

Here’s a sum up of the different options one can use. Please note that all options cited here shall be used preceded by two hyphens “—”.

config

This option prints out the configuration used by codemetre when measuring. Output respects the configuration file formalism. This way, one can first dump the result of the config option in the configuration file, and then patch it to work as expected.

First output line is a comment used to indicate if dump configuration is only the default one, or a conjunction of the default one and the user one. For example,

codemetre --config

may show two different things.

# 0.26.0

indicates that only the default configuration is taken into account

# 0.26.0 & /home/user/.codemetrerc

indicates that the configuration file of user is used to patch default configuration file.

This option shall be used alone with no other extra argument allowed.

noconfig

If you want to be sure that no user configuration file is used for measuring, and only the default configuration applies, then the noconfig option is for you.

codemetre --noconfig MyDirectory/

will only measure files of the MyDirectory directory which extensions are known from the default configuration file point-of-view.

code

blo

—comment

blo

—total

blo

—dump

codemetre’s principle is to split input files in lines, and each non-empty line in a list of terms. This way, differential measures are not impacted by indentation. The ‘—dump’ option allows you to know how codemetre understands the files it measures. For every parsed file, a new file with extension ‘.cma’ is created, showing how terms are isolated.

This option is available both in single mode and differential mode.

—status

blo

—short

blo

—model

blo

—lang

codemetre normally uses file’s extension to determine programmation language. This associative logic can be overriden with the ‘—lang’ option. For example, the following call :

codemetre --lang c++ MyDirectory/

will try to interpret each file of MyDirectory as being writtent in C++, whatever its extension could be.

The ‘—lang’ option takes a mandatory argument, which is the key of the language interpreter to force. List of keys can be obtained with the ‘—config’ option.