Skip to content

Commit a51c798

Browse files
committed
Add policies reference section and license document
1 parent 68e3228 commit a51c798

7 files changed

Lines changed: 37 additions & 9 deletions

File tree

docs/concepts/resolution.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,6 @@ update was backwards-compatible. However, this is not guaranteed, and uv may exi
417417
it encounters a lockfile with an outdated schema version.
418418

419419
The schema version is considered part of the public API, and so is only bumped in minor releases, as
420-
a breaking change (see [Versioning](../reference/versioning.md)). As such, all uv patch versions
421-
within a given minor uv release are guaranteed to have full lockfile compatibility. In other words,
422-
lockfiles may only be rejected across minor releases.
420+
a breaking change (see [Versioning](../reference/policies/versioning.md)). As such, all uv patch
421+
versions within a given minor uv release are guaranteed to have full lockfile compatibility. In
422+
other words, lockfiles may only be rejected across minor releases.

docs/reference/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ The reference section provides information about specific parts of uv:
55
- [Commands](./cli.md): A reference for uv's command line interface.
66
- [Settings](./settings.md): A reference for uv's configuration schema.
77
- [Resolver](./resolver-internals.md): Details about the internals of uv's resolver.
8-
- [Versioning](./versioning.md): uv's versioning policy.
9-
- [Platform support](./platforms.md): uv's supported operating systems and architectures.
8+
- [Policies](./policies/index.md): uv's versioning policy, platform support policy, and license.
109

1110
Looking for a broader overview? Check out the [concepts](../concepts/index.md) documentation.

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+
- [License](./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.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ uv's changelog can be [viewed on GitHub](https://github.com/astral-sh/uv/blob/ma
1111
## Cache versioning
1212

1313
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.
14+
[Cache versioning](../../concepts/cache.md#cache-versioning) for more.
1515

1616
## Lockfile versioning
1717

1818
The `uv.lock` schema version is considered part of the public API, and so will only be incremented
1919
in a minor release as a breaking change. See
20-
[Lockfile versioning](../concepts/resolution.md#lockfile-versioning) for more.
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:
@@ -148,8 +150,11 @@ nav:
148150
- Build Failures: reference/build_failures.md
149151
- Resolver: reference/resolver-internals.md
150152
- Benchmarks: reference/benchmarks.md
151-
- Versioning: reference/versioning.md
152-
- Platform support: reference/platforms.md
153+
- Policies:
154+
- reference/policies/index.md
155+
- Versioning: reference/policies/versioning.md
156+
- Platform support: reference/policies/platforms.md
157+
- License: reference/policies/license.md
153158
validation:
154159
omitted_files: warn
155160
absolute_links: warn

0 commit comments

Comments
 (0)