Skip to content

Commit

Permalink
Added clarification to the exclude variables and their purposes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrockwell2 authored Dec 19, 2023
1 parent eb7cb52 commit d78dcad
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ A colon separated list of directories to skip when processing files.

It is possible to instruct all CP functions to skip entire directories using the environment variable TRICK_EXCLUDE. Set this variable to a colon separated list of directories which you wish CP to bypass. All header files found in TRICK_EXCLUDE will not be processed. All source code files found in TRICK_EXCLUDE will not be compiled or linked into the simulation.

This environment variable does the job of both TRICK_ICG_EXCLUDE and TRICK_SWIG_EXCLUDE simulataneously.

This feature is useful to bring in packages as a library.

### TRICK_ICG_EXCLUDE
Expand All @@ -94,12 +96,16 @@ A colon separated list of directories to skip when processing header files.

It is possible to instruct ICG to skip entire directories using the environment variable TRICK_ICG_EXCLUDE. Set this variable to a colon separated list of directories which you wish ICG to bypass. This is useful when there is code which you do not wish Trick to have any knowledge of (i.e. you don’t need any of the parameters recorded or input processable).

This excludes files from ICG only, while still allowing SWIG to process them.

### TRICK_SWIG_EXCLUDE

A colon separated list of files and directories to skip when generating Python interface files.

It is possible to instruct SWIG to skip entire directories and files using the environment variable TRICK_SWIG_EXCLUDE. Set this variable to a colon separated list of files that should be bypassed.

This excludes files from SWIG only, still allowing ICG to process them.

Example ```S_overrides.mk```:
```
TRICK_SWIG_EXCLUDE += :models/SwigExclude.hh
Expand Down

0 comments on commit d78dcad

Please sign in to comment.