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.

Sign up for GitHub

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

Jump to bottom

docs: add manifest field documentation to Project.toml guide in Pkg.jl manual #3694

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add manifest field documentation to Project.toml guide in Pkg.jl manual #3694

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/src/toml-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@ Note that Pkg.jl deviates from the SemVer specification when it comes to version
the section on [pre-1.0 behavior](@ref compat-pre-1.0) for more details.


### The `manifest` field

`manifest` specifies an external manifest file (`Manifest.toml`) for the project. This is particularly useful for managing package dependencies in a more granular or shared manner across multiple projects, for example:
```toml
manifest = "../Manifest.toml"
```

This specified `Manifest.toml` does not need to be a subset of the project's own manifest.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the wording "subset" here is unclear.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm not sure this is correct behavior. I'm somewhat exercising Cunningham's law here to get critique on what is expected.

The project inherits any version constraints or package specifications from the referenced manifest and is integrated into the dependency resolution process.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a compat note I think. I hope this is accurate:

Suggested change
!!! compat "Julia 1.11"
This feature requires at least Julia 1.11. On earlier Julia version, the `manifest` entry in the `Project.toml` file gets ignored.


### The `[deps]` section

All dependencies of the package/project are listed in the `[deps]` section. Each dependency
Expand Down