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

packaging_guide.rst: explain forward and backward compat before the less common cases #47402

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

haampie
Copy link
Member

@haampie haampie commented Nov 4, 2024

The idea is to go from most to least used: backward compat -> forward compat -> pinning on major or major.minor version -> pinning specific, concrete versions.

Further, imo the following

   # backward compatibility with Python
   depends_on("[email protected]:")
   depends_on("[email protected]:", when="@1.2:")
   depends_on("[email protected]:", when="@1.4:")

   # forward compatibility with Python
   depends_on("python@:3.12", when="@:1.10")
   depends_on("python@:3.13", when="@:1.12")
   depends_on("python@:3.14")

is better than disjoint when ranges causing repetition of the rules on dependencies, and requiring frequent editing of existing lines after new releases are done:

   depends_on("[email protected]:3.12", when="@:1.1")
   depends_on("[email protected]:3.12", when="@1.2:1.3")
   depends_on("[email protected]:3.12", when="@1.4:1.10")
   depends_on("[email protected]:3.13", when="@1.11:1.12")
   depends_on("[email protected]:3.14", when="@1.13:")

@spackbot-app spackbot-app bot added core PR affects Spack core functionality dependencies documentation Improvements or additions to documentation labels Nov 4, 2024
@haampie haampie force-pushed the hs/docs/forward-backward-bounds branch 2 times, most recently from 583a7be to 924255f Compare November 4, 2024 11:49
@haampie haampie added the v0.22.3 PRs to backport for v0.22.3 label Nov 4, 2024
@haampie haampie force-pushed the hs/docs/forward-backward-bounds branch from 924255f to 6ff6859 Compare November 4, 2024 11:52
Copy link
Member

@alalazo alalazo left a comment

Choose a reason for hiding this comment

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

LGTM, apart one minor comment.

@haampie
Copy link
Member Author

haampie commented Nov 4, 2024

Supersedes the old PR #35002.

@haampie haampie added this to the v0.23 milestone Nov 4, 2024
@haampie haampie merged commit 8d0856d into develop Nov 4, 2024
30 of 31 checks passed
@haampie haampie deleted the hs/docs/forward-backward-bounds branch November 4, 2024 12:52
haampie added a commit that referenced this pull request Nov 5, 2024
…ess common cases (#47402)

The idea is to go from most to least used: backward compat -> forward compat -> pinning on major or major.minor version -> pinning specific, concrete versions.

Further, the following

```python
   # backward compatibility with Python
   depends_on("[email protected]:")
   depends_on("[email protected]:", when="@1.2:")
   depends_on("[email protected]:", when="@1.4:")

   # forward compatibility with Python
   depends_on("python@:3.12", when="@:1.10")
   depends_on("python@:3.13", when="@:1.12")
   depends_on("python@:3.14")
```

is better than disjoint when ranges causing repetition of the rules on dependencies, and requiring frequent editing of existing lines after new releases are done:

```python
   depends_on("[email protected]:3.12", when="@:1.1")
   depends_on("[email protected]:3.12", when="@1.2:1.3")
   depends_on("[email protected]:3.12", when="@1.4:1.10")
   depends_on("[email protected]:3.13", when="@1.11:1.12")
   depends_on("[email protected]:3.14", when="@1.13:")
haampie added a commit that referenced this pull request Nov 18, 2024
…ess common cases (#47402)

The idea is to go from most to least used: backward compat -> forward compat -> pinning on major or major.minor version -> pinning specific, concrete versions.

Further, the following

```python
   # backward compatibility with Python
   depends_on("[email protected]:")
   depends_on("[email protected]:", when="@1.2:")
   depends_on("[email protected]:", when="@1.4:")

   # forward compatibility with Python
   depends_on("python@:3.12", when="@:1.10")
   depends_on("python@:3.13", when="@:1.12")
   depends_on("python@:3.14")
```

is better than disjoint when ranges causing repetition of the rules on dependencies, and requiring frequent editing of existing lines after new releases are done:

```python
   depends_on("[email protected]:3.12", when="@:1.1")
   depends_on("[email protected]:3.12", when="@1.2:1.3")
   depends_on("[email protected]:3.12", when="@1.4:1.10")
   depends_on("[email protected]:3.13", when="@1.11:1.12")
   depends_on("[email protected]:3.14", when="@1.13:")
haampie added a commit that referenced this pull request Nov 18, 2024
…ess common cases (#47402)

The idea is to go from most to least used: backward compat -> forward compat -> pinning on major or major.minor version -> pinning specific, concrete versions.

Further, the following

```python
   # backward compatibility with Python
   depends_on("[email protected]:")
   depends_on("[email protected]:", when="@1.2:")
   depends_on("[email protected]:", when="@1.4:")

   # forward compatibility with Python
   depends_on("python@:3.12", when="@:1.10")
   depends_on("python@:3.13", when="@:1.12")
   depends_on("python@:3.14")
```

is better than disjoint when ranges causing repetition of the rules on dependencies, and requiring frequent editing of existing lines after new releases are done:

```python
   depends_on("[email protected]:3.12", when="@:1.1")
   depends_on("[email protected]:3.12", when="@1.2:1.3")
   depends_on("[email protected]:3.12", when="@1.4:1.10")
   depends_on("[email protected]:3.13", when="@1.11:1.12")
   depends_on("[email protected]:3.14", when="@1.13:")
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core PR affects Spack core functionality dependencies documentation Improvements or additions to documentation v0.22.3 PRs to backport for v0.22.3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants