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

Upgrade documentation regarding CMake & Tests #2088

Merged
merged 8 commits into from
Feb 11, 2022
Merged

Upgrade documentation regarding CMake & Tests #2088

merged 8 commits into from
Feb 11, 2022

Conversation

piponazo
Copy link
Collaborator

As discussed at #2082 and #2080, I decided to spend some time reviewing the documentation regarding CMake and how to run the tests.

Now we are hardcoding the C++17 requirement into cmake/compilerFlags.cmake
README.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 10, 2022

Codecov Report

Merging #2088 (6180c94) into main (99f363c) will decrease coverage by 0.21%.
The diff coverage is n/a.

❗ Current head 6180c94 differs from pull request most recent head 66efb86. Consider uploading reports for the commit 66efb86 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2088      +/-   ##
==========================================
- Coverage   62.08%   61.87%   -0.22%     
==========================================
  Files          96       96              
  Lines       19153    19059      -94     
  Branches     9798     9782      -16     
==========================================
- Hits        11891    11792      -99     
- Misses       4967     4984      +17     
+ Partials     2295     2283      -12     
Impacted Files Coverage Δ
src/safe_op.hpp 69.23% <0.00%> (-27.65%) ⬇️
include/exiv2/slice.hpp 69.64% <0.00%> (-21.89%) ⬇️
include/exiv2/error.hpp 60.71% <0.00%> (-4.81%) ⬇️
src/utils.cpp 38.46% <0.00%> (-1.93%) ⬇️
include/exiv2/value.hpp 82.68% <0.00%> (-0.56%) ⬇️
src/enforce.hpp 75.00% <0.00%> (+2.77%) ⬆️
src/getopt.cpp 67.30% <0.00%> (+5.76%) ⬆️
include/exiv2/metadatum.hpp 88.88% <0.00%> (+16.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 99f363c...66efb86. Read the comment docs.

@clanmills
Copy link
Collaborator

BTW, I agree with you that $ make is very familiar and the way in which most folks will build and test exiv2. Except for MSVC users on DOS.

Documenting everything with conan/cmake/ctest commands runs everywhere. It's early days to call make legacy. However, we can see the direction of the wind. I think @kmilos believes that we should discourage the use of make and other unix style tools.

clanmills
clanmills previously approved these changes Feb 10, 2022
Copy link
Collaborator

@clanmills clanmills left a comment

Choose a reason for hiding this comment

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

Thanks, that's really good. Can you update the trailer with the revision date and remove my name/email. If you wish, you can add your name. I did this as a courtesy, however it's quite unnecessary. Putting the revision date in the document is useful.

@clanmills clanmills linked an issue Feb 10, 2022 that may be closed by this pull request
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@piponazo
Copy link
Collaborator Author

I think I have covered all the points addressed by @kmilos . Please let me know if I forgot something

README.md Outdated Show resolved Hide resolved
@piponazo piponazo merged commit a8a995f into main Feb 11, 2022
@piponazo piponazo deleted the main_DocTests branch February 11, 2022 13:37
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.

Contributor documentation for running tests does not work
3 participants