Table of Contents

1 Overview
2 Installation
3 Command Line Usage
4 Propane Grammar File
4.1 User Code Blocks
4.1.1 Standalone Code Blocks
4.1.2 Lexer pattern code blocks
4.1.3 Parser rule code blocks
4.2 AST generation mode - the ast statement
4.3 ast_prefix and ast_suffix statements
4.4 Specifying tokens - the token statement
4.5 Defining tokens without a matching pattern - the tokenid statement
4.6 Specifying a lexer pattern - the pattern statement
4.7 Ignoring input sections - the drop statement
4.8 Regular expression syntax
4.9 Lexer modes
4.10 Specifying parser value types - the ptype statement
4.11 Specifying a parser rule - the rule statement
4.12 Specifying the parser start rule name - the start statement
4.13 Specifying the parser module name - the module statement
4.14 Specifying the generated API prefix - the prefix statement
4.15 User termination of the lexer or parser
5 Propane generated API
5.1 Constants
5.2 Types
5.2.1 p_context_t
5.2.2 p_position_t
5.2.3 AST Node Types
5.2.3.1 AST Node Fields
5.3 Functions
5.3.1 p_context_init
5.3.2 p_parse
5.3.3 p_position_valid
5.3.4 p_result
5.3.5 p_position
5.3.6 p_user_terminate_code
5.3.7 p_token
5.4 Data
5.4.1 p_token_names
6 License
7 Contributing
8 Change Log

1 Overview

Propane is a LALR Parser Generator (LPG) which:

2 Installation

Propane is designed to be distributed as a stand-alone single file script that can be copied into and versioned in a project's source tree. The only requirement to run Propane is that the system has a Ruby interpreter installed. The latest release can be downloaded from https://github.com/holtrop/propane/releases. Simply copy the propane executable script into the desired location within the project to be built (typically the root of the repository) and mark it executable.

3 Command Line Usage

Propane is typically invoked from the command-line as ./propane.

Usage: ./propane [options] <input-file> <output-file>
Options:
  -h, --help  Show this usage and exit.
  --log LOG   Write log file. This will show all parser states and their
              associated shifts and reduces. It can be helpful when
              debugging a grammar.
  --version   Show program version and exit.
  -w          Treat warnings as errors. This option will treat shift/reduce
              conflicts as fatal errors and will print them to stderr in
              addition to the log file.

The user must specify the path to a Propane input grammar file and a path to an output file. The generated source code will be written to the output file. If a log file path is specified, Propane will write a log file containing detailed information about the parser states and transitions.

4 Propane Grammar File

A Propane grammar file provides Propane with the patterns, tokens, grammar rules, and user code blocks from which to build the generated lexer and parser.

Example grammar file:

<<
import std.math;
>>

# Parser values are unsigned integers.
ptype ulong;

# A few basic arithmetic operators.
token plus /\\+/;
token times /\\*/;
token power /\\*\\*/;
token integer /\\d+/ <<
  ulong v;
  foreach (c; match)
  {
    v *= 10;
    v += (c - '0');
  }
  $$ = v;
>>
token lparen /\\(/;
token rparen /\\)/;
# Drop whitespace.
drop /\\s+/;

Start -> E1 << $$ = $1; >>
E1 -> E2 << $$ = $1; >>
E1 -> E1 plus E2 << $$ = $1 + $3; >>
E2 -> E3 << $$ = $1; >>
E2 -> E2 times E3 << $$ = $1 * $3; >>
E3 -> E4 << $$ = $1; >>
E3 -> E3 power E4 << $$ = pow($1, $3); >>
E4 -> integer << $$ = $1; >>
E4 -> lparen E1 rparen << $$ = $2; >>

Grammar files can contain comment lines beginning with # which are ignored. White space in the grammar file is also ignored.

It is convention to use the extension .propane for the Propane grammar file, however any file name is accepted by Propane.

This user guide follows the convention of beginning a token name with a lowercase character and beginning a rule name with an uppercase character.

4.1 User Code Blocks

User code blocks begin following a "<<" token and end with a ">>" token found at the end of a line. All text lines in the code block are copied verbatim into the output file.

4.1.1 Standalone Code Blocks

C example:

<<
#include <stdio.h>
>>

D example:

<<
import std.stdio;
>>

Standalone code blocks are emitted early in the output file as top-level code outside the context of any function. Standalone code blocks are a good place to include/import any other necessary supporting code modules. They can also define helper functions that can be reused by lexer or parser user code blocks. They are emitted in the order they are defined in the grammar file.

For a C target, the word "header" may immediately follow the "<<" token to cause Propane to emit the code block in the generated header file rather than the generated implementation file. This allows including another header that may be necessary to define any types needed by a ptype directive, for example:

<<header
#include "mytypes.h"
>>

4.1.2 Lexer pattern code blocks

Example:

ptype ulong;

token integer /\\d+/ <<
  ulong v;
  foreach (c; match)
  {
    v *= 10;
    v += (c - '0');
  }
  $$ = v;
>>

Lexer code blocks appear following a token or pattern expression. User code in a lexer code block will be executed when the lexer matches the given pattern. Assignment to the $$ symbol will associate a parser value with the lexed token. This parser value can then be used later in a parser rule.

4.1.3 Parser rule code blocks

Example:

E1 -> E1 plus E2 << $$ = $1 + $3; >>

Parser rule code blocks appear following a rule expression. User code in a parser rule code block will be executed when the parser reduces the given rule. Assignment to the $$ symbol will associate a parser value with the reduced rule. Parser values for the rules or tokens in the rule pattern can be accessed positionally with tokens $1, $2, $3, etc...

Parser rule code blocks are not available in AST generation mode. In AST generation mode, a full parse tree is automatically constructed in memory for user code to traverse after parsing is complete.

4.2 AST generation mode - the ast statement

To activate AST generation mode, place the ast statement in your grammar file:

ast;

It is recommended to place this statement early in the grammar.

In AST generation mode various aspects of propane's behavior are changed:

Example AST generation grammar:

ast;

ptype int;

token a << $$ = 11; >>
token b << $$ = 22; >>
token one /1/;
token two /2/;
token comma /,/ <<
  $$ = 42;
>>
token lparen /\\(/;
token rparen /\\)/;
drop /\\s+/;

Start -> Items;

Items -> Item:item ItemsMore;
Items -> ;

ItemsMore -> comma Item:item ItemsMore;
ItemsMore -> ;

Item -> a;
Item -> b;
Item -> lparen Item:item rparen;
Item -> Dual;

Dual -> One Two;
Dual -> Two One;
One -> one;
Two -> two;

The following unit test describes the fields that will be present for an example parse:

string input = "a, ((b)), b";
p_context_t context;
p_context_init(&context, input);
assert_eq(P_SUCCESS, p_parse(&context));
Start * start = p_result(&context);
assert(start.pItems1 !is null);
assert(start.pItems !is null);
Items * items = start.pItems;
assert(items.item !is null);
assert(items.item.pToken1 !is null);
assert_eq(TOKEN_a, items.item.pToken1.token);
assert_eq(11, items.item.pToken1.pvalue);
assert(items.pItemsMore !is null);
ItemsMore * itemsmore = items.pItemsMore;
assert(itemsmore.item !is null);
assert(itemsmore.item.item !is null);
assert(itemsmore.item.item.item !is null);
assert(itemsmore.item.item.item.pToken1 !is null);
assert_eq(TOKEN_b, itemsmore.item.item.item.pToken1.token);
assert_eq(22, itemsmore.item.item.item.pToken1.pvalue);
assert(itemsmore.pItemsMore !is null);
itemsmore = itemsmore.pItemsMore;
assert(itemsmore.item !is null);
assert(itemsmore.item.pToken1 !is null);
assert_eq(TOKEN_b, itemsmore.item.pToken1.token);
assert_eq(22, itemsmore.item.pToken1.pvalue);
assert(itemsmore.pItemsMore is null);

4.3 ast_prefix and ast_suffix statements

In AST generation mode, structure types are defined and named based on the rules in the grammar. Additionally, a structure type called Token is generated to hold parsed token information.

These structure names can be modified by using the ast_prefix or ast_suffix statements in the grammar file. The field names that point to instances of the structures are not affected by the ast_prefix or ast_suffix values.

For example, if the following two lines were added to the example above:

ast_prefix ABC;
ast_suffix XYZ;

Then the types would be used as such instead:

