Skip to content

Commit fac78b6

Browse files
committed
Add policies reference section and license document
1 parent c76779f commit fac78b6

5 files changed

Lines changed: 85 additions & 2 deletions

File tree

docs/reference/policies/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Policies
2+
3+
- [Versioning](./versioning.md)
4+
- [Platform support](./platforms.md)
5+
- [Licensing](./license.md)

docs/reference/policies/license.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# License
2+
3+
uv is licensed under either of
4+
5+
- Apache License, Version 2.0
6+
7+
[LICENSE-APACHE](https://github.com/astral-sh/uv/blob/main/LICENSE-APACHE) or
8+
<https://www.apache.org/licenses/LICENSE-2.0>
9+
10+
- MIT License
11+
12+
[LICENSE-MIT](https://github.com/astral-sh/uv/blob/main/LICENSE-MIT) or
13+
<https://opensource.org/licenses/MIT>
14+
15+
at your option.
16+
17+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in uv
18+
by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any
19+
additional terms or conditions.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Platform support
2+
3+
uv has Tier 1 support for the following platforms:
4+
5+
- macOS (Apple Silicon)
6+
- macOS (x86_64)
7+
- Linux (x86_64)
8+
- Windows (x86_64)
9+
10+
uv is continuously built, tested, and developed against its Tier 1 platforms. Inspired by the Rust
11+
project, Tier 1 can be thought of as
12+
["guaranteed to work"](https://doc.rust-lang.org/beta/rustc/platform-support.html).
13+
14+
uv has Tier 2 support
15+
(["guaranteed to build"](https://doc.rust-lang.org/beta/rustc/platform-support.html)) for the
16+
following platforms:
17+
18+
- Linux (PPC64)
19+
- Linux (PPC64LE)
20+
- Linux (aarch64)
21+
- Linux (armv7)
22+
- Linux (i686)
23+
- Linux (s390x)
24+
25+
uv ships pre-built wheels to [PyPI](https://pypi.org/project/uv/) for its Tier 1 and Tier 2
26+
platforms. However, while Tier 2 platforms are continuously built, they are not continuously tested
27+
or developed against, and so stability may vary in practice.
28+
29+
Beyond the Tier 1 and Tier 2 platforms, uv is known to build on i686 Windows, and known _not_ to
30+
build on aarch64 Windows, but does not consider either platform to be supported at this time. The
31+
minimum supported Windows versions are Windows 10 and Windows Server 2016, following
32+
[Rust's own Tier 1 support](https://blog.rust-lang.org/2024/02/26/Windows-7.html).
33+
34+
uv supports and is tested against Python 3.8, 3.9, 3.10, 3.11, 3.12, and 3.13.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Versioning
2+
3+
uv uses a custom versioning scheme in which the minor version number is bumped for breaking changes,
4+
and the patch version number is bumped for bug fixes, enhancements, and other non-breaking changes.
5+
6+
uv does not yet have a stable API; once uv's API is stable (v1.0.0), the versioning scheme will
7+
adhere to [Semantic Versioning](https://semver.org/).
8+
9+
uv's changelog can be [viewed on GitHub](https://github.com/astral-sh/uv/blob/main/CHANGELOG.md).
10+
11+
## Cache versioning
12+
13+
Cache versions are considered internal to uv, and so may be changed in a minor or patch release. See
14+
[Cache versioning](../../concepts/cache.md#cache-versioning) for more.
15+
16+
## Lockfile versioning
17+
18+
The `uv.lock` schema version is considered part of the public API, and so will only be incremented
19+
in a minor release as a breaking change. See
20+
[Lockfile versioning](../../concepts/resolution.md#lockfile-versioning) for more.

mkdocs.template.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ plugins:
6868
redirect_maps:
6969
"concepts/workspaces.md": "concepts/projects/workspaces.md"
7070
"concepts/dependencies.md": "concepts/projects/dependencies.md"
71+
"reference/versioning.md": "reference/policies/versioning.md"
72+
"reference/platforms.md": "reference/policies/platforms.md"
7173
extra_css:
7274
- stylesheets/extra.css
7375
extra_javascript:
@@ -149,8 +151,11 @@ nav:
149151
- Resolver: reference/resolver-internals.md
150152
- Dependency specifiers: reference/dependency-specifiers.md
151153
- Benchmarks: reference/benchmarks.md
152-
- Versioning: reference/versioning.md
153-
- Platform support: reference/platforms.md
154+
- Policies:
155+
- reference/policies/index.md
156+
- Versioning: reference/policies/versioning.md
157+
- Platform support: reference/policies/platforms.md
158+
- License: reference/policies/license.md
154159
validation:
155160
omitted_files: warn
156161
absolute_links: warn

0 commit comments

Comments
 (0)