The petit.package-utils Reference Manual

Table of Contents

The petit.package-utils Reference Manual

This is the petit.package-utils Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:39:03 2020 GMT+0.

1 Introduction

petit.package-utils

Petit tool box about packaging.

Package name and its nicknames:

[package name] PETIT.PACKAGE-UTILS

[package nicknames] PPU and PETIT.PU

APIs:

[Function] USE-CONFLICT-PACKAGE:

An alternative CL:USE-PACKAGE function. USE-CONFLICT-PACKAGE enables USE-PACKAGE'ing any packages which have conflicted external symbols.

e.g.

(defpackage :foo
  (:shadow #:car)
  (:use :cl)
  (:export :car) )
(in-package :foo)
(defun car (obj) ...)

(in-package :cl-user)
(ppu:use-conflict-package :foo)
(symbol-package 'car) ; => #<PACKAGE FOO>

You can also specify to-package for USE-CONFLICT-PACKAGE optionally.

e.g. (ppu:use-conflict-package from-package to-package)

[Function] PACKAGE-SHORTEST-NAME:

Returns shortest name or nickname of given package designator.

e.g. (ppu:package-shortest-name :common-lisp-user) ; => "USER"

Note: for GNU CLISP, PPU:PACKAGE-SHORTEST-NAME is just a synonym of EXT:PACKAGE-SHORTEST-NAME.

License:

Under MIT license.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 petit.package-utils

Maintainer

SUZUKI Shingo

Author

SUZUKI Shingo

License

MIT

Description

petit toolbox for packaging

Version

0.1.0

Source

petit.package-utils.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 petit.package-utils/src

Parent

petit.package-utils (system)

Location

src/

Components

• packages.lisp (file)
• package-utils.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 petit.package-utils.asd

Location

petit.package-utils.asd

Systems

petit.package-utils (system)

Packages

petit.package-utils-asd

4.1.2 petit.package-utils/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

petit.package-utils

4.1.3 petit.package-utils/src/package-utils.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/package-utils.lisp

Exported Definitions

• package-shortest-name (function)
• use-conflict-package (function)

5 Packages

Packages are listed by definition order.

5.1 petit.package-utils-asd

Source

petit.package-utils.asd

Use List

• asdf/interface
• common-lisp

5.2 petit.package-utils

Source

packages.lisp (file)

Nicknames

• ppu
• petit.pu

Use List

common-lisp

Exported Definitions

• package-shortest-name (function)
• use-conflict-package (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Functions

Function: package-shortest-name ()

Package

petit.package-utils

Source

package-utils.lisp (file)

Function: use-conflict-package FROM-PACKAGE &optional TO-PACKAGE

Package

petit.package-utils

Source

package-utils.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types