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

fixed make install, close #335 #354

Merged
merged 7 commits into from
Sep 28, 2023

Conversation

AryanGitHub
Copy link
Contributor

Now, we can build the project and run sudo make install to install this header library.

  • A description of the changes proposed in the pull request.
  1. I moved the files src from $(project_dir)/include to $(project_dir)/include/CXXGraph
  2. fixed the relative headers within $(project_dir)/include/CXXGraph
  3. fixed header links in $(project_dir)/test , $(project_dir)/examples , $(project_dir)/benchmark
  • Finally to make sure everything is working
  1. got successfully compiled with a new header.
  2. run tests, examples,and benchmark.

Why do we need to do this and what's the need?

When installing without this fix, it placed the files and folders of $(project_dir)/include , which are CXXGraphConfig.h CXXGraph.hpp Edge Graph Node Partitioning Utility into /usr/local/include, hence populating it with a lot of folders.

Now with the help of this fix:
we get one single folder /usr/local/include/CXXGraph in which every file is located.
and can now run this library codes without including a path.

What has been changed?

  • replace #include "CXXGraph.hpp" with #include "CXXGraph/CXXGraph.hpp", when running using the include folder
  • and use #include <CXXGraph/CXXGraph.hpp> when library is successfully installed

Note

I have used #include "CXXGraph/CXXGraph.hpp", instead of #include <CXXGraph/CXXGraph.hpp> , in the whole codebase here, because we don't know a user has installed the library or not, for the running our provided tests, examples, and benchmarks.
using #include "CXXGraph/CXXGraph.hpp" and correct CMakeLists target_include_directories we can always compile is successfully, for tests, benchmarks and examples.

@ZigRazor

@github-actions github-actions bot added test Something about test core something about core repo something about repo labels Sep 27, 2023
@ghost
Copy link

ghost commented Sep 27, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@AryanGitHub
Copy link
Contributor Author

I have closed #353 because it had some internal issues with the branch syncing with github.
please use this PR.

@codecov
Copy link

codecov bot commented Sep 27, 2023

Codecov Report

Merging #354 (b4119b0) into master (8cd3ba2) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #354   +/-   ##
=======================================
  Coverage   97.47%   97.47%           
=======================================
  Files          55       55           
  Lines        8745     8745           
=======================================
  Hits         8524     8524           
  Misses        221      221           
Flag Coverage Δ
unittests 97.47% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
include/CXXGraph/Edge/DirectedEdge.hpp 100.00% <ø> (ø)
include/CXXGraph/Edge/DirectedWeightedEdge.hpp 100.00% <ø> (ø)
include/CXXGraph/Edge/Edge.hpp 100.00% <ø> (ø)
include/CXXGraph/Edge/UndirectedEdge.hpp 100.00% <ø> (ø)
include/CXXGraph/Edge/UndirectedWeightedEdge.hpp 100.00% <ø> (ø)
include/CXXGraph/Edge/Weighted.hpp 100.00% <ø> (ø)
include/CXXGraph/Graph/Graph.hpp 95.50% <ø> (ø)
include/CXXGraph/Node/Node.hpp 100.00% <ø> (ø)
...XXGraph/Partitioning/CoordinatedPartitionState.hpp 75.63% <ø> (ø)
...nclude/CXXGraph/Partitioning/CoordinatedRecord.hpp 73.80% <ø> (ø)
... and 45 more

@sbaldu sbaldu requested review from sbaldu and ZigRazor and removed request for sbaldu September 27, 2023 20:43
@ZigRazor
Copy link
Owner

Since we need to release a new Major due to PR #342, I think we can approve this. What do you think @nrkramer @sbaldu ?

@sbaldu
Copy link
Collaborator

sbaldu commented Sep 28, 2023

Since we need to release a new Major due to PR #342, I think we can approve this. What do you think @nrkramer @sbaldu ?

I agree. It seems like a very useful change.

@ZigRazor ZigRazor merged commit 31ac919 into ZigRazor:master Sep 28, 2023
26 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core something about core repo something about repo test Something about test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants