X-Git-Url: https://cgit.sxemacs.org/?a=blobdiff_plain;f=doc%2FHACKING;h=22590f809434b371f06c118c2c7f4caa845e0d1d;hb=465b68048344cb9660459ea4a64abc1a2591c094;hp=af2c8c7015d3e27908c50f0277cdce2c3462459e;hpb=067636134fc868d1a0eccd4ba03a414f8686e452;p=riece diff --git a/doc/HACKING b/doc/HACKING index af2c8c7..22590f8 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -26,10 +26,9 @@ To join the development, send us a patch or an add-on. ** CVS Development of Riece uses CVS. Latest developing version is available -at CVS. Please note that the newest development version from CVS may -NOT be reliable. You can only use it at your own risk. We may ignore -bug reports for that version. The instruction to access the CVS -server is below. +at CVS. Please note that the version from CVS may NOT be reliable, +and you can only use it at your own risk. We may ignore bug reports +for that version. The instruction to access the CVS server is below. (1) logging in to anonymous CVS server @@ -385,28 +384,29 @@ Below is a list of signal names reserved. Elisp modules that satisfy add-on spec should provide the following functions. -- -requires - Return a list of names of other add-ons this add-on depends. (optional) +- -requires (optional) + Return a list of names of other add-ons this add-on depends. - -insinuate Called on initialization of this module. +- -uninstall (optional) + Called on uninstallation of this module. + +- -enable (optional) + Called when this add-on is enabled. + +- -disable (optional) + Called when this add-on is disabled. + It is recommended to set short explanation of the add-on to -description variable which is displayed on add-on listing shown up by C-c ^ (M-x riece-command-list-addons). -Add-ons that support enabling/disabling set the current status to --enabled variable. If this variable is nil, the add-on -is regarded as currently disabled. In addition, the add-on must -provide the following two functions. - -- -enable - Called to enable this add-on. - -- -disable - Called to disable this add-on. +To see the add-on's enabled/disabled status, check riece-addon-enabled +property set on symbol. -Riece does the following process when startup. +Riece does the following procedure on add-ons when startup. (1) Load add-ons listed in the riece-addons variable.