Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor library includes to #include <boost/gil/...> #145

Conversation

mloskot
Copy link
Member

@mloskot mloskot commented Sep 28, 2018

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.


This is quite a big changeset, so detailed review may be not quite practical, so I listed all kinds of changes in the log. I might have skipped listing one or two things, like Add or copy TODO comment where obvious :-)

References

Tasklist

  • Review
  • Adjust for comments
  • All CI builds and checks have passed

Copy link
Contributor

@chhenning chhenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the tests run through I do approve this long pull request.

CONTRIBUTING.md Outdated Show resolved Hide resolved
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.
@mloskot mloskot force-pushed the ml/includes-relative-to-boost-root-and-sorted branch from 89addd2 to 32fec9f Compare September 28, 2018 14:26
@mloskot mloskot merged commit 7293313 into boostorg:develop Sep 28, 2018
@mloskot mloskot deleted the ml/includes-relative-to-boost-root-and-sorted branch September 28, 2018 19:33
@mloskot mloskot added this to the Boost 1.69 milestone Mar 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants