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

clarification to CONTRIBUTING doc #47

Open
uvtc opened this issue May 31, 2022 · 3 comments
Open

clarification to CONTRIBUTING doc #47

uvtc opened this issue May 31, 2022 · 3 comments

Comments

@uvtc
Copy link
Contributor

uvtc commented May 31, 2022

Two things I think need to be clarified:

  1. Regarding the symbol that goes into pkgs.janet, should it be the same as the :name value in the project's declare-project (in the project's project.janet file)?

  2. The contributing doc says, "One exception is the janet- prefix in the git repository name to avoid name clashes.", but does not explain the meaning. I think what it means to say is, if your git repo name includes the "janet-" prefix, don't include that in the project name. Is that correct?

@uvtc
Copy link
Contributor Author

uvtc commented May 31, 2022

Re. # 1 above, does jpm use the symbol in pkgs.janet for anything other than an alias to the git repo? That is to say, does jpm care if the symbol in pkgs.janet is different from the project's own "project.janet --> declare-project --> :name" value?

@bakpakin
Copy link
Member

bakpakin commented Jun 6, 2022

Yes, the naming is really more about keeping consistency. As far as what jpm uses the names for, yes they are aliases to git repos. They are more important than the :name field in a declare project as far as jpm is concerned.

@uvtc
Copy link
Contributor Author

uvtc commented Jun 6, 2022

So, when jpm is installing a bare package name (not fully-qualified url), it just looks up that bare name in the pkgs.janet and uses it as an alias to the git repo.

But once it does that, it then uses the :name in that project's project.janet --> declare-project to ... is that just used to name the /usr/local/lib/janet subdir name? What does jpm use the :name value for?

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

No branches or pull requests

2 participants