{{TableOfContents}}

This is an index of all the variables used by Fuego:

{{{#!YellowBlock
FIXTHIS - I don't have all the fuego variables documented here yet

See also [[Core interfaces]]
}}}

= A =
 * ARCHITECTURE: the processor architecture of the target board
   * defined in the board file for a target
   * used by toolchain and build scripts for building the tests
     * ''NOTE: this appears to only be used by iozone.sh''
   * sample: arm
 * ARCH: architecture used by the toolchain
   * sample: arm
   * set by [[tools.sh]] based on TOOLCHAIN
 * AS: name of the assembler
   * set by [[tools.sh]] based on TOOLCHAIN
   * commonly used during the build phase (in the function [[function_test_build|test_build]])

= B =
 * BAUD : Baud rate to be used with the serialport
   * defined in the board file for a target
   * used by serial transport
   * sample: "115200"
 * BOARD_TESTDIR : directory on the target board where test data will be placed
   * defined in the board file for a target
   * sample: "/home/fuego"


= C =
 * CC: name of the C compiler
   * set by [[tools.sh]] based on TOOLCHAIN
   * commonly used during the build phase (in the function [[function_test_build|test_build]])
   * sample: arm-linux-gnueabihf-gcc
 * CONFIGURE_FLAGS: flags used with the 'configure' program
   * set by [[tools.sh]] based on TOOLCHAIN
   * commonly used during the build phase (in the function [[function_test_build|test_build]])
 * CROSS_COMPILE: cross-compile prefix used for kernel builds
   * set by [[tools.sh]] based on TOOLCHAIN
   * sample: arm-linux-gnueabihf-
   * NOTE: this is often $PREFIX followed by a single dash
 * CPP: name of the C pre-processor
   * set by [[tools.sh]] based on TOOLCHAIN
 * CXX: name of the C++ compiler
   * set by [[tools.sh]] based on TOOLCHAIN
 * CXXCPP: name of the C++ pre-processor
   * set by [[tools.sh]] based on TOOLCHAIN

= F =
 * FUEGO_BUILD_FLAGS: has special flags used to control builds (for some tests)
    * See [[FUEGO_BUILD_FLAGS]]
 * FUEGO_CORE: directory for Fuego core scripts and tests
    * This is defined in Jenkins and Fuego system-level configurations
    * Set to /fuego-core inside the Docker container.
 * FUEGO_DEBUG: controls whether Fuego emits debug information during test execution
    * See [[FUEGO_DEBUG]]
 * FUEGO_RO: directory for Fuego read-only data
    * This is defined in the Jenkins and Fuego system-level configurations
    * Set to /fuego-ro inside the Docker container.
 * FUEGO_RW: directory for Fuego read-write data
    * This is defined in Jenkins and Fuego system-level configurations
    * Set to /fuego-rw inside the Docker container.
 * FUEGO_TARGET_TMP: directory on target to use for syslogs
   * This is defined in the board file for a target board
   * This should specify a directory in the board filesystem that is persistent across reboots.  This is to override the default temp directory (of '/tmp'), if that directory is erased on a board reboot.
 * FUEGO_TEST_PHASES: specifies a list of phases to perform during test execution
   * This is usually set by 'ftc run-test' based on the '-p' option.
   * This is a space-separated list of strings, with the following possible strings: pre_test pre_check build deploy run post_test processing



= G =
 * GEN_TESTRES_FILE: set to the value of TEST_RES, when a BATCH_TESTPLAN is in effect

= I =
 * IO_TIME_SERIAL: Time required for echoing the whole command and response
   * defined in the board file
   * used by the transport functions
   * sample: 0.1
 * IPADDR: IP address of the target board
   * defined in the board file
   * used by the transport functions
   * sample: 10.0.1.74


= L =
 * LD: name of the linker
   * set by [[tools.sh]] based on TOOLCHAIN
   * sample: arm-linux-gnueabihf-ld
 * LOGIN: login account name for the target
   * defined in the board file for the target
   * used by the transport functions
   * the account on the target should have sufficient rights to run a variety of tests and perform a variety of operations on the target
   * sample: root

= M =
 * MAX_BOOT_RETRIES: Number of times to retry connecting to target during a [[function_target_reboot|target_reboot]] operation.
   * defined in the board file
   * sample: 20
 * MMC_DEV: device filename for an MMC device on the target
   * defined in the board file
   * used by filesystem test specs
   * sample: /dev/mmcblk0p2
 * MMC_MP: mount point for a filesystem on an MMC device on the target
   * defined in the board file
   * used by filesystem test specs
   * sample: /mnt/mmc
 * MOUNT_BLOCKDEV: device filename for a block device on the target
   * defined in a filesystem test spec
     * e.g. in (bonnie, fio, ffsb, iozone, synctest, aiostress, dbench, tiobench).spec
   * usually references either MMC_DEV, SATA_DEV or USB_DEV, depending on what the test spec indicates to test
   * sample: /dev/sda1
 * MOUNT_POINT: mount point for a filesystem to be tested on the target
   * defined in a filesystem test spec
      * e.g. in (bonnie, fio, ffsb, iozone, synctest, aiostress, dbench, tiobench).spec
   * usually references either MMC_MP, SATA_MP, or USB_MP, depending on what the test spec indicates to test
   * sample: /mnt/sata

