Commit Graph

47 Commits

Author SHA1 Message Date
Mateusz Łoskot
9f5f24affd
Add Markdown linting with Node package markdownlint [ci skip] 2019-11-04 23:54:18 +01:00
Mateusz Łoskot
e2c26ce2cc
CONTRIBUTING.md: Remove logo as unnecessary [ci skip] 2019-11-03 23:23:17 +01:00
Mateusz Łoskot
427b3f0f57
Update documentation on dependencies required by tests and examples [ci skip] 2019-10-10 12:27:02 +02:00
Mateusz Łoskot
bd91abfff3
Add cmake-variants.yaml sample for Visual Studio Code + CMake Tools [skip ci] 2019-07-04 23:57:30 +02:00
Mateusz Łoskot
895aa77fb6
[CMake] Remove GIL_DOWNLOAD_FINDBOOST option (#307)
Upcoming CMake 3.15 introduced more dependencies in FindBoost.cmake
what makes the downloading impractical.
2019-06-05 09:19:17 +02:00
Mateusz Łoskot
5024f6ffdd
Guidelines: increase line length limit to 100 characters [ci skip] 2019-05-31 22:07:48 +02:00
Mateusz Łoskot
4ed7701b47
Move tests of extensions inside test/ directory (#302)
Split header tests accordingly i.e. test core headers as part of
core tests, numeric extension headers as part of numeric tests, etc.

It extends the convention of sub-directories already established in
`include/boost/gil` directory. It is sensible to follow it in other
areas of the source tree (i.e. `test/`, `doc/` and `benchmark/`).

Another important reason to move the tests is to enable removal of
the top-level `Jamfile` with all its definitions of test-specific
requirements.
The top-level `Jamfile` is not advised, especially if it specifies
build requirements like C++ language version.
Those affect non-tests builds e.g. documentation, causing failures
during generation of HTML documentation (leads to missing docs).
2019-05-28 18:58:22 +02:00
Mateusz Łoskot
a6283366a2
Fix remote URL [skip ci] 2019-05-27 17:31:22 +02:00
Mateusz Łoskot
43908adccc
Tweak info on adding remote [skip ci] 2019-05-27 17:30:01 +02:00
Mateusz Łoskot
d60a9c1886
Add missing word [ci skip] 2019-05-27 17:15:52 +02:00
Mateusz Łoskot
72dae8b572
Update procedure of updating pull request [skip ci] 2019-05-27 17:12:36 +02:00
Mateusz Łoskot
7977b279cf
Add section on CMakeSettings.json for VS 2019-04-11 18:36:12 +02:00
Mateusz Łoskot
c8a8dd4dd2
Correct git clone arguments [ci skip] 2019-03-11 18:55:55 +01:00
Mateusz Łoskot
ecf41b59ae
Update example/README.txt and convert to Markdown [ci skip]
Update README.md and CONTRIBUTING.md about available examples.

Clarifies #252 and #253
2019-03-06 19:24:13 +01:00
Mateusz Łoskot
8e7bda62f5
Move GIL's original test suites to test/legacy/ (#239)
Document maintenance rules of `test/legacy/` content.

Motivation to move the `test/legacy/` is to:
* clarify status of those tests
* make it easier to run tests selectively
* separate new/upcoming feature-specific tests
  from those all-in-one tests.

Other changes:
Rename `gil_test_common.hpp` to `unit_test.hpp` to make
it clearer it acts as `boost/test/unit_test.hpp proxy`.
Remove `<include>$(BOOST_ROOT)` from `Jamfile`-s as unnecessary.
2019-02-20 19:03:28 +00:00
Mateusz Loskot
585e9226c8
Update CONTRIBUTING.md with PRs do's and don'ts [ci skip] (#216)
This update does not introduce any major modification to the current
workflow, it adds a more formal description of it.
Copied from CoreFX guidelines at
https://github.com/dotnet/corefx/blob/master/Documentation/project-docs/contributing.md
with minor updates (e.g. to allow work-in-progress PRs).
2019-01-18 15:52:43 +01:00
Mateusz Łoskot
ff5ddb4d93
[cmake] Make purpose of CMake clear [ci skip]
The CMake configuration is only provided for convenience
of contributors. It does not export or install any targets,
deploy config files or support subproject workflow.
2019-01-06 00:49:28 +01:00
Mateusz Łoskot
8ecc659854 [cmake] Allow to specify newer version of C++ 2019-01-05 22:07:19 +01:00
Mateusz Łoskot
f300271fa3 [cmake] Add GIL_ENABLE_EXT_* options [ci skip] 2018-12-13 00:57:30 +01:00
Mateusz Łoskot
d2bb35ba85 Redirect clang-tidy output to a file [ci skip] 2018-12-13 00:04:27 +01:00
Mateusz Łoskot
d9dfc3800c [doc] Update running clang-tidy how-to [ci skip] 2018-12-12 21:20:49 +01:00
Mateusz Łoskot
9533d5c101
Add -j8 to b2 invocation [ci skip]
Fix typos
2018-12-10 10:51:35 +01:00
Mateusz Loskot
e0288ece9e
Apply clang-tidy modernize-use-nullptr (#180)
Used clang-tidy 7.0 with the command:

  run-clang-tidy.py \
      -header-filter='boost\/gil\/.*' \
      -checks='-*,modernize-use-nullptr' -fix

Update CONTRIBUTING.md on how to generate compile command
database and run clang-tidy.
2018-12-10 09:58:37 +01:00
Mateusz Łoskot
77e8a9bed4
Remove sample CMake output from CONTRIBUTING.md [ci skip]
There is little point in displaying it and it changes from time to time.
2018-12-09 12:52:31 +01:00
Mateusz Łoskot
b07501a8cc
[cmake] Simplify and clarify -D options [ci skip]
Clean up CMakeLists.txt if-s.
2018-12-08 21:25:27 +01:00
Mateusz Łoskot
c1334b60fe
Refer to EditorConfig that helps to avoid trailing whitespaces [ci skip]
Following #171 we should keep the code free from trailing whitespaces.
2018-12-07 10:10:54 +01:00
Mateusz Łoskot
af4f0ef7f1 Update CONTRIBUTING.md for CMake 3.13 or later [ci skip]
Follows up recent CMake fixes in FindBoost.cmake:
- https://gitlab.kitware.com/cmake/cmake/merge_requests/2568
- https://gitlab.kitware.com/cmake/cmake/merge_requests/2579
2018-12-06 21:03:36 +01:00
Mateusz Loskot
31d58273f6
[cmake] Fix missing hyphen in -D option [ci skip] 2018-10-25 21:18:53 +02:00
Mateusz Łoskot
52cbffd661
[cmake] Add tips on how to troubleshoot CMake faliures to find Boost [ci skip] 2018-10-25 17:42:29 +02:00
Mateusz Łoskot
1ca412691c Update b2 commands for Boost libraries [ci skip]
Show how to get complete staged build using versioned layout.
Tidy up.
2018-10-19 22:34:25 +02:00
Mateusz Łoskot
32fec9f05b
Refactor library includes to #include <boost/gil/...>
Group include directives, sort within group:
* In headers of GIL core and extensions:
  1. boost/gil/extension/*
  2. boost/gil/*
  3. boost/*
  4. C++ standard library headers
* In programs:
  1. boost/gil/*
  2. boost/*
  3. C++ standard library headers
  4. "xxx.hpp" for local headers
Add basic guidelines to CONTRIBUTING.md.
Add/Remove #include <boost/config.hpp> or std headers un/necessary.
Rename gil_concept.hpp to concepts.hpp.
Remove gil_all.hpp - we already have all-in-one boost/gil.hpp.
Tidy up and unify copyright and license header.
Tidy up formatting and excessive whitespaces in some comments.
Remove Doxygen block with file description, author, date, etc.
Remove dead or commented pragmas and directives.
Trim trailing whitespaces.
2018-09-28 16:26:34 +02:00
Mateusz Łoskot
0dbca043a8 Unify git submodule update command [ci skip] 2018-09-16 22:06:34 +02:00
Mateusz Łoskot
46e29e396c Expose C++11 requirement [ci skip] 2018-08-29 16:21:06 +02:00
Mateusz Łoskot
0c9053f28d Format preparation steps for better readability [ci skip] 2018-08-24 09:55:55 +02:00
Mateusz Łoskot
4811017934 Fix TOC internal links in CONTRIBUTING.md [ci skip] 2018-07-04 01:34:13 +02:00
Mateusz Łoskot
1fc2f43fb3 Require PRs to be based on develop, and never on master [ci skip] 2018-07-03 18:05:20 +02:00
Mateusz Łoskot
a000f26cf4 Fix mention links in CONTRIBUTING.md [ci skip] 2018-06-27 00:02:27 -04:00
Mateusz Łoskot
472ec6bafc [doc] Describe development workflow using CMake [ci skip]
Add "Using Faber" section.
2018-06-27 00:02:27 -04:00
Mateusz Łoskot
57693484df Suggest use of --jobs N for git commands where applicable
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
b0627dd1dc Clarify console input belongs to listed steps
Fenced code in numbered or bullet list works in Markdown.

[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
a872cea86b Add TIP about complete clean-up and reset of super-project repository
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
b92ee65973 Add TIP on testing against master branch of Boost super-project
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
d09ab2e473 Add Table of Contents to CONTRIBUTING.md
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
2a3b350c5f Add TIP on copying b2 to PATH
[ci skip]
[skip ci]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
a2cf24c78e Link README for CI build status
[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
e68b80f7fd Running b2 headers is optional step
b2 headers can run on demand, linking minimal
set of required headers, see
https://lists.boost.org/boost-build/2018/04/29892.php

[ci skip]
2018-06-27 00:02:27 -04:00
Mateusz Loskot
3c0f29e1d4 First stab at CONTRIBUTING.md
- Maintain important/official documentation in single place (ie. repo),
  instead of wiki where it may become too distributed.
- Follow GitHub recommended practice,
  https://blog.github.com/2012-09-17-contributing-guidelines/

[ci skip]
2018-06-27 00:02:27 -04:00