Add a README.txt with context for libcheck
[platform/upstream/gstreamer.git] / libs / gst / check / libcheck / README.txt
1 This is a copy of libcheck, a unit testing framework for C:
2
3 https://github.com/libcheck/check/
4
5 The last update was on 9th December, with the following commit: ba42e7de3d62ea9d3699bf0709554b3e47a8f09e
6
7 The check*.c files in this directory are the same as those in the src/
8 directory in upstream. The files in the libcompat/ directory are the same as
9 those in the lib/ directory upstream.
10
11 lib/snprintf.c was omitted since we don't run on any platforms that don't
12 provide snprintf and the upstream implementation is ~2000 lines.
13
14 Steps to sync with upstream:
15
16 1. Clone libcheck from the above git repository
17 2. Copy files into this directory
18 3. Run GNU indent on all the code
19 4. Fix internal #includes
20 5. Manually inspect the diff
21 6. Update configure.ac, m4/check-checks.m4, meson.build files, etc
22 6. Run make check, then commit and push
23
24 Any changes made to files in this directory must be submitted upstream via
25 a pull request: https://github.com/libcheck/check/compare
26
27 This involves creating an account on GitHub, forking libcheck/check there,
28 pushing the changes into a branch, and then submitting it as a pull request.