Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaimergp committed Nov 26, 2024
1 parent 2ccbc87 commit 25c4f5d
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
21 changes: 20 additions & 1 deletion docs/source/concepts/generating-index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,26 @@ Parts of a channel
"version": "0.1.0"
},
...
},
"packages.conda": {
"super-fun-package-0.2.0-py310_0.conda": {
"build": "py37_0",
"build_number": 0,
"depends": [
"some-depends"
],
"license": "BSD",
"md5": "a75683f8d9f5b58c19a8ec5d0b7f796e",
"name": "super-fun-package",
"sha256": "e39029d601b9f493ea05c37a2630a9fe5810f1fe3c3f4250e51886838e8e0287",
"size": 4125,
"subdir": "win-64",
"timestamp": 1530731987654,
"version": "0.2.0"
},
...
}
}
How an index is generated
-------------------------
Expand Down Expand Up @@ -218,7 +237,7 @@ already extracted can save a lot of time in fully re-creating the index, should
that be necessary.
An aside: one design goal of the ``.conda`` package format was to make indexing as
fast as possible. To achieve this, the .conda format separates metadata from the
fast as possible. To achieve this, the ``.conda`` format separates metadata from the
actual package contents. Where the old ``.tar.bz2`` container required extracting
the entire package to obtain the metadata, the new package format allows
extraction of metadata without touching the package contents. This allows
Expand Down
4 changes: 2 additions & 2 deletions docs/source/concepts/package-naming-conv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ The following figure compares a canonical name to a filename:
|
Conda supports both ``.conda`` and ``.tar.bz2`` package extensions. The ``.conda``
format is generally smaller and more efficient than ``.tar.bz2`` packages.
Read our `blog post`_ about it to learn more.
format (default since 25.1) is generally smaller and more efficient than ``.tar.bz2``
packages. Read our `blog post`_ about it to learn more.

The build string is created as the package is built. Things that
contribute to it are the variants specified either by the command
Expand Down
4 changes: 2 additions & 2 deletions docs/source/resources/package-spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ There are currently two formats of archives that are supported:
- **Description**

* - .tar.bz2
- The original format of conda packages. Is the default output of conda-build.
- The original format of conda packages.
* - .conda
- 2nd Gen. This is a more compact and thus faster. Can be outputed from conda-build by setting output in ``.condarc`` file.
- 2nd Gen. This is a more compact and thus faster. Default since 25.1.

The formats are identical across platforms and operating systems.
During the install process, all files are extracted into the
Expand Down

0 comments on commit 25c4f5d

Please sign in to comment.