2019-07-10 01:00:07 +00:00
|
|
|
#!/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
|
2023-10-08 20:11:19 +00:00
|
|
|
ghtp ........ Set the transfer protocol for all your remotes
|
2019-07-10 01:00:07 +00:00
|
|
|
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
|
|
|
|
|
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.
|
|
|
|
|
|
2023-10-08 20:11:19 +00:00
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
pins_set ............. Set the value of a pin in a pins file
|
|
|
|
|
pinsformat.js ........ Node.js script to format pins files
|
|
|
|
|
|
2019-07-10 01:00:07 +00:00
|
|
|
THIS
|
