From 9f8b585a42091bbfcf9c21bfbd0d6b254b4a6d4c Mon Sep 17 00:00:00 2001 From: Chong Yidong Date: Thu, 21 Apr 2011 21:51:51 -0400 Subject: [PATCH] Use archive-contents.el script. Remove archive-contents and readme files from pacakges/ subdir. --- README | 23 +-- admin/archive-contents.el | 2 +- admin/package-update.sh | 7 +- packages/all-readme.txt | 16 -- packages/archive-contents | 28 ---- packages/auctex-readme.txt | 243 ------------------------------- packages/company-readme.txt | 6 - packages/debbugs-readme.txt | 9 -- packages/js2-mode-readme.txt | 36 ----- packages/load-dir-readme.txt | 12 -- packages/muse-readme.txt | 7 - packages/org-readme.txt | 19 --- packages/rainbow-mode-readme.txt | 2 - 13 files changed, 8 insertions(+), 402 deletions(-) delete mode 100644 packages/all-readme.txt delete mode 100644 packages/archive-contents delete mode 100644 packages/auctex-readme.txt delete mode 100644 packages/company-readme.txt delete mode 100644 packages/debbugs-readme.txt delete mode 100644 packages/js2-mode-readme.txt delete mode 100644 packages/load-dir-readme.txt delete mode 100644 packages/muse-readme.txt delete mode 100644 packages/org-readme.txt delete mode 100644 packages/rainbow-mode-readme.txt diff --git a/README b/README index 65a6ae29f..c8a4fd47d 100644 --- a/README +++ b/README @@ -14,7 +14,7 @@ for testing purposes). ** admin/ -- scripts for deploying the package archive. See the DEPLOYMENT section for details. -** html/ -- HTML for the elp.gnu.org website. +** html/ -- HTML for the elpa.gnu.org website. ** packages/ -- source code for the packages. @@ -26,37 +26,16 @@ This directory holds the package sources. Unlike the deployed package archive, multi-file packages are present here as directories, not tar files. So, edits to the sources can be easily managed by Bzr. -*** archive-contents -This file contains a Lisp form recording the hosted package names and -their attributes. Once the archive is deployed, Emacs learns the -archive contents by reading this file (normally via HTTP). - -In the future, we'll remove this file from the repository, and -generate it automatically during deployment. - *** Package sources In the form of *.el files for simple (1-file) packages, or subdirectories for multi-file packages. -*** Readme files -When the archive is deployed, Emacs retrieves the package descriptions -by reading these files (normally via HTTP). - -In the future, we'll remove these files from the repository, and -generate them during deployment. - ** To add a package: *** Add a simple (1-file) package as packages/NAME-VERSION.el. *** Add a multi-file package a directory, packages/NAME-VERSION. -*** Add a readme file, packages/NAME-readme.txt. This should be a -copy of the commentary section for a simple package, or the README -file for a multi-file package. - -*** Edit archive-contents and add an entry for the new package. - *** Commit your changes This is done the usual way ("bzr add", "bzr commit", etc). diff --git a/admin/archive-contents.el b/admin/archive-contents.el index 5254fbe24..a26e2cc5e 100644 --- a/admin/archive-contents.el +++ b/admin/archive-contents.el @@ -24,7 +24,7 @@ (require 'lisp-mnt) (defun batch-make-archive-contents () - (let ((packages '(1))) ;I think this is the format-version. + (let ((packages '(1))) ; format-version. (dolist (file (directory-files default-directory)) (pcase file ((or `"." `".." `"elpa.rss" `"archive-contents") nil) diff --git a/admin/package-update.sh b/admin/package-update.sh index 98ee3b73e..36e7213c1 100755 --- a/admin/package-update.sh +++ b/admin/package-update.sh @@ -6,7 +6,7 @@ ## This creates a package archive beginning in DEST. ## ## The package archive itself is created in DEST/packages. This dir -## contains the package files and the `archive-contents' listing file. +## contains the package files. ## ## If a second argument FULL-UPDATE is specified (whatever its value), ## also create the following: @@ -79,7 +79,12 @@ else $ADMINROOT/org-synch.sh $TMP_PKGROOT $ADMINROOT >> $LOG 2>&1 fi +## Generate archive-contents and the readme files. + +$EMACS -batch -l $REPO_ROOT_DIR/admin/archive-contents.el -f batch-make-archive-contents + ## Tar up the multi-file packages. + echo "Creating multi-file package tarballs in $TMP_PKGROOT" >> $LOG cd $TMP_PKGROOT for pt in *; do diff --git a/packages/all-readme.txt b/packages/all-readme.txt deleted file mode 100644 index d95710394..000000000 --- a/packages/all-readme.txt +++ /dev/null @@ -1,16 +0,0 @@ -Just like occur, except that changes in the *All* buffer are -propagated to the original buffer. - -You can no longer use mouse-2 to find a match in the original file, -since the default definition of mouse is too useful. -However, `C-c C-c' still works. - -Line numbers are not listed in the *All* buffer. - -Ok, it is _not_ just like occur. - -Some limitations: - -- Undo in the *All* buffer is an ordinary change in the original. -- Changes to the original buffer are not reflected in the *All* buffer. -- A single change in the *All* buffer must be limited to a single match. diff --git a/packages/archive-contents b/packages/archive-contents deleted file mode 100644 index 7c0f77698..000000000 --- a/packages/archive-contents +++ /dev/null @@ -1,28 +0,0 @@ -(1 - (all . - [(1 0) - nil "Edit all lines matching a given regexp" single]) - (auctex . - [(11 86) - nil "Integrated environment for *TeX*" tar]) - (company . - [(0 5) - nil "Flexible inline text and code completion" tar]) - (debbugs . - [(0 1) - nil "SOAP library to access debbugs servers" tar]) - (js2-mode . - [(20090814) - nil "Improved JavaScript editing mode" single]) - (load-dir . - [(0 0 2) - nil "load all Emacs Lisp files in given directories" single]) - (muse . - [(3 20) - nil "Authoring and publishing tool" tar]) - (org . - [(20101118) - nil "Outline-based notes management and organizer" tar]) - (rainbow-mode . - [(0 1) - nil "Colorize color names in buffers" single])) diff --git a/packages/auctex-readme.txt b/packages/auctex-readme.txt deleted file mode 100644 index f04b9cf05..000000000 --- a/packages/auctex-readme.txt +++ /dev/null @@ -1,243 +0,0 @@ -This is the README file for the AUCTeX distribution. - - Copyright (C) 2008 Free Software Foundation, Inc. - - Copying and distribution of this file, with or without - modification, are permitted in any medium without royalty provided - the copyright notice and this notice are preserved. - -Introduction to AUCTeX -********************** - -This file gives a brief overview of what AUCTeX is. It is *not* an -attempt to document AUCTeX. Real documentation for AUCTeX is available -in the manual, which should be available as an info file after -installation. - -AUCTeX is a comprehensive customizable integrated environment for -writing input files for TeX, LaTeX, ConTeXt, Texinfo, and docTeX using -Emacs or XEmacs. - -It supports you in the insertion of macros, environments, and sectioning -commands by providing completion alternatives and prompting for -parameters. It automatically indents your text as you type it and lets -you format a whole file at once. The outlining and folding facilities -provide you with a focused and clean view of your text. - -AUCTeX lets you process your source files by running TeX and related -tools (such as output filters, post processors for generating indices -and bibliographies, and viewers) from inside Emacs. AUCTeX lets you -browse through the errors TeX reported, while it moves the cursor -directly to the reported error, and displays some documentation for -that particular error. This will even work when the document is spread -over several files. - -One component of AUCTeX that LaTeX users will find attractive is -preview-latex, a combination of folding and in-source previewing that -provides true "What You See Is What You Get" experience in your -sourcebuffer, while letting you retain full control. For more -information, see further below. - -More detailed information about the features and usage of AUCTeX can be -found in the AUCTeX manual. You can access it from within Emacs by -typing `C-h i d m auctex '. If you prefer the standalone info -reader, issue the command `info auctex' in a terminal. - -AUCTeX is written entirely in Emacs Lisp, and hence you can easily add -new features for your own needs. It is a GNU project and distributed -under the `GNU General Public License Version 3'. - -The most recent version is always available at -`http://ftp.gnu.org/pub/gnu/auctex/'. - -WWW users may want to check out the AUCTeX page at -`http://www.gnu.org/software/auctex/'. - -For comprehensive information about how to install AUCTeX read the file -`INSTALL' or `INSTALL.windows', respectively. - -If you are considering upgrading AUCTeX, the recent changes are -described in the `CHANGES' file. - -If you want to discuss AUCTeX with other users or its developers, there -are several mailing lists you can use. - -Send a mail with the subject "subscribe" to in -order to join the general discussion list for AUCTeX. Articles should -be sent to . In a similar way, you can subscribe to -the list for just getting important announcements -about AUCTeX. The list is for bug reports which -you should usually file with the `M-x TeX-submit-bug-report ' -command. If you want to address the developers of AUCTeX themselves -with technical issues, they can be found on the discussion list -. - -preview-latex in a nutshell -*************************** - -Does your neck hurt from turning between previewer windows and the -source too often? This AUCTeX component will render your displayed -LaTeX equations right into the editing window where they belong. - -The purpose of preview-latex is to embed LaTeX environments such as -display math or figures into the source buffers and switch conveniently -between source and image representation. - -1 What use is it? -***************** - -WYSIWYG (what you see is what you get) sometimes is considered all the -rage, sometimes frowned upon. Do we really want it? Wrong question. -The right question is _what_ we want from it. Except when finetuning -the layout, we don't want to use printer fonts for on-screen text -editing. The low resolution and contrast of a computer screen render -all but the coarsest printer fonts (those for low-quality newsprint) -unappealing, and the margins and pagination of the print are not wanted -on the screen, either. On the other hand, more complex visual -compositions like math formulas and tables can't easily be taken in -when seen only in the source. preview-latex strikes a balance: it only -uses graphic renditions of the output for certain, configurable -constructs, does this only when told, and then right in the source code. -Switching back and forth between the source and preview is easy and -natural and can be done for each image independently. Behind the scenes -of preview-latex, a sophisticated framework of other programs like -`dvipng', Dvips and Ghostscript are employed together with a special -LaTeX style file for extracting the material of interest in the -background and providing fast interactive response. - -2 Activating preview-latex -************************** - -After installation, the package may need to be activated (and remember -to activate AUCTeX too). In XEmacs, and in any prepackaged versions -worth their salt, activation should be automatic upon installation. If -this seems not the case, complain to your installation provider. - -The usual activation (if it is not done automatically) would be - - (load "preview-latex.el" nil t t) - -If you still don't get a "Preview" menu in LaTeX mode in spite of -AUCTeX showing its "Command", your installation is broken. One -possible cause are duplicate Lisp files that might be detectable with -` list-load-path-shadows '. - -3 Getting started -***************** - -Once activated, preview-latex and its documentation will be accessible -via its menus (note that preview-latex requires AUCTeX to be loaded). -When you have loaded a LaTeX document (a sample document `circ.tex' is -included in the distribution, but most documents including math and/or -figures should do), you can use its menu or `C-c C-p C-d' (for -`Preview/Document'). Previews will now be generated for various -objects in your document. You can use the time to take a short look at -the other menu entries and key bindings in the `Preview' menu. You'll -see the previewed objects change into a roadworks sign when -preview-latex has determined just what it is going to preview. Note -that you can freely navigate the buffer while this is going on. When -the process is finished you will see the objects typeset in your buffer. - -It is a bad idea, however, to edit the buffer before the roadworks signs -appear, since that is the moment when the correlation between the -original text and the buffer locations gets established. If the buffer -changes before that point of time, the previews will not be placed where -they belong. If you do want to change some obvious error you just -spotted, we recommend you stop the background process by pressing `C-c -C-k'. - -To see/edit the LaTeX code for a specific object, put the point (the -cursor) on it and press `C-c C-p C-p' (for `Preview/at point'). It -will also do to click with the middle mouse button on the preview. Now -you can edit the code, and generate a new preview by again pressing -`C-c C-p C-p' (or by clicking with the middle mouse button on the icon -before the edited text). - -If you are using the `desktop' package, previews will remain from one -session to the next as long as you don't kill your buffer. If you are -using XEmacs, you will probably need to upgrade the package to the -newest one; things are being fixed just as I am writing this. - -4 Basic modes of operation -************************** - -preview-latex has a number of methods for generating its graphics. Its -default operation is equivalent to using the `LaTeX' command from -AUCTeX. If this happens to be a call of PDFLaTeX generating PDF output -(you need at least AUCTeX 11.51 for this), then Ghostscript will be -called directly on the resulting PDF file. If a DVI file gets -produced, first Dvips and then Ghostscript get called by default. - -The image type to be generated by Ghostscript can be configured with - - M-x customize-variable RET preview-image-type RET - -The default is `png' (the most efficient image type). A special -setting is `dvipng' in case you have the `dvipng' program installed. -In this case, `dvipng' will be used for converting DVI files and -Ghostscript (with a `PNG' device) for converting PDF files. `dvipng' -is much faster than the combination of Dvips and Ghostscript. You can -get downloads, access to its CVS archive and further information from -its project site (http://savannah.nongnu.org/projects/dvipng). - -5 More documentation -******************** - -After the installation, documentation in the form of an info manual -will be available. You can access it with the standalone info reader -with - - info preview-latex - -or by pressing `C-h i d m preview-latex ' in Emacs. Once -preview-latex is activated, you can instead use `C-c C-p ' (or the -menu entry `Preview/Read documentation'). - -Depending on your installation, a printable manual may also be -available in the form of `preview-latex.dvi' or `preview-latex.ps'. - -Detailed documentation for the LaTeX style used for extracting the -preview images is placed in `preview.dvi' in a suitable directory -during installation; on typical teTeX-based systems, - - texdoc preview - -will display it. - -6 Availability -************** - -The preview-latex project is now part of AUCTeX and accessible as part -of the AUCTeX project page (http://savannah.gnu.org/projects/auctex). -You can get its files from the AUCTeX download area -(ftp://ftp.gnu.org/pub/gnu/auctex). As of AUCTeX 11.81, preview-latex -should already be integrated into AUCTeX, so no separate download will -be necessary. - -You will also find `.rpm' files there for Fedora and possibly SuSE. -Anonymous CVS is available as well. - -7 Contacts -********** - -Bug reports should be sent by using `M-x preview-report-bug ', as -this will fill in a lot of information interesting to us. If the -installation fails (but this should be a rare event), report bugs to -. - -There is a general discussion list for AUCTeX which also covers -preview-latex, look at `http://lists.gnu.org/mailman/listinfo/auctex'. -For more information on the mailing list, send a message with just the -word "help" as subject or body to . For the -developers, there is the list; it would probably -make sense to direct feature requests and questions about internal -details there. There is a low-volume read-only announcement list -available to which you can subscribe by sending a mail with "subscribe" -in the subject to . - -Offers to support further development will be appreciated. If you want -to show your appreciation with a donation to the main developer, you can -do so via PayPal to , and of course you can arrange for -service contracts or for added functionality. Take a look at the -`TODO' list for suggestions in that area. - diff --git a/packages/company-readme.txt b/packages/company-readme.txt deleted file mode 100644 index b36da7e5f..000000000 --- a/packages/company-readme.txt +++ /dev/null @@ -1,6 +0,0 @@ -Company is an Emacs extension for performing text completion. -Completion candidates are retrieved from a variety of modular -back-ends, such as Semantic. - -Once installed, enable company-mode with M-x company-mode. -For further information, see the docstring for `company-mode'. diff --git a/packages/debbugs-readme.txt b/packages/debbugs-readme.txt deleted file mode 100644 index b20dbc87e..000000000 --- a/packages/debbugs-readme.txt +++ /dev/null @@ -1,9 +0,0 @@ -This package provides some basic functions to access a debbugs SOAP -server (see ). - -It implements the SOAP functions "get_bugs", "newest_bugs", -"get_status" and "get_bug_log". The SOAP functions "get_usertag" and -"get_versions" are not implemented (yet). - -The debbugs server to be connected can be customized via the option -`debbugs-port'. diff --git a/packages/js2-mode-readme.txt b/packages/js2-mode-readme.txt deleted file mode 100644 index 5da80505d..000000000 --- a/packages/js2-mode-readme.txt +++ /dev/null @@ -1,36 +0,0 @@ -This JavaScript editing mode supports: - - - strict recognition of the Ecma-262 language standard - - support for most Rhino and SpiderMonkey extensions from 1.5 to 1.8 - - parsing support for ECMAScript for XML (E4X, ECMA-357) - - accurate syntax highlighting using a recursive-descent parser - - on-the-fly reporting of syntax errors and strict-mode warnings - - undeclared-variable warnings using a configurable externs framework - - "bouncing" line indentation to choose among alternate indentation points - - smart line-wrapping within comments and strings - - code folding: - - show some or all function bodies as {...} - - show some or all block comments as /*...*/ - - context-sensitive menu bar and popup menus - - code browsing using the `imenu' package - - typing helpers such as automatic insertion of matching braces/parens - - many customization options - -To customize how it works: - M-x customize-group RET js2-mode RET - -Notes: - -This mode includes a port of Mozilla Rhino's scanner, parser and -symbol table. Ideally it should stay in sync with Rhino, keeping -`js2-mode' current as the EcmaScript language standard evolves. - -Unlike cc-engine based language modes, js2-mode's line-indentation is not -customizable. It is a surprising amount of work to support customizable -indentation. The current compromise is that the tab key lets you cycle among -various likely indentation points, similar to the behavior of python-mode. - -This mode does not yet work with "multi-mode" modes such as `mmm-mode' -and `mumamo', although it could be made to do so with some effort. -This means that `js2-mode' is currently only useful for editing JavaScript -files, and not for editing JavaScript within