tools/lemon/README

   1 The Lemon Parser Generator's home page is:  https://www.hwaci.com/sw/lemon/
   2 Lemon seems now to be maintained at:        https://sqlite.org/lemon.html
   3
   4 Documentation is available at:  https://sqlite.org/src/doc/trunk/doc/lemon.html
   5 Git mirror of the upstream Fossil repository: https://github.com/mackyle/sqlite
   6
   7 The lempar.c and lemon.c are taken from sqlite and are modified as little as
   8 possible to make it easier to synchronize changes. Last updated at:
   9
  10     commit a913f942cf6b32b85de6428fd542b39458df2a88
  11     Author: D. Richard Hipp <drh@hwaci.com>
  12     Date:   Wed Dec 28 14:03:47 2022 +0000
  13
  14         Version 3.40.1
  15
  16 To check for changes (adjust "previous commit" accordingly):
  17
  18     git clone --depth=1000 https://github.com/sqlite/sqlite
  19     cd sqlite/tools
  20     git log -p 273ee15121.. lemon.c lempar.c
  21
  22 To create a Wireshark version (steps 1-3) and validate the result (steps 4-5):
  23 1. Copy the two files.
  24 2. Run ./apply-patches.sh to apply local patches.
  25 3. Update the commit in this README (to ensure the base is known).
  26 4. Check for CSA warnings:  clang-check -analyze lemon.c --
  27 5. Build and run lemon:     ninja epan/dfilter/grammar.c
  28
  29 To keep the lemon source as pristine as possible from upstream all warnings
  30 when building lemon itself are disabled. Only patch the lemon source code as
  31 a last resort.
  32
  33 Warnings for lemon generated code are few in practice with -Wall -Wextra. These
  34 are preferably selectively disabled in the Wireshark build.
  35
  36 The patches to lemon to silence compiler warnings and static analysis reports
  37 (for edge cases that cannot occur) are not proposed upstream because that
  38 process is difficult. From <https://www.sqlite.org/copyright.html>:
  39
  40     SQLite is open-source, meaning that you can make as many copies of it as you
  41     want and do whatever you want with those copies, without limitation. But
  42     SQLite is not open-contribution. In order to keep SQLite in the public
  43     domain and ensure that the code does not become contaminated with
  44     proprietary or licensed content, the project does not accept patches from
  45     unknown persons.
  46
  47 A note about the Lemon patches, we have no intention to fork Lemon and maintain
  48 it. These patches are written to address static analyzer warnings without
  49 actually modifying the functionality. If upstream is willing to accept patches,
  50 then that would be great and the intention is to make it as easy as possible.
  51 The lemon and lempar patches are dedicated to the public domain, as set forward
  52 in Creative Commons Zero v1.0 Universal (IANAL, but I hope this is sufficient).