Skip to content

doctests command ​

Find, compile, and run inline doctest snippets embedded in Fortran source comments.

bash
fobis doctests [options]

How to use it, with examples: Testing.

All options ​

OptionValueDefaultDescription
--fobos, -fTEXTSpecify a "fobos" file named differently from "fobos"
--fciAssume fobos inputs as case insensitive
--modeTEXTSelect a mode defined into a fobos file
--lmodesList the modes defined into a fobos file
--compilerTEXTgnuCompiler used (case insensitive, default gnu)
--fcTEXTFortran compiler statement (for --compiler custom)
--cflagsTEXTCompile flags
--lflagsTEXTLink flags
--ccTEXTC compiler for the .c sources (default: the compiler family's, e.g. gcc)
--c-cflagsTEXTCompile flags of the .c sources (default -c)
--c-preprocTEXTPreprocessor flags of the .c sources
--modswTEXTModule search path switch (for --compiler custom)
--mpiUse MPI enabled version of compiler
--openmpUse OpenMP pragmas
--openmp-offloadUse OpenMP Offload pragmas
--coarrayUse coarrays
--coverageInstrument for coverage analysis
--profileInstrument for profiling analysis
--mklibTEXTBuild library instead of program (static|shared)
--arTEXTarArchiver executable for static libraries [default: ar]
--arflagsTEXT-rcsArchiver flags for static libraries [default: -rcs]
--ranlibTEXTranlibRanlib executable; empty string to skip [default: ranlib]
--cflags-heritage, --chStore cflags for heritage checking; re-compile all if they change
--track-build, --tbStore build info for the install command
--src, -sTEXTRoot-directory of source files [default: ./]
--build-dir, --dbldTEXTDirectory containing built objects [default: ./]; given here, it wins over the mode's build_dir
--obj-dir, --dobjTEXT./obj/Directory containing compiled objects [default: ./obj/]
--mod-dir, --dmodTEXT./mod/Directory containing .mod files [default: ./mod/]
--lib-dir, --dlibTEXTDirectories searched for libraries
--include, -iTEXTDirectories for searching included files
--exclude-dirs, --edTEXTExclude directories from the building process
--disable-recursive-search, --drsDisable recursive search inside directories
--target, -tTEXTSpecify a target file [default: all programs found]
--output, -oTEXTOutput file name (used with --target)
--exclude, -eTEXTExclude files from the building process
--libsTEXTExternal libraries with full paths
--vlibsTEXTVolatile external libraries with full paths
--ext-libsTEXTExternal libraries in compiler path
--ext-vlibsTEXTVolatile external libraries in compiler path
--dependonTEXTInterdependent external fobos files for interdependent building
--incTEXTExtensions for include files
--extensionsTEXTExtensions of parsed files
--build-allBuild all sources parsed
--keep-volatile-doctestsKeep the volatile doctests programs
--exclude-from-doctestsTEXTExclude files from the doctests process
--preprocessorTEXTPreprocessor name for pre-processing sources (e.g. PreForM.py)
--preprocTEXTPreprocessor flags for the main compiler
--preprocessor-args, --appTEXTPreprocessor-specific flags
--preprocessor-no-o, --nppDo not add -o in front of output in preprocessor command
--preprocessor-dir, --dppTEXTDirectory for preprocessed files
--preprocessor-ext, --eppTEXTFile extensions to preprocess
--doctests-preprocessorTEXTcppPreprocessor used during doctests parsing (cpp|fpp)
--force-compileForce to (re-)compile all
--colorsActivate colors in shell prints
--log, -lActivate log file creation
--graphGenerate a dependencies graph via graphviz
--quiet, -qLess verbose output
--verboseExtremely verbose output for debugging
--jobs, -jINTEGER1Number of concurrent compilation jobs [default: 1]
--makefile, -mTEXTGenerate a GNU Makefile for building the project