Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

87 lines (65 loc) · 2.85 KB
Raw

Libidn2 CONTRIBUTING -- Information for developers

Copyright (C) 2011-2021 Simon Josefsson See the end for copying conditions.

This file contains instructions for developers and advanced users. See README for the additional tools you need to have installed.

Obtaining sources

Download the version controlled sources:

$ git clone https://gitlab.com/libidn/libidn2.git
$ cd libidn2

Building the project

Prepare building with

$ ./bootstrap
$ ./configure --enable-gtk-doc --enable-gtk-doc-pdf --enable-gcc-warnings --enable-valgrind-tests

You may want to use ./bootstrap --gnulib-srcdir=/foo/bar/gnulib' (or set the GNULIB_SRCDIR' environment variable) to avoid having to checkout gnulib every time. Make sure the gnulib directory you point to is up to date.

Then build the project normally:

$ make
$ make check

Test suite:

New functionality should be accompanied by a test case which verifies the correctness of the new functionality as well as under failure. The libidn2 test suite is run on "make check".

When submitting patches it is recommended to open a new merge request on the gitlab site, to force the changes to pass the automated test suite.

Continuous Integration

The project is built auomatically on every git commit using GitLab CI/CD, see the file .gitlab-ci.yml for rules and current libidn2 pipeline.

Cross-compiling

It is possible to cross-compile libidn2. It is expected that your cross compiler toolchain have a specific prefix to the target host. For example compiling for Windows with mingw64 (with prefix i686-w64-mingw32) can be done the following way:

./configure --host=i686-w64-mingw32 && make

Note that you must perform a make step using your native compiler after the initial ./bootstrap and ./configure to generate some files. When cross-compiling from version controlled, you thus need to perform a two-step build. Consider cross-compiling from a tarball generated using make dist too.

Release process

Read README-release on how to prepare a new release. The file is generated by running ./bootstrap, see above on building.

Happy hacking!

This file is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This file is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this file. If not, see https://www.gnu.org/licenses/.