Skip to content

Commit

Permalink
[ruby/yarp] Add a Requirements section in Build System docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eregon authored and pull[bot] committed Sep 16, 2023
1 parent d8e1006 commit 2243218
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/build_system.md
Expand Up @@ -2,6 +2,17 @@

There are many ways to build YARP, which means the build system is a bit more complicated than usual.

## Requirements

* It must work to build YARP for all 6 uses-cases below.
* It must be possible to build YARP without needing ruby/rake/etc.
Because once YARP is the single parser in TruffleRuby, JRuby or CRuby there won't be another Ruby parser around to parse such Ruby code.
Most/every Ruby implementations want to avoid depending on another Ruby during the build process as that is very brittle.
* It is desirable to compile YARP with the same or very similar compiler flags for all use-cases (e.g. optimization level, warning flags, etc).
Otherwise, there is the risk YARP does not work correctly with those different compiler flags.

The main solution for the second point seems a Makefile, otherwise many of the usages would have to duplicate the logic to build YARP.

## General Design

1. Templates are generated by `templates/template.rb`
Expand Down

0 comments on commit 2243218

Please sign in to comment.