► |  | Package Management in Racket

1 | Getting Started with Packages
2 | Package Concepts
3 | Using raco pkg
4 | Package Metadata
5 | Source, Binary, and Built Packages
6 | Developing Packages with Git
7 | Package APIs
8 | Package Catalog Protocol
9 | PLane T Compatibility
10 | FAQ
11 | Future Plans
12 | How Package Installation and Distribution Works

▼ | 7 | Package APIs

7.1 | Functions for raco pkg
7.2 | Package Management Functions
7.3 | Package Paths and Database
7.4 | Package Source Parsing
7.5 | Package Catalog Database
7.6 | Package Directories Catalog
7.7 | Package Management Environment Variables

On this page:

create-dirs-catalog

7.2
top ← prev up next →

#### 7.6`` Package Directories Catalog

(require pkg/dirs-catalog) | package: base

The pkg/dirs-catalog module provides create-dirs-catalog, which generates a package catalog (as a directory) that refers to a set of packages that are found in a given set of directories. Packages are discovered in the given directory as subdirectories that have an "info.rkt" file.

For example, the main Racket development repository includes a "pkgs" directory that holds packages such as base, and create-dirs-catalog constructs a catalog to be used to install those packages.

When run directly as a program, pkg/dirs-catalog expects a destination catalog followed by any number paths for directories that hold packages:

racket -l- pkg/dirs-catalog ‹dest-catalog› ‹dir› ...

The --immediate, --link, --merge, --check-metadata, and --quiet flags correspond to optional keyword arguments of create-dirs-catalog.

Added in version 6.1.1.6 of package base.
Changed in version 6.90.0.4: Added --immediate.

> > procedure

> > (create-dirs-catalog |  | catalog-path |  |  |  |
> > |  | dirs |  |  |  |
> > | [ | #:immediate? immediate? |  |  |  |
> > |  | #:link? link? |  |  |  |
> > |  | #:merge? merge? |  |  |  |
> > |  | #:check-metadata? check-metadata? |  |  |  |
> > |  | #:status-printf status-printf]) |  | → |  | void?

> catalog-path : path-string?
> dirs : (listof path-string?)
> immediate? : any/c = #f
> link? : any/c = #f
> merge? : any/c = #f
> check-metadata? : any/c = #f
> status-printf : (string? any/c ... -> void?) = void

Creates or modifies catalog-path as a directory that works as a catalog (see Package Catalog Protocol) to list the packages that are contained in each directory specified by dirs. Packages are discovered in dirs as subdirectories that have an "info.rkt" file; if immediate? is true, then each directory is dirs is checked for an immediate "info.rkt" file before checking subdirectories.

If link? is true, then the catalog specifies that the package should be installed as a directory link, as opposed to copies.

If merge? is true, then existing catalog entries in catalog-path are preserved, otherwise old catalog entries are removed.

To create author and description information for each package in the catalog, create-dirs-catalog looks for a pkg-authors and pkg-desc definition in each package’s "info.rkt" file. If either definition is missing and check-metadata? is true, an error is reported.

Changed in version 6.90.0.4 of package base: Added the #:immediate argument.

top ← prev up next →