Simple Patch

From GnuCash
Revision as of 20:17, 4 July 2020 by Jralls (talk | contribs) (Requirements: Make "macOS" consistent with Apple branding.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Purpose of this page is to show, how to create a simple patch without the hazzle to set up a developement environment. This should allow normal users to send a patch for a typo in a text file.

Requirements

  • Any editor for plain text. That means specific for Windows users use Notepad instead of Word.
  • The program diff, which is part of several packages:
    • Linux: diffutils,
    • macOS: XCode [?],
    • Windows: MinGW [part of the GnuCash Package?].
  • Optional a program to search recursivly for strings in files like grep to find the right file.

Procedere

  1. Locate the file with the typo e.g. with grep.
    Note
    The next 2 steps might need administrator rights.
  2. Create a backup of the file: copy <filename>.<suffix> <filename>.bak
  3. Edit the original file with a plain text editor.
  4. Test the new version in its application.
  5. Create a patch:
    diff -u <filename>.bak <filename>.<suffix> ><filename>.patch
    
  6. Create a bugreport at https://bugs.gnucash.org
  7. Attach <filename>.patch to your bugreport