Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

76 lines (52 loc) · 2.39 KB
Raw

TLDR;

Before doing anything else, run cargo build -p lalrpop!

When making changes the alter the generated code, use sh update_lrgrammar.sh to pass the verify_lalrpop_generates_itself test.

Contributor's "How to"

Just as any language that is written in itself, LALRPOP has to solve chicken-and-egg problem. To compile LALRPOP we need a working version of LALRPOP. To have a working version we need to compile it first.

The lalrpop crate already includes an auto-generated parser in lalrpop/src/parser/lrgrammar.rs that end-users use. Small (meh), (relatively) fast to compile, easy to use (really, for end-users).

That said, if you changes don't affect LALRPOP's own grammar (lalrpop/src/parser/lrgrammar.lalrpop) your workflow is simple

# building
$ cargo build # -p lalrpop --release

# testing
$ cargo test # -p lalrpop --release

But if your changes do affect the grammar - well, that's where all the fun of bootstrapping compilers comes! You're going to have to get a working lalrpop binary to generate your own lrgrammar.rs parser. That's how you do it:

$ cargo build -p lalrpop # --release

Once you're done with your work, make sure that you are running against an updated version of the grammar.

$ sh update_lrgrammar.sh

This script will replace lalrpop/src/parser/lrgrammar.rs with the newly generated one, renaming the old one to lalrpop/src/parser/lrgrammar.rs.bak just in case.

Now feel free to git commit and git push your changes.

History

In the past, LALRPOP used snapshots of its older self to compile itself (you might notice lalrpop-snap on crates.io). Unfortunately, this meant end-users had to build both lalrpop and lalrpop-snap crates and nobody liked this double-building. So this approach has been abandoned a while ago.

Releasing LALRPOP

Without Cargo-Release

  1. Run ./version.sh <NEW VERSION>.
  2. Commit the changes
  3. Run cargo publish for lalrpop and lalrpop-util
  4. Tag new release
  5. Push new tag to repository

Cargo-Release

If using cargo-release:

  1. Run ./version.sh <NEW VERSION>.
  2. Commit the changes
  3. cargo release --execute --package lalrpop-util --tag-name "{{version}}"
  4. cargo release --execute --package lalrpop --no-tag

Drop the --execute flag to do a dry run and check for any issues first.