Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 2.52 KB

buildTools.md

File metadata and controls

44 lines (24 loc) · 2.52 KB

#Build tools

###rc_init_ws This will initialize a Robocomp workspace in the current/specified directory. If this is already a workspace (has a .rc_workspace file) then it will register it as an workspace on your computer. To de-register a workspace just delete the .rc_workspace file. The build tools will find only those workspaces which are registered on your computer.

rc_init_ws [path]

###rcbuild When invoked form workspace without any arguments if not inside source path, it will build all the non-ignored components inside the workspace, if inside any component source directory it will build only that component. But if a component is specified it will build it. You can find the build targets in the devel space.

 rcbuild [-h] [-i [INSTALL] | --doc | --installdoc] [component]

The doc will generate documentation, installdoc will install the docs to install path, install will build and install the components to the specified directory if nothing is specified it will be installed to /opt/robocomp. currently you can only generate docs for one component at a time.

###rccomp This dosent have much functions as of now.

usage: rccomp [-h] [{list,listws}]

rccomp list will list all the components in registered workspaces and rccomp listws will list all the registered workspaces.

###rced when invoked as component-name file-name. it will open the the file in the component. if multiple files with same name exists, it will give choices and will ask you to choose one. It uses the editor specified in $EDITOR by default, if not present it will use vim.

rced [-h] component file

###rcrun Using rcrun you can start, stop or force stop any component from anywhere. You can also start a component in debug mode, given you have the required config file in the etc directory. If you have specified a config file then rcrun will use it to start the component. By default rcrun will use the config config file in etc directory, if not found it will search for generic_config if not found it will use any of config files present.If the debug flag is set, it will search for a config file that ends with .debug.

rcrun [-h] [-s START |-st STOP | -fst FSTOP] [-d | -cf CFILE | -c CONFIG] [-is] [component]

###rccd Using this you can cd into the component directory given the component name.

rccd component

###NB

  • The build tools doesn't support python components as of now
  • Auto completion is enabled all the components except rccd so that you don't need to remember the exact component name