Command Parameter Description

The Byte Alignment Check tool checks the byte alignment of structure variables in the source code.

Command Function

Displays all command parameters used for byte alignment check.

Syntax

devkit advisor byte-align -h

Example

Run the following command to query the parameter descriptions of all commands.

devkit advisor byte-align -h

The command output is as follows:

 OVERVIEW
        Run this command to check the byte alignment of structure variables in the source code.

    USAGE
        devkit advisor byte-align {-i INPUT_PATH | --input INPUT_PATH} {-c COMMAND | --cmd COMMAND}
        [-o OUTPUT_PATH | --output OUTPUT_PATH] [-b {make,cmake, automake} | --build-tool {make,cmake, automake}]
        [-r {all,json,html,csv} | --report-type {all,json,html,csv}]
        [-l {0,1,2,3} | --log-level {0,1,2,3}] [--set-timeout TIMEOUT]

    OPTIONS
        -i, --input INPUT_PATH
            [Mandatory option] Specifies the path of the source code folder to be scanned.
        -c, --cmd COMMAND
            [Mandatory option] Specifies the build command of the source code.
        -o, --output OUTPUT_PATH
            Specify the path for storing the scan report and the file name.
            By default, the file is stored in the current path(pwd) and its name is in the format of function name_timestamp.
        -b, --build-tool {make,cmake,automake}
            Specify the building tool. The default value is make.
        -l, --log-level {0,1,2,3}
            Specifies the log level of the current task, 0(DEBUG) | 1(INFO) | 2(WARNING) | 3(ERROR). The default value is 1(INFO).
        -r, --report-type {all,json,html,csv}
            Specify the report type for the scan report. The default value is all.
        --set-timeout <min>
            Specifies the timeout period of a task. By default, the timeout period is not set.

    EXAMPLE
        # Scan a project and generate scanning reports.
        devkit advisor byte-align -i /home/advisor/project -b make -c 'make'

Parent topic: Byte Alignment Check