The main entry point in soclib is the soclib-cc command.
soclib-cc can be used to serve different pusposes. Among them:
Like other programs, soclib-cc embeds an in-line help option, to quickly list all available options.
Retrieves the current absolute installation path of the SoCLib library:
$ soclib-cc --getpath /opt/soclib
Dumps all the configuration, in a pretty-printed (yet verbose) manner. This is mostly usedful to understand what soclib-cc actually understand from the user’s configuration file.
These options access the Module Index.
This lists all the known modules names in the index.
This lists all the known modules in the index. Output is the name of the module (the index key), and various properties.
This cleans the metadata cache.
This completes a given module name with what is found in the index, for names starting with COMPLETE_NAME. This can serve as a base for shell-completion mechanisms. Example:
$ soclib-cc --complete-name=caba:vci_mw vci_mwmr_controller vci_mwmr_controller_lf vci_mwmr_stats
Output words to complete start at separator COMPLETE_SEPARATOR. This can help working around readline’s lexing. Example:
$ soclib-cc --complete-name=caba:vci_mw --complete-separator=_ mwmr_controller_lf mwmr_stats mwmr_controller $ soclib-cc --complete-name=caba:vci_mw --complete-separator= caba:vci_mwmr_controller_lf caba:vci_mwmr_controller caba:vci_mwmr_stats
Module index can also be accessed to change the defintion of modules.
Add the specified PATH to the list of directories searched for modules definitions. Paths listed with this option are searched first when looking for a module.
Put the said module in Per-module debug mode.
Use DIR as work directory for EDA tools requiring such a directory (modelsim, etc.).
Select the output file for compilation of the module or component. If compiling a component, output should be an object file name (ends with .o); if a platform, it is limited by the host OS rules (should end with .exe on Windows).
Compiles a platform defined in the PLATFORM file. See Platform description files for more information about this file’s format.
Compiles just one module and generates one object file containing the whole module code. Use soclib-cc -a to specify compile-time parameters.
Specifies the compile-time parameter NAME for building of module in soclib-cc -1 mode.
Tells soclib-cc to only compile, and not link. This is only available for module building (soclib-cc -1 mode).
Only available with soclib-cc -p. Outputs the cflags needed to compile embedded software using the specified platform.
Sets the build mode. This can be debug, prof or release. This changes the used compilation/linkage flags. Default is release. Intent is:
Uses the build environment named ENV, defaults to “default”.
During the build process, soclib-cc can output more or less messages depending on the following parameters:
Print currently-built module name, together with various information.
Print lots of information, even data specific to the core of soclib-cc’s implementation.
Try not to emit messages, at all.
Print a progress-bar of the build of a complete platform or module. This gives user a little visual feedback.
Sometimes, user needs help from other people having more experience with SoCLib. If this process happens through email, having all the information peer needs to understand what happened can be a tedious enumeration. These options try to automate this information gathering process.
Generates a log of the environment, command line, executed processes, errors.
Automatically open a browser to the relevant soclib.fr’s website address where to report bugs.