Andrea Pappacoda 8aa5c8b2a4

This small patch fixes some minor Markdown issues in the README and
CONTRIBUTING files:

- Add a blank line before and after block elements like lists and code
  blocks. This specified in the [original Markdown syntax] document,
  and can also create some issues with some parsers (see [MD32]).
- Add a blank line around headings, for the same reasons as above.
- Only use one top-level (H1) heading per document.
- Always specify a language in fenced code blocks, so that plugins like
  highlight.js can correctly highlight them
- Remove unused links from the bottom of README.md.

[original Markdown syntax]: https://daringfireball.net/projects/markdown/syntax
[MD32]: https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md032

2022-09-25 01:49:34 +10:00

3.7 KiB

Raw Blame History

Contributing to toml++

Contributions are very welcome! Either by reporting issues or submitting pull requests. If you wish to submit a PR, please be aware that:

The single-header file toml.hpp is generated by a script; make your changes in the files in include, not in toml.hpp.
Your changes should compile warning-free on at least one of:
- GCC 8 or higher
- Clang 8 or higher
- MSVC 19.2X (Visual Studio 2019) or higher
You should regenerate the single-header file as part of your PR (a CI check will fail if you don't).

Regenerating toml.hpp

Make your changes as necessary
- If you've added a new header file that isn't going to be transitively included by one of the others, add an include directive to include/toml++/toml.h
Install the prerequisite python packages: pip3 install -r tools/requirements.txt
Run tools/generate_single_header.py

Building and running the tests

Testing is done using Catch2.

Testing on Windows with Visual Studio

Install Visual Studio and Test Adapter for Catch2, then open toml++.sln and build the projects in the tests solution folder. Visual Studio's Test Explorer should pick these up and allow you to run the tests directly.

If test discovery fails you can usually fix it by enabling Auto Detect runsettings Files (settings gear icon > Configure Run Settings).

Testing on Linux (and WSL)

# install ninja, meson, locales (first time only)
sudo apt update && sudo apt install -y locales python3 python3-pip ninja-build
sudo pip3 install meson
sudo locale-gen 'en_US.utf8' \
                'ja_JP.utf8' \
                'de_DE.utf8' \
                'it_IT.utf8' \
                'tr_TR.utf8' \
                'fi_FI.utf8' \
                'fr_FR.utf8' \
                'zh_CN.utf8'

# create the build configs (first time only)
CXX=g++     meson build-gcc-debug     --buildtype=debug   -Dpedantic=true -Dbuild_tests=true -Dgenerate_cmake_config=false
CXX=clang++ meson build-clang-debug   --buildtype=debug   -Dpedantic=true -Dbuild_tests=true -Dgenerate_cmake_config=false
CXX=g++     meson build-gcc-release   --buildtype=release -Dpedantic=true -Dbuild_tests=true -Dgenerate_cmake_config=false
CXX=clang++ meson build-clang-release --buildtype=release -Dpedantic=true -Dbuild_tests=true -Dgenerate_cmake_config=false

# run the tests
cd build-gcc-debug && ninja && ninja test               \
    && cd ../build-clang-debug && ninja && ninja test   \
    && cd ../build-gcc-release && ninja && ninja test   \
    && cd ../build-clang-release && ninja && ninja test \
    && cd ..

ℹ️ To ensure parity between single-header and regular versions of the library, 50% of the tests will be compiled using one, and 50% with the other. Ensure you've regenerated toml.hpp before running tests.

ℹ️ Pass -Duse_vendored_libs=false to Meson if you wish to use the system-installed version of Catch2 rather than the vendored one.

Testing with the toml-test suite

As an optional extra you may wish to test against the 'official' test TOML test suite, BurntSushi/toml-test. See the instructions at toml-test/README. Note that the toml++ tests already consume tests from the offical suite via a C++ code-generation script so you are not expected to take this extra step as part of contributing to the library.

3.7 KiB Raw Blame History Unescape Escape