fbt_help.py 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. targets_help = """Configuration variables:
  2. """
  3. tail_help = """
  4. TASKS:
  5. Building:
  6. firmware_all, fw_dist:
  7. Build firmware; create distribution package
  8. faps, fap_dist:
  9. Build all FAP apps
  10. fap_{APPID}, launch_app APPSRC={APPID}:
  11. Build FAP app with appid={APPID}; upload & start it over USB
  12. Flashing & debugging:
  13. flash, flash_blackmagic, jflash:
  14. Flash firmware to target using debug probe
  15. flash_usb, flash_usb_full:
  16. Install firmware using self-update package
  17. debug, debug_other, blackmagic:
  18. Start GDB
  19. Other:
  20. cli:
  21. Open a Flipper CLI session over USB
  22. firmware_cdb, updater_cdb:
  23. Generate сompilation_database.json
  24. lint, lint_py:
  25. run linters
  26. format, format_py:
  27. run code formatters
  28. For more targets & info, see documentation/fbt.md
  29. """
  30. def generate(env, **kw):
  31. vars = kw["vars"]
  32. basic_help = vars.GenerateHelpText(env)
  33. env.Help(targets_help + basic_help + tail_help)
  34. def exists(env):
  35. return True