string input = "a, ((b)), b";
p_context_t context;
p_context_init(&context, input);
assert_eq(P_SUCCESS, p_parse(&context));
ABCStartXYZ * start = p_result(&context);
assert(start.pItems1 !is null);
assert(start.pItems !is null);
ABCItemsXYZ * items = start.pItems;
assert(items.pItem !is null);
assert(items.pItem.pToken1 !is null);
assert_eq(TOKEN_a, items.pItem.pToken1.token);
assert_eq(11, items.pItem.pToken1.pvalue);
assert(items.pItemsMore !is null);
ABCItemsMoreXYZ * itemsmore = items.pItemsMore;
assert(itemsmore.pItem !is null);
assert(itemsmore.pItem.pItem !is null);
assert(itemsmore.pItem.pItem.pItem !is null);
assert(itemsmore.pItem.pItem.pItem.pToken1 !is null);

4.4 Specifying tokens - the token statement

The token statement allows defining a lexer token and a pattern to match that token. The name of the token must be specified immediately following the token keyword. A regular expression pattern may optionally follow the token name. If a regular expression pattern is not specified, the name of the token is taken to be the pattern. See also: Regular expression syntax.

Example:

token for;

In this example, the token name is for and the pattern to match it is /for/.

Example:

token lbrace /\{/;

In this example, the token name is lbrace and a single left curly brace will match it.

The token statement can also include a user code block. The user code block will be executed whenever the token is matched by the lexer.

Example:

token if << writeln("'if' keyword lexed"); >>

The token statement is actually a shortcut statement for a combination of a tokenid statement and a pattern statement. To define a lexer token without an associated pattern to match it, use a tokenid statement. To define a lexer pattern that may or may not result in a matched token, use a pattern statement.

4.5 Defining tokens without a matching pattern - the tokenid statement

The tokenid statement can be used to define a token without associating it with a lexer pattern that matches it.

Example:

tokenid string;

The tokenid statement can be useful when defining a token that may optionally be returned by user code associated with a pattern.

It is also useful when lexer modes and multiple lexer patterns are required to build up a full token. A common example is parsing a string. See the Lexer modes chapter for more information.

4.6 Specifying a lexer pattern - the pattern statement

A pattern statement is used to define a lexer pattern that can execute user code but may not result in a matched token.

Example:

/foo+/ << writeln("saw a foo pattern"); >>

This can be especially useful with Lexer modes.

See also Regular expression syntax.

4.7 Ignoring input sections - the drop statement

A drop statement can be used to specify a lexer pattern that when matched should result in the matched input being dropped and lexing continuing after the matched input.

A common use for a drop statement would be to ignore whitespace sequences in the user input.

Example:

drop /\s+/;

See also Regular expression syntax.

4.8 Regular expression syntax

A regular expression ("regex") is used to define lexer patterns in token, pattern, and drop statements. A regular expression begins and ends with a / character.

Example:

/#.*$/

Regular expressions can include many special characters:

Any other character just matches itself in the input stream.

A character class consists of a list of character alternates or character ranges that can be matched by the character class. For example [a-zA-Z_] matches any lowercase character between a and z or any uppercase character between A and Z or the underscore _ character. Character classes can also be negative character classes if the first character after the [ is a ^ character. In this case, the set of characters matched by the character class is the inverse of what it otherwise would have been. For example, [^0-9] matches any character other than 0 through 9.

A matching group can be used to override the pattern sequence that multiplicity specifiers apply to. For example, the pattern /foo+/ matches "foo" or "foooo", while the pattern /(foo)+/ matches "foo" or "foofoofoo", but not "foooo".

A count qualifier in curly braces can be used to restrict the number of matches of the preceding atom to an explicit minimum and maximum range. For example, the pattern \d{3} matches exactly 3 digits 0-9. Both a minimum and maximum multiplicity count can be specified and separated by a comma. For example, /a{1,5}/ matches between 1 and 5 a characters. Either the minimum or maximum count can be omitted to omit the corresponding restriction in the number of matches allowed.

An alternate match is created with the | character. For example, the pattern /foo|bar/ matches either the sequence "foo" or the sequence "bar".

4.9 Lexer modes

Lexer modes can be used to change the set of patterns that are matched by the lexer. A common use for lexer modes is to match strings.

Example:

<<
string mystringvalue;
>>

tokenid str;

# String processing
/"/ <<
  mystringvalue = "";
  $mode(string);
>>
string: /[^"]+/ << mystringvalue ~= match; >>
string: /"/ <<
  $mode(default);
  return $token(str);
>>

A lexer mode is defined by placing the name before a colon (:) character that precedes a token or pattern statement. The token or pattern statement is restricted to only applying if the named mode is active.

By default, the active lexer mode is named default. A $mode() call within a lexer code block can be used to change lexer modes.

In the above example, when the lexer in the default mode sees a doublequote (") character, the lexer code block will clear the mystringvalue variable and will set the lexer mode to string. When the lexer begins looking for patterns to match against the input, it will now look only for patterns tagged for the string lexer mode. Any non-" character will be appended to the mystringvalue string. A " character will end the string lexer mode and return to the default lexer mode. It also returns the str token now that the token is complete.

Note that the token name str above could have been string instead - the namespace for token names is distinct from the namespace for lexer modes.

4.10 Specifying parser value types - the ptype statement

The ptype statement is used to define parser value type(s). Example:

ptype void *;

This defines the default parser value type to be void * (this is, in fact, the default parser value type if the grammar file does not specify otherwise).

Each defined lexer token type and parser rule has an associated parser value type. When the lexer runs, each lexed token has a parser value associated with it. When the parser runs, each instance of a reduced rule has a parser value associated with it. Propane supports using different parser value types for different rules and token types. The example ptype statement above defines the default parser value type. A parser value type name can optionally be specified following the ptype keyword. For example:

ptype Value;
ptype array = Value[];
ptype dict = Value[string];

Object -> lbrace rbrace << $$ = new Value(); >>

Values (array) -> Value << $$ = [$1]; >>
Values -> Values comma Value << $$ = $1 ~ [$3]; >>

KeyValue (dict) -> string colon Value << $$ = [$1: $3]; >>

In this example, the default parser value type is Value. A parser value type named array is defined to mean Value[]. A parser value type named dict is defined to mean Value[string]. Any defined tokens or rules that do not specify a parser value type will have the default parser value type associated with them. To associate a different parser value type with a token or rule, write the parser value type name in parentheses following the name of the token or rule. In this example:

When AST generation mode is active, the ptype functionality works differently. In this mode, only one ptype is used by the parser. Lexer user code blocks may assign a parse value to the generated Token node by assigning to $$ within a lexer code block. The type of the parse value $$ is given by the global ptype type.

4.11 Specifying a parser rule - the rule statement

Rule statements create parser rules which define the grammar that will be parsed by the generated parser.

Multiple rules with the same name can be specified. Rules with the same name define a rule set for that name and act as alternatives that the parser can accept when attempting to match a reference to that rule.

The default start rule name is Start. This can be changed with the start statement. The grammar file must define a rule with the name of the start rule name which will be used as the top-level starting rule that the parser attempts to reduce.

Rule statements are composed of the name of the rule, a -> token, the fields defining the rule pattern that must be matched, and a terminating semicolon or user code block.

Example:

ptype ulong;
start Top;
token word /[a-z]+/ << $$ = match.length; >>
Top -> word << $$ = $1; >>

In the above example the Top rule is defined to match a single word token.

Another example:

Start -> E1 << $$ = $1; >>
E1 -> E2 << $$ = $1; >>
E1 -> E1 plus E2 << $$ = $1 + $3; >>
E2 -> E3 << $$ = $1; >>
E2 -> E2 times E3 << $$ = $1 * $3; >>
E3 -> E4 << $$ = $1; >>
E3 -> E3 power E4 << $$ = pow($1, $3); >>
E4 -> integer << $$ = $1; >>
E4 -> lparen E1 rparen << $$ = $2; >>

This example uses the default start rule name of Start.

A parser rule has zero or more fields on the right side of its definition. Each of these fields is either a token name or a rule name. A field can be immediately followed by a ? character to signify that it is optional. A field can optionally be followed by a : and then a field alias name. If present, the field alias name is used to refer to the field value in user code blocks, or if AST mode is active, the field alias name is used as the field name in the generated AST node structure. An optional and named field must use the format field?:name. Example:

token public;
token private;
token int;
token ident /[a-zA-Z_][a-zA-Z_0-9]*/;
token semicolon /;/;
IntegerDeclaration -> Visibility?:visibility int ident:name semicolon;
Visibility -> public;
Visibility -> private;

In a parser rule code block, parser values for the right side fields are accessible as $1 for the first field's parser value, $2 for the second field's parser value, etc... For the IntegerDeclaration rule, the first field value can also be referred to as ${visibility} and the third field value can also be referred to as ${name}. The $$ symbol accesses the output parser value for this rule. The above examples demonstrate how the parser values for the rule components can be used to produce the parser value for the accepted rule.

Parser rule code blocks are not allowed and not used when AST generation mode is active.

4.12 Specifying the parser start rule name - the start statement

The start rule can be changed from the default of Start by using the start statement. Example:

start MyStartRule;

4.13 Specifying the parser module name - the module statement

The module statement can be used to specify the module name for a generated D module.

module proj.parser;

If a module statement is not present, then the generated D module will not contain a module statement and the default module name will be used.

4.14 Specifying the generated API prefix - the prefix statement

By default the public API (types, constants, and functions) of the generated lexer and parser uses a prefix of p_.

This prefix can be changed with the prefix statement.

Example:

prefix myparser_;

With a parser generated with this prefix statement, instead of calling p_context_init() you would call myparser_context_init().

The prefix statement can be optionally used if you would like to change the prefix used by your generated lexer and parser to something other than the default.

It can also be used when generating multiple lexers/parsers to be used in the same program to avoid symbol collisions.

4.15 User termination of the lexer or parser

Propane supports allowing lexer or parser user code blocks to terminate execution of the parser. Some example uses of this functionality could be to:

To terminate parsing from a lexer or parser user code block, use the $terminate(code) function, passing an integer expression argument. For example:

NewExpression -> new Expression << $terminate(42); >>

The value passed to the $terminate() function is known as the "user terminate code". If the parser returns a P_USER_TERMINATED result code, then the user terminate code can be accessed using the p_user_terminate_code() API function.

5 Propane generated API

By default, Propane uses a prefix of p_ when generating a lexer/parser. This prefix is used for all publicly declared types and functions. The uppercase version of the prefix is used for all constant values.

This section documents the generated API using the default p_ or P_ names.

5.1 Constants

Propane generates the following result code constants:

Result codes are returned by the functions p_decode_input(), p_lex(), and p_parse().

5.2 Types

5.2.1 p_context_t

Propane defines a p_context_t structure type. The structure is intended to be used opaquely and stores information related to the state of the lexer and parser. Integrating code must define an instance of the p_context_t structure. A pointer to this instance is passed to the generated functions.

5.2.2 p_position_t

The p_position_t structure contains two fields row and col. These fields contain the 1-based row and column describing a parser position.

For D targets, the p_position_t structure can be checked for validity by querying the valid property.

For C targets, the p_position_t structure can be checked for validity by calling p_position_valid(pos) where pos is a p_position_t structure instance.

5.2.3 AST Node Types

If AST generation mode is enabled, a structure type for each rule will be generated. The name of the structure type is given by the name of the rule. Additionally a structure type called Token is generated to represent an AST node which refers to a raw parser token rather than a composite rule.

5.2.3.1 AST Node Fields

All AST nodes have a position field specifying the text position of the beginning of the matched token or rule, and an end_position field specifying the text position of the end of the matched token or rule. Each of these fields are instances of the p_position_t structure.

A Token node will always have a valid position and end_position. A rule node may not have valid positions if the rule allows for an empty match. In this case the position structure should be checked for validity before using it. For C targets this can be accomplished with if (p_position_valid(node->position)) and for D targets this can be accomplished with if (node.position.valid).

A Token node has the following additional fields:

AST node structures for rules contain generated fields based on the right hand side components specified for all rules of a given name.

In this example:

Start -> Items;

Items -> Item ItemsMore;
Items -> ;

The Start structure will have a field called pItems and another field of the same name but with a positional suffix (pItems1) which both point to the parsed Items node. Their value will be null if the parsed Items rule was empty.

The Items structure will have fields:

If a rule can be empty (for example in the second Items rule above), then an instance of a pointer to that rule's generated AST node will be null if the parser matches the empty rule pattern.

The non-positional AST node field pointer will not be generated if there are multiple positions in which an instance of the node it points to could be present. For example, in the below rules:

Dual -> One Two;
Dual -> Two One;

The generated Dual structure will contain pOne1, pTwo2, pTwo1, and pOne2 fields. However, a pOne field and pTwo field will not be generated since it would be ambiguous which one was matched.

If the first rule is matched, then pOne1 and pTwo2 will be non-null while pTwo1 and pOne2 will be null. If the second rule is matched instead, then the opposite would be the case.

If a field alias is present in a rule definition, an additional field will be generated in the AST node with the field alias name. For example:

Exp -> Exp:left plus ExpB:right;

In the generated Exp structure, the fields pExp, pExp1, and left will all point to the same child node (an instance of the Exp structure), and the fields pExpB, pExpB3, and right will all point to the same child node (an instance of the ExpB structure).

5.3 Functions

5.3.1 p_context_init

The p_context_init() function must be called to initialize the context structure. The input to be used for lexing/parsing is passed in when initializing the context structure.

C example:

p_context_t context;
p_context_init(&context, input, input_length);

D example:

p_context_t context;
p_context_init(&context, input);

5.3.2 p_parse

The p_parse() function is the main entry point to the parser. It must be passed a pointer to an initialized context structure.

Example:

p_context_t context;
p_context_init(&context, input, input_length);
size_t result = p_parse(&context);

5.3.3 p_position_valid

The p_position_valid() function is only generated for C targets. it is used to determine whether or not a p_position_t structure is valid.

Example:

if (p_position_valid(node->position))
{
    ....
}

For D targets, rather than using p_position_valid(), the valid property function of the p_position_t structure can be queried (e.g. if (node.position.valid)).

5.3.4 p_result

The p_result() function can be used to retrieve the final parse value after p_parse() returns a P_SUCCESS value.

Example:

p_context_t context;
p_context_init(&context, input, input_length);
size_t result = p_parse(&context);
if (p_parse(&context) == P_SUCCESS)
{
    result = p_result(&context);
}

If AST generation mode is active, then the p_result() function returns a Start * pointing to the Start AST structure.

5.3.5 p_position

The p_position() function can be used to retrieve the parser position where an error occurred.

Example:

p_context_t context;
p_context_init(&context, input, input_length);
size_t result = p_parse(&context);
if (p_parse(&context) == P_UNEXPECTED_TOKEN)
{
    p_position_t error_position = p_position(&context);
    fprintf(stderr, "Error: unexpected token at row %u column %u\n",
        error_position.row + 1, error_position.col + 1);
}

5.3.6 p_user_terminate_code

The p_user_terminate_code() function can be used to retrieve the user terminate code after p_parse() returns a P_USER_TERMINATED value. User terminate codes are arbitrary values that can be defined by the user to be returned when the user requests to terminate parsing. They have no particular meaning to Propane.

Example:

if (p_parse(&context) == P_USER_TERMINATED)
{
    size_t user_terminate_code = p_user_terminate_code(&context);
}

5.3.7 p_token

The p_token() function can be used to retrieve the current parse token. This is useful after p_parse() returns a P_UNEXPECTED_TOKEN value. terminate code after p_parse() returns a P_USER_TERMINATED value to indicate what token the parser was not expecting.

Example:

if (p_parse(&context) == P_UNEXPECTED_TOKEN)
{
    p_token_t unexpected_token = p_token(&context);
}

5.4 Data

5.4.1 p_token_names

The p_token_names array contains the grammar-specified token names. It is indexed by the token ID.

C example:

p_context_t context;
p_context_init(&context, input, input_length);
size_t result = p_parse(&context);
if (p_parse(&context) == P_UNEXPECTED_TOKEN)
{
    p_position_t error_position = p_position(&context);
    fprintf(stderr, "Error: unexpected token `%s' at row %u column %u\n",
        p_token_names[context.token],
        error_position.row + 1, error_position.col + 1);
}

6 License

Propane is licensed under the terms of the MIT License:

The MIT License (MIT)

Copyright (c) 2010-2024 Josh Holtrop

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

7 Contributing

Propane is developed on github.

Issues may be submitted to https://github.com/holtrop/propane/issues.

Pull requests may be submitted as well:

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

8 Change Log

v2.1.1

Fixes

v2.1.0

Improvements

v2.0.0

Improvements

Fixes

Upgrading

v1.5.1

Improvements

v1.5.0

New Features

Improvements

v1.4.0

New Features

Improvements

v1.3.0

New Features

v1.2.0

New Features

Fixes

v1.1.0

New Features

v1.0.0