From 25c4f5dc17f752fe83e8270759d345a27b85e158 Mon Sep 17 00:00:00 2001 From: jaimergp Date: Tue, 26 Nov 2024 16:24:52 +0100 Subject: [PATCH] update docs --- docs/source/concepts/generating-index.rst | 21 +++++++++++++++++++- docs/source/concepts/package-naming-conv.rst | 4 ++-- docs/source/resources/package-spec.rst | 4 ++-- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/source/concepts/generating-index.rst b/docs/source/concepts/generating-index.rst index b512d9c7e5..4fbefd9ec7 100644 --- a/docs/source/concepts/generating-index.rst +++ b/docs/source/concepts/generating-index.rst @@ -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 ------------------------- @@ -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 diff --git a/docs/source/concepts/package-naming-conv.rst b/docs/source/concepts/package-naming-conv.rst index 5d3f20f538..12ddcfc6e5 100644 --- a/docs/source/concepts/package-naming-conv.rst +++ b/docs/source/concepts/package-naming-conv.rst @@ -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 diff --git a/docs/source/resources/package-spec.rst b/docs/source/resources/package-spec.rst index 90c09289aa..57326096d1 100644 --- a/docs/source/resources/package-spec.rst +++ b/docs/source/resources/package-spec.rst @@ -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