Support¶

How can I support Freetz-NG?

• Sponsor
  
  • 
• UNTESTED
  
  In menuconfig and in FIRMWARES, several devices are marked as UNTESTED.
  
  Because of missing hardware, it was not possible to verify whether Freetz-NG works on them.
  
  If you run Freetz-NG successfully on one of these devices, please report back.
  
  Ideally include screenshots of Box-Info and Flashspeicher.
  
• Source code
  
  Building a modified image requires the matching AVM source code.
  
  Since AVM uses software licensed under terms like GPL, they must provide source code,
  
  but usually only on request.
  
  Everyone should send an email for each owned device to fritzbox_info@avm.de.
  
  Do this for every published FRITZ!OS version, including so-called "Labor" builds.
  
  AVM then publishes the package on osp.avm.de/.
  
• Pull request
  
  Contributing your own changes to Freetz-NG:
  • Create your own fork on github.com/Freetz-NG/freetz-ng/ using Fork.
  • Clone your fork: git clone https://github.com/USERNAME/freetz-ng.git
  • Create a branch: git branch BRANCHNAME ; git checkout BRANCHNAME ; git push -u origin BRANCHNAME
  • Commit and push your changes: git add . ; git commit -m "DESCRIPTION" ; git push
  • Open a PR from your fork using New pull request on github.com/Freetz-NG/freetz-ng/.
• Mailbox format
  
  If creating a pull request is too much effort, you can also send a patch:
  • Clone: git clone https://github.com/Freetz-NG/freetz-ng.git
  • Ensure your name is set: git config --global user.name "GITHUB-NAME"
  • Ensure your email is set: git config --global user.email GITHUB-NAME@users.noreply.github.com
  • Make your changes, add/remove files as needed.
  • Stage all changes: git add .
  • Create a commit: git commit -m "DESCRIPTION"
  • Create patch file(s): git format-patch origin/HEAD
  • Remove all local changes again: git reset --hard origin/HEAD
• Package bump
  
  Minimal steps to update a package/library version:
  • Read the changelog, there may be relevant behavior changes.
  • Note: libraries are in make/libs/$PKG/, not in make/pkgs/$PKG/.
  • Update docs/CHANGELOG.md.
  • Update version in make/pkgs/$PKG/Config.in.
  • Update version in make/pkgs/$PKG/$PKG.mk.
  • Update checksum in make/pkgs/$PKG/$PKG.mk.
  • If filename includes version, update make/pkgs/$PKG/external.*.
  • Refresh existing patches in make/pkgs/$PKG/patches/ with make $PKG-autofix.
  • Test build with make $PKG-recompile.
  • Best practice: flash and test on a real FRITZ!Box.
• Wiki
  
  Many parts of the wiki at freetz-ng.github.io/ are outdated and need updates.
  
  All wiki files are available in the checkout under docs/wiki/.