buildroot/share/git/mfhelp - bugfix-2.1.x - githubmirror/Marlin

buildroot/share/git/mfhelp

46 строк2 KB

Scott Lahteine

🔨 Scripted build/archive multiple envs

16 дек 2024, 05:35

16 дек 2024, 05:35d5dfd18

#!/usr/bin/env bash
#
# mfhelp
#

cat <<THIS
Marlin Firmware Commands:

  firstpush ... Push and set-upstream the current branch to 'origin'
  ghpc ........ Push the current branch to its upstream branch
  ghtp ........ Set the transfer protocol for all your remotes
  mfadd ....... Fetch a remote branch from any Marlin fork
  mfclean ..... Attempt to clean up merged and deleted branches
  mfdoc ....... Build the website, serve locally, and browse
  mfenvs ...... Get current board SHORT_NAME (###): [ env1 env2 ... ]
  mffp ........ Push new commits directly to MarlinFirmware
  mfinfo ...... Provide branch information (for the other scripts)
  mfinit ...... Create an 'upstream' remote for 'MarlinFirmare'
  mfnew ....... Create a new branch based on 'bugfix-...'
  mfpr ........ Push the current branch and open the PR form
  mfpub ....... Build and publish the marlinfw.org website
  mfqp ........ Commit changes, do an interactive rebase, and push
  mfrb ........ Interactively rebase the current branch on 'bugfix-...'
  mftest ...... Run a platform test locally with PlatformIO
  mfup ........ Fetch the latest 'upstream' and rebase on it

  Enter [command] --help for more information.

Build / Test Commands:

  mftest ............... Run a platform test locally with PlatformIO
  build_all_examples ... Build all configurations of a branch, stop on error

Modify Configuration.h / Configuration_adv.h:

  opt_add .............. Add a configuration option (to the top of Configuration.h)
  opt_disable .......... Disable a configuration option (modifies )
  opt_enable ........... Enable a configuration option
  opt_set .............. Set the value of a configuration option
  use_example_configs .. Download configs from a remote branch on GitHub

Modify pins files:

  pinsformat.py ........ Python script to format pins files

THIS