mavam / mavam/libbf

Incorrect header inclusion

Open
#54 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
368
Forks
89
PR merge metrics
No merged PRs in 30d

Description

Hello,

I have some trouble installing libbf. After doing:

./configure
make
make install

libbf is installed here:

> tree /usr/local/include/            
/usr/local/include/
├── bf
│   ├── all.hpp
│   ├── bitvector.hpp
│   ├── bloom_filter
│   │   ├── a2.hpp
│   │   ├── basic.hpp
│   │   ├── bitwise.hpp
│   │   ├── counting.hpp
│   │   └── stable.hpp
│   ├── bloom_filter.hpp
│   ├── counter_vector.hpp
│   ├── h3.hpp
│   ├── hash.hpp
│   ├── object.hpp
│   └── wrap.hpp

I cant find the file bf.h specified in the current readme.
In fact :

#include <bf.h>

int main(){
    bf::bloom_filter* h;
    return 0;
}

does not work, neither do :

#include <bf/bf.h>

int main(){
    bf::bloom_filter* h;
    return 0;
}

However,

#include <bf/all.hpp>

int main(){
    bf::bloom_filter* h;
    return 0;
}

does work, as specified in https://github.com/mavam/libbf/issues/32

1 - Should I open a merge request to update the readme ?

I have to install a project that uses libbf, and that project does:
#include <bf.h>
But it does not specify which version of libbf was used.

2 - Do you know if a previous version of libbf could be installed by including bf.h ? In such case, which version is it ?

I also used libbf in one of my project, and it worked great ! Thank you for your library.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the current README's bf.h examples and compare them with the installed include tree shown in the report; also review issue #32 for the expected include form. Check the repository history to determine whether bf.h existed in an earlier version, then update the README with the supported header and any confirmed version guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.