fbt_help.py 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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. fap_deploy:
  13. Build and upload all FAP apps over USB
  14. Flashing & debugging:
  15. flash, flash_blackmagic, jflash:
  16. Flash firmware to target using debug probe
  17. flash_usb, flash_usb_full:
  18. Install firmware using self-update package
  19. debug, debug_other, blackmagic:
  20. Start GDB
  21. Other:
  22. cli:
  23. Open a Flipper CLI session over USB
  24. firmware_cdb, updater_cdb:
  25. Generate сompilation_database.json
  26. lint, lint_py:
  27. run linters
  28. format, format_py:
  29. run code formatters
  30. For more targets & info, see documentation/fbt.md
  31. """
  32. def generate(env, **kw):
  33. vars = kw["vars"]
  34. basic_help = vars.GenerateHelpText(env)
  35. env.Help(targets_help + basic_help + tail_help)
  36. def exists(env):
  37. return True