diff options
author | robot-contrib <robot-contrib@yandex-team.com> | 2024-02-02 12:59:30 +0300 |
---|---|---|
committer | Alexander Smirnov <alex@ydb.tech> | 2024-02-09 19:17:15 +0300 |
commit | b07d0f5a11bc9e99d00f4e09eeee6112e88c9ce4 (patch) | |
tree | f7ca8545e0de0fff895c8ce12e42653171063dd2 /contrib/libs/libidn/CONTRIBUTING.md | |
parent | d299e8854d8ffcea39aa93e6c807bdb93a0821ae (diff) | |
download | ydb-b07d0f5a11bc9e99d00f4e09eeee6112e88c9ce4.tar.gz |
Update contrib/libs/libidn to 1.42
Diffstat (limited to 'contrib/libs/libidn/CONTRIBUTING.md')
-rw-r--r-- | contrib/libs/libidn/CONTRIBUTING.md | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/contrib/libs/libidn/CONTRIBUTING.md b/contrib/libs/libidn/CONTRIBUTING.md new file mode 100644 index 0000000000..b68a5ebe5c --- /dev/null +++ b/contrib/libs/libidn/CONTRIBUTING.md @@ -0,0 +1,111 @@ +# Contributing to Libidn + +This file contains instructions for developers and advanced users that +wants to build from version controlled sources. + +We rely on several tools to build the software, including: + +- Make <https://www.gnu.org/software/make/> +- C compiler <https://www.gnu.org/software/gcc/> +- Automake <https://www.gnu.org/software/automake/> +- Autoconf <https://www.gnu.org/software/autoconf/> +- Libtool <https://www.gnu.org/software/libtool/> +- Gettext <https://www.gnu.org/software/gettext/> +- Texinfo <https://www.gnu.org/software/texinfo/> +- Gperf <https://www.gnu.org/software/gperf/> +- help2man <https://www.gnu.org/software/help2man/> +- Gengetopt <https://www.gnu.org/software/gengetopt/> +- Tar <https://www.gnu.org/software/tar/> +- Gzip <https://www.gnu.org/software/gzip/> +- Texlive & epsf <https://tug.org/texlive/> (for PDF manual) +- GTK-DOC <https://gitlab.gnome.org/GNOME/gtk-doc> (for API manual) +- Git <https://git-scm.com/> +- Perl <https://www.cpan.org/src/http://www.cpan.org/> +- Valgrind <https://valgrind.org/> (optional) +- OpenJDK (for java port) +- Mono mcs <https://www.mono-project.com/> (for C# port) +- fig2dev <https://sourceforge.net/projects/mcj/> + +The software is typically distributed with your operating system, and +the instructions for installing them differ. Here are some hints: + +APT/DPKG-based distributions: +``` +apt-get install make git autoconf automake libtool gettext autopoint cvs +apt-get install texinfo texlive texlive-plain-generic texlive-extra-utils +apt-get install help2man gtk-doc-tools dblatex valgrind gengetopt +apt-get install transfig mono-mcs gperf default-jdk-headless +``` + +DNF/RPM-based distributions: +``` +dnf install -y make git autoconf automake libtool gettext-devel cvs +dnf install -y texinfo texinfo-tex texlive +dnf install -y help2man gtk-doc gengetopt dblatex valgrind +dnf install -y gperf java-latest-openjdk-devel +``` + +On macOS with Xcode and Homebrew: +``` +brew install autoconf automake libtool gengetopt help2man texinfo fig2dev +``` + +To download the version controlled sources: + +``` +git clone https://git.savannah.gnu.org/git/libidn.git +cd libidn +``` + +The next step is to import gnulib files, run autoreconf etc: + +``` +./bootstrap +``` + +If you have a local checkout of gnulib and wants to avoid download +another copy, you may want to use: + +``` +./bootstrap --gnulib-refdir=../gnulib +``` + +Then configure the project as you would normally, for example: + +``` +./configure --enable-java --enable-gtk-doc-pdf +``` + +Then build the project: + +``` +make +make check +``` + +To prepare releases you need some additional tools: + +- Mingw (to produce Windows binaries) +- Wine (to self-check Windows binaries) +- Lcov (to produce coverage HTML pages) +- Zip (to pack Windows binaries) +- Clang (to produce clang analysis) +- Doxygen (to produce doxygen manual) +- pmccabe (to produce cyclomatic code complexity report) +- ncftpput (to upload source tarballs) + +APT/DPKG-based distributions: +``` +apt-get install mingw-w64 wine binfmt-support lcov zip +apt-get install clang doxygen pmccabe ncftp +``` + +See README-release on how to make a release. + +Happy hacking! + +---------------------------------------------------------------------- +Copyright (C) 2009-2024 Simon Josefsson +Copying and distribution of this file, with or without modification, +are permitted in any medium without royalty provided the copyright +notice and this notice are preserved. |