Mercurial > hg > xemacs-beta

comparison man/lispref/packaging.texi @ 752:5d60b99c1ded

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2002-02-13 13:06:44 by stephent] documenting packages <874rkl1qj8.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Wed, 13 Feb 2002 13:06:53 +0000
parents 9cea8fcd2e61
children 7b0e9f17fcf0
comparison
equal deleted inserted replaced
751:358bd84dc7ff 752:5d60b99c1ded
49 Packaging Lisp Libraries: 49 Packaging Lisp Libraries:
50 * Package Terminology:: Basic stuff. 50 * Package Terminology:: Basic stuff.
51 * Building Packages:: Turn packaged source into a tarball. 51 * Building Packages:: Turn packaged source into a tarball.
52 * Local.rules File:: Tell the @xpms{} about your host. 52 * Local.rules File:: Tell the @xpms{} about your host.
53 * Creating Packages:: Tell the @xpms{} about your package. 53 * Creating Packages:: Tell the @xpms{} about your package.
54 * Documenting Packages:: Explain your package to users and hackers.
54 @c * History:: History of the @xpms{} 55 @c * History:: History of the @xpms{}
55 @c * Installation:: Installing the @xpms{} with your (X)Emacs. 56 @c * Installation:: Installing the @xpms{} with your (X)Emacs.
56 @c * Configuration:: Configuring the @xpms{} for use. 57 @c * Configuration:: Configuring the @xpms{} for use.
57 @c * Usage:: An overview of the operation of the @xpms{}. 58 @c * Usage:: An overview of the operation of the @xpms{}.
58 @c * Bug Reports:: Reporting Bugs and Problems 59 @c * Bug Reports:: Reporting Bugs and Problems
719 @end table 720 @end table
720 721
721 722
722 @c #### The following section is lifted verbatim from the XEmacs User's 723 @c #### The following section is lifted verbatim from the XEmacs User's
723 @c Manual, file packages.texi. 724 @c Manual, file packages.texi.
724 @node Creating Packages, Issues, Local.rules File, Packaging 725 @node Creating Packages, Documenting Packages, Local.rules File, Packaging
725 @comment node-name, next, previous, up 726 @comment node-name, next, previous, up
726 @cindex creating packages 727 @cindex creating packages
727 @heading Creating Packages: 728 @heading Creating Packages:
728 Creating a package from an existing Lisp library is not very difficult. 729 Creating a package from an existing Lisp library is not very difficult.
729 730
1172 1173
1173 @item DATA_FILES 1174 @item DATA_FILES
1174 Any data files, such as pixmaps, READMEs, and ChangeLogs. These must be 1175 Any data files, such as pixmaps, READMEs, and ChangeLogs. These must be
1175 paths relative to the root of the package's source tree. These files 1176 paths relative to the root of the package's source tree. These files
1176 will be copied to @samp{$(DATA_DEST)} for installation. Any directory 1177 will be copied to @samp{$(DATA_DEST)} for installation. Any directory
1177 component component of the path for a file will be stripped, so that the 1178 component of the path for a file will be stripped, so that the
1178 file ends up in @samp{$(DATA_DEST)}, not in a subdiredtory. If there are 1179 file ends up in @samp{$(DATA_DEST)}, not in a subdiredtory. If there are
1179 several destination directories, the forms @samp{$(DATA_FILES_@var{n})} 1180 several destination directories, the forms @samp{$(DATA_FILES_@var{n})}
1180 and @samp{$(DATA_DEST_@var{n})} (@var{n} may take values in 1-40) must 1181 and @samp{$(DATA_DEST_@var{n})} (@var{n} may take values in 1-40) must
1181 be used. The @xpms{} doesn't make provision for copying trees at this 1182 be used. The @xpms{} doesn't make provision for copying trees at this
1182 time. 1183 time.
1275 and are normally installed in @file{etc/@var{PACKAGE_NAME}}. A few 1276 and are normally installed in @file{etc/@var{PACKAGE_NAME}}. A few
1276 packages have needs beyond the basic templates. See @file{XEmacs.rules} 1277 packages have needs beyond the basic templates. See @file{XEmacs.rules}
1277 or a future revision of this manual for details. 1278 or a future revision of this manual for details.
1278 1279
1279 1280
1280 @node Issues, , Creating Packages, Packaging 1281 @node Documenting Packages, Issues, Creating Packages, Packaging
1282 @comment node-name, next, previous, up
1283 @cindex documenting packages
1284 @heading Documenting Packages:
1285
1286 @c #### Add a documentation section to Internals, and xref here.
1287 Some random notes on documenting your package.
1288
1289 Do write a Texinfo file. It's not that hard to do basically, and even
1290 using the more advanced features of Texinfo soon become natural. For a
1291 start, just grab the template @file{Samples/package.texi} from the
1292 @xpms{} source tree, and drop your current README into the Top node. At
1293 least this way your documentation will be accessible from the standard
1294 Info readers. Next, try to add lots of cross-referencing and logical
1295 markup, and then node structure.
1296
1297 Address both end users and developer issues. You may not be the
1298 maintainer forever.
1299
1300 If you are maintaining a package that is part of the GNU Emacs
1301 distribution, you'll likely find that you occasionally synchronize your
1302 package with the GNU Emacs sources. When you synch a file,
1303 conventionally you should place a comment just above the standard
1304 @code{;;; Code} comment that looks like this:
1305
1306 @example
1307 ;; Synched with:
1308 ;; GNU Emacs 21.1, 2002-02-08, Stephen Turnbull <stephen@@xemacs.org>
1309 @end example
1310
1311 This comment is a status flag; the ChangeLog doesn't really give the
1312 same information.
1313
1314 Do maintain a detailed ChangeLog.
1315
1316 @node Issues, , Documenting Packages, Packaging
1281 @section Issues 1317 @section Issues
1282 1318
1283 To be completed. 1319 To be completed.
1284 1320