= N =
  * NODE_NAME: the name of the board
    * This is set by Jenkins, and is the first part of the Fuego job name



= O =
 * OF_ROOT: root of overlay system
   * sample: /home/jenkins/overlays/

= P =
 * PASSWORD: password used with to login to the target board
   * defined in the board file for a target
   * used by the transport functions
   * it can be the empty string: ""
   * sample: mypass
 * PLATFORM: name of the target "platform"  This is used to identify the toolchain used for building tests.  This has been deprecated.  Please use 'TOOLCHAIN' instead.
 * PREFIX: toolchain prefix
   * set by [[tools.sh]] based on TOOLCHAIN
   * sample: arm-linux-gnueabihf
   * NOTE: see also CROSS_COMPILE

= R =
 * REP_DIR: directory where reports are stored
   * sample: /home/jenkins/logs/logruns/
 * REP_GEN: report generator program
   * sample: /home/jenkins/scripts/loggen/gentexml.py
 * REP_LOGGEN: program used to generate report logs?
   * sample: /home/jenkins/scripts/loggen/loggen.py

= S =
 * SATA_DEV: device node filename for a SATA device on the target
   * defined in the board file
   * used by filesystem tests
   * sample: /dev/sda1
 * SATA_MP: mount point for a filesystem on a SATA device on the target
   * used by filesystem tests
   * sample: /mnt/sata
 * SRV_IP: IP address of server machine (host machine where fuego runs)
   * defined in base-board.fuegoclass
     * obtained dynamically using the 'ip' command
   * can be defined in a board file for a target, using an 'override' command
   * used by networking tests (NetPIPE, iperf, netperf)
   * sample: 10.0.1.1
 * SSH_PORT: port to use for ssh connections on the target
   * defined in the board file for the target
   * the default port for sshd is 22
   * sample: 22
 * SERIAL: port to use for serial connections on the target
   * defined in the board file for the target
   * The device file name as detected in Docker container 
   * sample: ttyACM0

= T =
 * TESTLOG: full path to log for a particular test
   * sample: /home/jenkins/logs/Functional.bzip2/testlogs/bbb.2016-06-24_18-12-53.2.log
 * TEST_RES: full path to JSON results file for a test
   * sample: ``/home/jenkins/logs/Functional.bzip2/testlogs/bbb.2016-06-24_18-12-53.2.res.json``
   * sample contents: 
 * TESTDIR: name of the directory for a particular test
   * this is just the directory name, not the full path (see $TEST_HOME)
   * this is also used as the reference parse log prefix
   * sample: ``Functional.bzip2``
 * TEST_HOME: full path to the root of the test directory
   * sample: ``/home/jenkins/tests/Functional.bzip2``
 * TOOLCHAIN: name of the toolchain used to build test programs for a board.
   * defined in the board file
   * used in tools.sh
   * sample: ``qemu-armv7hf``
   * ''NOTE: this replaced 'PLATFORM', used in earlier versions of Fuego''
 * TRANSPORT: type of connection between the host system and the target system
   * defined in the board file for the target
   * possible values: ssh, serial, ttc
     * others anticipated are: adb, lava
   * used by the transport functions
   * sample: ``ssh``
 * TTC_TARGET: target name used with 'ttc' command
   * defined in the board file for the target
   * used by the transport functions, for the 'ttc' transport only
   * sample: ``beaglebone``

= U =
 * USB_DEV: device filename for an block device provided by a USB device on the target
   * defined in the board file
   * used by filesystem test specs
   * sample: /dev/sdb1
 * USB_MP: mount point for a filesystem on an USB device on the target
   * defined in the board file
   * used by filesystem test specs
   * sample: /mnt/usb


= UNDOCUMENTED (YET) =
 * TRIPLET
 * LTP_OPEN_POSIX_SUBTEST_COUNT_POS
   * defined in board file for a target
 * LTP_OPEN_POSIX_SUBTEST_COUNT_NEG
   * defined in board file for a target
 * EXPAT_SUBTEST_COUNT_POS
   * defined in board file for a target
 * EXPAT_SUBTEST_COUNT_NEG
   * defined in board file for a target
 * OF_ROOT
 * OF_CLASSDIR
 * OF_DEFAULT_SPECDIR
 * OF_OVFILES
 * OF_CLASSDIR_ARGS
 * OF_TESTPLAN_ARGS
 * OF_SPECDIR_ARGS
 * OF_OUTPUT_FILE
 * OF_OUTPUT_FILE_ARGS
 * OF_DISTRIB_FILE
 * OF_OVGEN
 * OF_BOARD_FILE
 * BATCH_TESTPLAN
 * OF_TESTPLAN
 * OF_TESTPLAN_ARGS
 * OF_OVFILES_ARGS