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

Should the repository names be named after the full project name? E.g. beman.exemplar instead of exemplar #87

Closed
camio opened this issue Dec 2, 2024 · 10 comments
Assignees
Labels
Beman Leads question Further information is requested

Comments

@camio
Copy link
Member

camio commented Dec 2, 2024

The repository name is one of only places where we don't use the full project name when we're not otherwise forced to use something else.

One benefit is that a checkout of the repository is less likely to clash with another repository checkout in the same enclosing directory. I typically have several Open Source repositories checked out in a single folder, but for beman projects I create a bemanproject/ subfolder.

Another benefit is it is much clearer that the checkout is a beman project.

@camio camio added the question Further information is requested label Dec 2, 2024
@wusatosi
Copy link
Member

wusatosi commented Dec 3, 2024

I think this is extra noise. I think the checkout directory would be the only benefit of this.
Which would be easily mitigated on the user side, e.g. git clone github.com/bemanproject/exemplar.git beman-exemplar.

I can see how this would be beneficial for mega repos (e.g. llvm/llvm-project), but I don't think this make sense for us. Current GitHub repos are clear enough.

@neatudarius
Copy link
Member

The repository name is one of only places where we don't use the full project name when we're not otherwise forced to use something else.

One benefit is that a checkout of the repository is less likely to clash with another repository checkout in the same enclosing directory. I typically have several Open Source repositories checked out in a single folder, but for beman projects I create a bemanproject/ subfolder.

Another benefit is it is much clearer that the checkout is a beman project.
I was thinking about the same thing when we started Beman and I didn't propose that because we'll end up having something like https://github.com/bemanproject/beman.examplar - duplication.

Now I'm strongly in favor to rename all repos to use beman.$short_name. It will actually help new users.

@ClausKlein
Copy link

How do you plan a super build?

With git submodules like boost?

@wusatosi
Copy link
Member

wusatosi commented Dec 4, 2024

I don't think this should be a exemplar question.
We should prob post this on discourse

@neatudarius
Copy link
Member

neatudarius commented Dec 5, 2024

How do you plan a super build?

With git submodules like boost?

We don't plan to use submodules, we previously discussed and removed all submodules from our org. Probably, cmake fetch content is our status quo - I need to check the minutes from previous sync meetings.

I don't think this should be a exemplar question.
We should prob post this on discourse

Agree, we can keep it for next time. I won't duplicate the thread right now.

@wusatosi
Copy link
Member

wusatosi commented Dec 5, 2024

I think we should move this to discourse/ beman repo.

This is a suggestion that impacts all repos, and the thread is not too big yet. exemplar do not get enough attention and we risk having a dangling issue here.

git submodule

Can we have this codified in a documentation under beman repo?

@neatudarius
Copy link
Member

git submodule

Can we have this codified in a documentation under beman repo?

Added to agenda for next Monday.

@neatudarius
Copy link
Member

git submodule

Can we have this codified in a documentation under beman repo?

Added to agenda for next Monday.

Will be solved in bemanproject/beman#75

@bretbrownjr
Copy link
Contributor

How do you plan a super build?

@ClausKlein Right now, FetchContent is the trivially supportable option.

I would like to see someone (me if I have time) provide sufficiently mature Beman libraries via Conan and vcpkg one way or another at some point. I wouldn't oppose anyone that wanted to add support for other package managers as well: Arch AUR, nix, etc.

That being said, I would hate to see anything intrusive in each of the Beman projects to support all of that. I would expect that using well-constructed CMake would be sufficiently portable to support any of the above. If not, let's make bug reports and update our tooling and standards accordingly.

@neatudarius
Copy link
Member

Today we decided to reject this proposal at 2025-01-20 Beman Weekly sync. It was discussed and we took a final decision.

FYI @bemanproject/leads

@neatudarius neatudarius self-assigned this Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beman Leads question Further information is requested
Projects
None yet
Development

No branches or pull requests

5 participants