summaryrefslogtreecommitdiffstats
path: root/data/mappings/info_rules.json
blob: aea67e04c846c7de50aa5487a655aa5f0ff77df4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# This file maps keys between `rules.mk` and `info.json`. It is used by QMK
# to correctly and consistently map back and forth between the two systems.
{
    # Format:
    # <rules.mk key>: {"info_key": <info.json key>, ["value_type": <value_type>], ["to_json": <true/false>], ["to_c": <true/false>]}
    # value_type: one of "array", "array.int", "bool", "int", "list", "hex", "mapping"
    # to_json: Default `true`. Set to `false` to exclude this mapping from info.json
    # to_c: Default `true`. Set to `false` to exclude this mapping from rules.mk
    # warn_duplicate: Default `true`. Set to `false` to turn off warning when a value exists in both places
    "BOARD": {"info_key": "board"},
    "BOOTLOADER": {"info_key": "bootloader", "warn_duplicate": false},
    "BLUETOOTH": {"info_key": "bluetooth.driver"},
    "FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
    "KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
    "MOUSE_SHARED_EP": {"info_key": "usb.shared_endpoint.mouse", "value_type": "bool"},
    "LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
    "LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},
    "LTO_ENABLE": {"info_key": "build.lto", "value_type": "bool"},
    "MCU": {"info_key": "processor", "warn_duplicate": false},
    "MOUSEKEY_ENABLE": {"info_key": "mouse_key.enabled", "value_type": "bool"},
    "NO_USB_STARTUP_CHECK": {"info_key": "usb.no_startup_check", "value_type": "bool"},
    "SPLIT_KEYBOARD": {"info_key": "split.enabled", "value_type": "bool"},
    "SPLIT_TRANSPORT": {"info_key": "split.transport.protocol", "value_type": "str", "to_c": false},
    "WAIT_FOR_USB": {"info_key": "usb.wait_for", "value_type": "bool"}
}