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

Change the name of the "pkgs" directory to "pkgs2" #946

Merged
merged 2 commits into from
Sep 29, 2021

Conversation

bobeff
Copy link
Contributor

@bobeff bobeff commented Sep 28, 2021

The names of the "nimbledata.json" file and "pkgs" directory are changed correspondingly to "nimbledata2.json" and "pkgs2" in order to avoid the need of removing the Nimble cache when changing between the new and old Nimble versions.

The names of the "nimbledata.json" file and "pkgs" directory are changed
correspondingly to "nimbledata2.json" and "pkgs2" in order to avoid the
need of removing the Nimble cache when changing between the new and old
Nimble versions.

Related to nim-lang#127
In the Nimble packages list exists a package without description field
which causes the tests to fail while executing the "list" command. In
order to resolve the problem make the description field optional.

Related to nim-lang#127
@bobeff bobeff closed this Sep 28, 2021
@bobeff bobeff reopened this Sep 28, 2021
@Araq Araq merged commit c866966 into nim-lang:master Sep 29, 2021
@Araq
Copy link
Member

Araq commented Sep 29, 2021

Thank you!

@bobeff bobeff deleted the pkgs2 branch September 29, 2021 11:36
@pietroppeter
Copy link

I think this change (pkgs -> pkgs2) should be reflected not only by updating the documentation to be correct, but also should be highlighted as a major changing happening in 0.14 (there probably should be a section for changes introduced in 0.14). at the very least it should be mentioned in the changelog.

note also that this PR contains another commit (was it intended to end up here?) where description becomes an optional field instead of required. documentation and changelog should also be updated for this! (see also recent issue #947)

@pietroppeter
Copy link

had a discussion with @Araq on Discord #nimble channel, the rationale for approving making description field optional is:

the problem with "description" is that it's redundant with a readme.md file which is pretty much always there thanks to github
and in the past there were discussions of many things nimble thinks it needs but which are redundant, version info (require git tags), author (part of the git metadata), description (readme.md)
Nimble should be "smart" and simply use what is available and not enforce code duplication. (readme.md is usually up to date and the Nimble description isn't)

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.

None yet

3 participants