Mercurial > hg > xemacs-beta

comparison man/lispref/packaging.texi @ 759:7b0e9f17fcf0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2002-02-28 03:55:16 by stephent] apostrophe fix <87r8n6jm86.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Thu, 28 Feb 2002 03:55:43 +0000
parents 5d60b99c1ded
children c35d5f033651
comparison
equal deleted inserted replaced
758:760db937b9ee 759:7b0e9f17fcf0
95 structure and utilities to the library maintainer to make these tasks 95 structure and utilities to the library maintainer to make these tasks
96 easier. This manual documents the requirements and the tools that the 96 easier. This manual documents the requirements and the tools that the
97 @xpms{} provides to ensure that a package satisfies them. 97 @xpms{} provides to ensure that a package satisfies them.
98 98
99 @menu 99 @menu
100 * The User's View:: 100 * The User View::
101 * The Library Maintainer's View:: 101 * The Library Maintainer View::
102 * The Package Release Engineer's View:: 102 * The Package Release Engineer View::
103 @end menu 103 @end menu
104 104
105 105
106 @node The User's View, The Library Maintainer's View, , Package Overview 106 @node The User View, The Library Maintainer View, , Package Overview
107 @section The User's View 107 @section The User View
108 108
109 @strong{N.B.} Much of the discussion in this section undoubtedly 109 @strong{N.B.} Much of the discussion in this section undoubtedly
110 belongs elsewhere, @ref{Packages,,,xemacs}. 110 belongs elsewhere, @ref{Packages,,,xemacs}.
111 111
112 From the user's point of view, an XEmacs binary package is simply a 112 From the user's point of view, an XEmacs binary package is simply a
237 different rules from those used for packaged Lisp. It is probably 237 different rules from those used for packaged Lisp. It is probably
238 easiest to think of the package hierarchy searching algorithm as 238 easiest to think of the package hierarchy searching algorithm as
239 receiving a @code{load-path} initialized to the core Lisp directories. 239 receiving a @code{load-path} initialized to the core Lisp directories.
240 240
241 241
242 @node The Library Maintainer's View, The Package Release Engineer's View, The User's View, Package Overview 242 @node The Library Maintainer View, The Package Release Engineer View, The User View, Package Overview
243 @section The Library Maintainer's View 243 @section The Library Maintainer View
244 244
245 From the library maintainer's viewpoint, the advantages to the @xpms{} 245 From the library maintainer's viewpoint, the advantages to the @xpms{}
246 stem from the convenience to the user of installation and upgrade. 246 stem from the convenience to the user of installation and upgrade.
247 Since an installed package automatically registers its entry points via 247 Since an installed package automatically registers its entry points via
248 autoload and its configuration variables with the Customize system, 248 autoload and its configuration variables with the Customize system,
270 * Infrastructure:: Global Makefiles and common rules. 270 * Infrastructure:: Global Makefiles and common rules.
271 * Control Files:: Package-specific Makefiles and administrative files. 271 * Control Files:: Package-specific Makefiles and administrative files.
272 * Obtaining:: Obtaining the @xpms{} and required utilities. 272 * Obtaining:: Obtaining the @xpms{} and required utilities.
273 @end menu 273 @end menu
274 274
275 @node Infrastructure, Control Files, , The Library Maintainer's View 275 @node Infrastructure, Control Files, , The Library Maintainer View
276 @subsection Infrastructure 276 @subsection Infrastructure
277 277
278 In order to get the greatest benefit from the @xpms{}, a library 278 In order to get the greatest benefit from the @xpms{}, a library
279 maintainer should place the package sources in an appropriate place in 279 maintainer should place the package sources in an appropriate place in
280 the XEmacs source package hierarchy, and arrange to have the source 280 the XEmacs source package hierarchy, and arrange to have the source
353 when first preparing the source environment. The necessary 353 when first preparing the source environment. The necessary
354 modifications to @file{package-compile.el} need to be done for each 354 modifications to @file{package-compile.el} need to be done for each
355 package and are discussed in the next section, @ref{Control Files}. 355 package and are discussed in the next section, @ref{Control Files}.
356 356
357 357
358 @node Control Files, Obtaining, Infrastructure, The Library Maintainer's View 358 @node Control Files, Obtaining, Infrastructure, The Library Maintainer View
359 @subsection Control Files 359 @subsection Control Files
360 360
361 Each package source must contain a number of control files in the 361 Each package source must contain a number of control files in the
362 top-level directory. These files in general can be created and then 362 top-level directory. These files in general can be created and then
363 ignored, except for a few variables that need to be updated when new 363 ignored, except for a few variables that need to be updated when new
403 subsystem how to find the defcustom forms needed to create Customization 403 subsystem how to find the defcustom forms needed to create Customization
404 forms for the usre configuration variables of the package. 404 forms for the usre configuration variables of the package.
405 @end table 405 @end table
406 406
407 407
408 @node Obtaining, , Control Files, The Library Maintainer's View 408 @node Obtaining, , Control Files, The Library Maintainer View
409 @subsection Obtaining the @xpms{} and Required Utilities 409 @subsection Obtaining the @xpms{} and Required Utilities
410 410
411 Currently both the infrastructure for creating XEmacs packages and the 411 Currently both the infrastructure for creating XEmacs packages and the
412 package sources themselves are available only by CVS. See 412 package sources themselves are available only by CVS. See
413 @uref{http://www.xemacs.org/Develop/cvsaccess.html} for more 413 @uref{http://www.xemacs.org/Develop/cvsaccess.html} for more
415 415
416 The @xpms{} currently requires GNU @file{make}, and probably XEmacs, to 416 The @xpms{} currently requires GNU @file{make}, and probably XEmacs, to
417 build packages. 417 build packages.
418 418
419 419
420 @node The Package Release Engineer's View, , The Library Maintainer's View, Package Overview 420 @node The Package Release Engineer View, , The Library Maintainer View, Package Overview
421 @subsection The Package Release Engineer's View 421 @subsection The Package Release Engineer View
422 422
423 The XEmacs Package Release Engineer is responsible for keeping the 423 The XEmacs Package Release Engineer is responsible for keeping the
424 system coherent. The changes to @file{packages/package-compile.el} and 424 system coherent. The changes to @file{packages/package-compile.el} and
425 @file{packages/xemacs-packages/Makefile} required to make the package 425 @file{packages/xemacs-packages/Makefile} required to make the package
426 available to others, and for building SUMO tarballs, @emph{etc}, are 426 available to others, and for building SUMO tarballs, @emph{etc}, are