1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
# Makefile --- Build GNU Hyperbole directories and package distributions
#
# Author: Bob Weiner
#
# Orig-Date: 15-Jun-94 at 03:42:38
#
# Copyright (C) 1994-2017 Free Software Foundation, Inc.
# See the file HY-COPY for license information.
#
# This file is part of GNU Hyperbole.
# Commentary:
#
# **********
# READ THIS:
# **********
#
# Only Hyperbole developers (those who develop the source code) need
# to use this file for building Hyperbole package distributions. Others
# may ignore it.
#
# GNU Hyperbole is now installed for use via the Emacs package system; see
# the "INSTALL" file for installation instructions and the Info node,
# "(emacs)Packages", if you are unfamiliar with the Emacs package system.
#
# **********
#
# Before doing your first make, edit the CONFIGURABLE SECTION below.
# Make any needed changes now and save the file. Then select from the
# USAGE lines immediately following.
#
# USAGE: For those installing GNU Hyperbole, use:
# make help
#
# To build only the output formats of the Hyperbole MANUAL:
# make doc
#
# To assemble a Hyperbole Emacs package for testing:
# make pkg
#
# To release a Hyperbole Emacs package to ELPA and ftp.gnu.org:
# make release
#
# The Hyperbole Manual is included in the package in four forms:
# "man/hyperbole.info" - GNU browsable version
# "man/hyperbole.html" - Web browsable version
# "man/hyperbole.pdf" - Printable version
# "man/hyperbole.texi" - source form
# Code:
##########################################################################
# CONFIGURABLE SECTION #
##########################################################################
# This ver setup won't work under any make except GNU make, so set it manually.
#HYPB_VERSION = "`head -3 hversion.el | tail -1 | sed -e 's/.*|\(.*\)|.*/\1/'`"
HYPB_VERSION = 7.0.3b
# Emacs executable used to byte-compile .el files into .elc's.
# Possibilities include: emacs, infodock, etc.
EMACS = \emacs
# Site-specific Emacs Lisp libraries to load before byte-compiling any files
# from this package. Typically the only reason to set this is to get Emacs
# to include the directory of this package into its load-path variable, which
# determines where it will find Lisp library files to load. This is now
# handled automatically by Hyperbole for most modern versions of Emacs.
#
# You must include the .el or .elc file suffix on each library name and each
# must be preceded by the `-l' command-line flag. If the directory in which
# the library is stored will not be in your Emacs load-path when Emacs
# attempts to load the library, you must include the full pathname to the
# library. Here is an example setting.
#
# SITE_PRELOADS = -l ~/.emacs -l set-load-path.el
#
SITE_PRELOADS =
# Command used to build the .info version of the user manual.
TEXI2INFO = makeinfo --no-split
# Command used to build the .html version of the user manual.
# TEXI2HTML = id-texi2html -html_only -number -split_chapter # InfoDock-specific command
# TEXI2HTML = makeinfo --html --split=chapter # Chapter splitting doesn't seem to work in 6.0
TEXI2HTML = makeinfo --html --no-split --css-ref="hyperbole.css"
# Command used to build the .pdf version of the user manual.
TEXI2PDF = makeinfo --pdf --no-split
# Where to find the parent tree of the Hyperbole source directory.
id_dir = $(HOME)/sw-dev/emacs
# Where to find the local clone of the Elpa Hyperbole package repository
elpa_hypb_dir = $(id_dir)/elpa/packages/hyperbole
id_dir = $(HOME)/sw-dev/emacs
# Where to find the .texi source of the user manual.
man_dir := $(shell pwd)/man
# Where to install the Hyperbole mouse key help file
data_dir = $(id_dir)/id-etc
# Where to install the Info version of the user manual.
info_dir = $(id_dir)/id-info
# Where to install the HTML version of the user manual.
html_dir = $(id_dir)/id-html
# Shell used to process this Makefile. Bourne shell syntax is required.
SHELL = /bin/sh
# Shell commands you may want to change for your particular system.
CP = \cp -p
ETAGS = \etags
GNUFTP = \gnupload --to ftp.gnu.org:hyperbole
GPG = \gpg
GZIP = \gzip -c
INSTALL = \install -m 644 -c
MKDIR = \mkdir -p
MAKE = \make
RM = \rm -f
TAR = \tar
ZIP = \zip -qry
# Directory in which to create new package distributions of Hyperbole.
pkg_dir = /tmp
pkg_hyperbole = $(pkg_dir)/hyperbole
# Temp file to use to build .elc files.
ELISP_TO_COMPILE = $(pkg_dir)/elc-${USER}
##########################################################################
# NO CHANGES REQUIRED BELOW HERE. #
##########################################################################
# Libraries that must be pre-loaded before trying to byte-compile anything.
PRELOADS = $(SITE_PRELOADS) -l ./hload-path.el -l ./hversion.el -l ./hyperbole.el
# Compile in batch mode. Load site-lisp/site-start.el, which may set load-path.
BATCHFLAGS = -batch -Q
# Directories other than the current directory in which to find files.
# This doesn't seem to work in all versions of make, so we also add kotl/
# explicitly to those files which need it.
VPATH = kotl man
EL_SRC = hui-em-but.el
EL_COMPILE = hact.el hactypes.el hargs.el hbdata.el hbmap.el hbut.el \
hgnus.el hhist.el hib-debbugs.el hib-doc-id.el hib-kbd.el \
hib-social.el hibtypes.el \
hinit.el hload-path.el hmail.el hmh.el hmoccur.el hmouse-info.el \
hmouse-drv.el hmouse-key.el hmouse-mod.el hmouse-sh.el hmouse-tag.el \
hpath.el hrmail.el hsettings.el hsmail.el hsys-org.el hsys-www.el htz.el \
hycontrol.el hui-jmenu.el hui-menu.el hui-mini.el hui-mouse.el hui-select.el \
hui-treemacs.el hui-window.el hui.el hvar.el hversion.el hvm.el hypb.el hyperbole.el \
hyrolo-demo.el hyrolo-logic.el hyrolo-menu.el hyrolo.el hywconfig.el set.el
EL_KOTL = kotl/kexport.el kotl/kfile.el kotl/kfill.el kotl/kimport.el kotl/klabel.el \
kotl/klink.el kotl/kmenu.el kotl/knode.el kotl/kotl-mode.el \
kotl/kcell.el kotl/kproperty.el kotl/kprop-em.el \
kotl/kview.el kotl/kvspec.el
ELC_COMPILE = hactypes.elc hibtypes.elc hib-debbugs.elc hib-doc-id.elc hib-kbd.elc \
hib-social.elc hact.elc \
hargs.elc hbdata.elc hbmap.elc hbut.elc hgnus.elc hhist.elc \
hinit.elc hload-path.elc hmail.elc hmh.elc hmoccur.elc hmouse-info.elc \
hmouse-drv.elc hmouse-key.elc hmouse-mod.elc hmouse-sh.elc hmouse-tag.elc \
hpath.elc hrmail.elc hsettings.elc hsmail.elc hsys-org.elc hsys-www.elc htz.elc \
hycontrol.elc hui-jmenu.elc hui-menu.elc hui-mini.elc hui-mouse.elc hui-select.elc \
hui-treemacs.elc hui-window.elc hui.elc hvar.elc hversion.elc hvm.elc hypb.elc hyperbole.elc \
hyrolo-demo.elc hyrolo-logic.elc hyrolo-menu.elc hyrolo.elc hywconfig.elc set.elc
ELC_KOTL = kotl/kexport.elc kotl/kfile.elc kotl/kfill.elc kotl/kimport.elc kotl/klabel.elc \
kotl/klink.elc kotl/kmenu.elc kotl/knode.elc kotl/kotl-mode.elc \
kotl/kcell.elc kotl/kproperty.elc \
kotl/kview.el kotl/kvspec.elc
HYPERBOLE_FILES = dir hyperbole-pkg.el info html $(EL_SRC) $(EL_COMPILE) $(EL_KOTL) \
$(ELC_COMPILE) Changes COPYING Makefile HY-ABOUT HY-ANNOUNCE HY-NEWS \
HY-WHY.kotl INSTALL DEMO DEMO-ROLO.otl MANIFEST README _hypb .hypb smart-clib-sym \
topwin.py hyperbole-banner.png $(man_dir)/hkey-help.txt \
$(man_dir)/hyperbole.texi $(man_dir)/hyperbole.css $(man_dir)/version.texi
EL_TAGS = $(EL_SRC) $(EL_COMPILE) $(EL_KOTL)
.SUFFIXES: # Delete the default suffixes
.SUFFIXES: .el .elc # Define the list of file suffixes to match to rules
help:
@ echo "Use the Emacs Package Manager to build and install GNU Hyperbole."
@ echo "See \"$(shell pwd)/INSTALL\" for installation instructions."
@ echo "For help with Emacs packages, see the GNU Emacs Info Manual section, \"(emacs)Packages\"."
@ echo ""
@ echo "For Hyperbole maintainers, the Hyperbole distribution package is built with:"
@ echo " make pkg"
@ echo " To build documentation formats only, use:"
@ echo " make doc"
@ echo " To release a Hyperbole Emacs package to ELPA and ftp.gnu.org:"
@ echo " make release"
@ echo ""
@ echo "The Hyperbole Manual is included in the package in four forms:"
@ echo " man/hyperbole.info - GNU browsable version"
@ echo " man/hyperbole.html - Web browsable version"
@ echo " man/hyperbole.pdf - Printable version"
@ echo " man/hyperbole.texi - source form"
all: help
install: elc install-info install-html $(data_dir)/hkey-help.txt
install-info: $(info_dir)/hyperbole.info
$(info_dir)/hyperbole.info: $(man_dir)/hyperbole.info
$(MKDIR) $(info_dir)/im; \
cd $(man_dir); $(INSTALL) hyperbole.info* $(info_dir); \
$(INSTALL) im/*.{png,eps} $(info_dir)/im
install-html: $(html_dir)/hyperbole.html
$(html_dir)/hyperbole.html: $(man_dir)/hyperbole.html $(man_dir)/hyperbole.css
$(MKDIR) $(html_dir)/im; \
cd $(man_dir); $(INSTALL) hyperbole.html* hyperbole.css $(html_dir); \
$(INSTALL) im/*.{png,eps} $(html_dir)/im
$(data_dir)/hkey-help.txt: $(man_dir)/hkey-help.txt
$(INSTALL) hkey-help.txt $(data_dir)
# Record any .el files that need to be compiled.
.el.elc:
@ echo $< >> $(ELISP_TO_COMPILE)
# Compile all recorded .el files.
elc: elc-init $(ELC_KOTL) $(ELC_COMPILE)
@- \test ! -f $(ELISP_TO_COMPILE) \
|| (echo "These files will be compiled: " \
&& echo "`cat $(ELISP_TO_COMPILE)`" \
&& $(EMACS) $(BATCHFLAGS) $(PRELOADS) \
-f batch-byte-compile `cat $(ELISP_TO_COMPILE)`)
@ $(RM) $(ELISP_TO_COMPILE)
elc-init:
@ $(RM) $(ELISP_TO_COMPILE)
# Remove and then rebuild all byte-compiled .elc files, even those .elc files
# which do not yet exist.
all-elc:
$(RM) *.elc kotl/*.elc
$(EMACS) $(BATCHFLAGS) $(PRELOADS) -f batch-byte-compile $(EL_KOTL) $(EL_COMPILE)
tags: TAGS
TAGS: $(EL_TAGS)
$(ETAGS) $(EL_TAGS)
version: doc
@ echo ""
@ echo "Any fgrep output means the version number has not been updated in that file."
fgrep -L $(HYPB_VERSION) Makefile HY-ABOUT HY-NEWS README.md hversion.el hyperbole.el hyperbole-pkg.el man/hyperbole.texi man/version.texi
@ echo ""
# Build the Info, HTML and Postscript versions of the user manual and README.md.html.
doc: info html pdf README.md.html
TEXINFO_SRC = $(man_dir)/hyperbole.texi $(man_dir)/version.texi $(man_dir)/hkey-help.txt $(man_dir)/im/*.png
info: $(man_dir)/hyperbole.info
$(man_dir)/hyperbole.info: $(TEXINFO_SRC)
cd $(man_dir) && $(TEXI2INFO) hyperbole.texi
html: $(man_dir)/hyperbole.html
$(man_dir)/hyperbole.html: $(TEXINFO_SRC) $(man_dir)/hyperbole.css
cd ${man_dir} && $(TEXI2HTML) hyperbole.texi
pdf: $(man_dir)/hyperbole.pdf
$(man_dir)/hyperbole.pdf: $(TEXINFO_SRC)
cd $(man_dir) && $(TEXI2PDF) hyperbole.texi
# github-markdown is an npm, installed with: npm install markdown-to-html -g
# Documentation is here: https://www.npmjs.com/package/markdown-to-html
README.md.html: README.md
github-markdown README.md > README.md.html
# Generate a Hyperbole package suitable for distribution via the Emacs package manager.
pkg: package
package: git-pull doc kotl/kotl-autoloads.el $(pkg_dir)/hyperbole-$(HYPB_VERSION).tar.sig
# Generate and distribute a Hyperbole release to GNU ELPA and ftp.gnu.org.
# One step in this is to generate an autoloads file for the Koutliner, kotl/kotl-autoloads.el.
release: package git-push $(pkg_dir)/hyperbole-$(HYPB_VERSION).tar.gz elpa ftp
@ echo; echo "Hyperbole $(HYPB_VERSION) released to elpa and ftp.gnu.org successfully."
# Ensure local hyperbole directory is synchronized with master before building a release.
git-pull:
git pull
git-push:
git push
# Once the release version number is updated in hyperbole.el and the release is pushed to
# git, ELPA will automatically check and build its Hyperbole archive, allowing users to
# update their packages of Hyperbole. ELPA does this twice a day now.
elpa: package
cd $(elpa_hypb_dir) && git pull http://git.savannah.gnu.org/r/hyperbole.git master \
&& git tag -s hyperbole-$(HYPB_VERSION) && git push
elpa-test: package
cd $(elpa_hypb_dir) && git pull http://git.savannah.gnu.org/r/hyperbole.git master
# Send compressed tarball for uploading to GNU ftp site; this must be done from the directory
# containing the tarball to upload.
ftp: package
cd $(pkg_dir) && $(GNUFTP) hyperbole-$(HYPB_VERSION).tar.gz
kotl/kotl-autoloads.el: $(EL_KOTL)
$(EMACS) $(BATCHFLAGS) -eval '(progn (let ((generated-autoload-file (expand-file-name "kotl/kotl-autoloads.el"))) (update-directory-autoloads (expand-file-name "kotl/"))))' && $(RM) kotl/kotl-autoloads.el~
# $(EMACS) $(BATCHFLAGS) -eval '(progn (let ((generated-autoload-file (expand-file-name "kotl/kotl-autoloads.el"))) (update-directory-autoloads (expand-file-name "kotl/"))))' && sed -i '3 i ;; Copyright (C) 2017 Free Software Foundation, Inc.\n;;' $@ && $(RM) kotl/kotl-autoloads.el~
# Used for ftp.gnu.org tarball distributions.
$(pkg_dir)/hyperbole-$(HYPB_VERSION).tar.gz:
cd $(pkg_dir) && $(GZIP) hyperbole-$(HYPB_VERSION).tar > hyperbole-$(HYPB_VERSION).tar.gz
$(pkg_dir)/hyperbole-$(HYPB_VERSION).tar.sig: $(pkg_dir)/hyperbole-$(HYPB_VERSION).tar
cd $(pkg_dir) && $(GPG) -ba -o hyperbole-$(HYPB_VERSION).tar.sig hyperbole-$(HYPB_VERSION).tar
@ echo; echo "Hyperbole package built successfully:"
@ ls -l $(pkg_dir)/hyperbole-$(HYPB_VERSION).tar*
$(pkg_dir)/hyperbole-$(HYPB_VERSION).tar: $(HYPERBOLE_FILES)
make version
cd $(pkg_dir) && $(RM) -fr $(pkg_hyperbole) $(pkg_hyperbole)-$(HYPB_VERSION)
cd .. && COPYFILE_DISABLE=1 $(TAR) -clf $(pkg_dir)/h.tar hyperbole
cd $(pkg_dir) && COPYFILE_DISABLE=1 $(TAR) xf h.tar && cd $(pkg_hyperbole) && $(MAKE) packageclean
cd $(pkg_hyperbole) && make kotl/kotl-autoloads.el && chmod 755 topwin.py && \
cd $(pkg_dir) && $(RM) h.tar; \
mv $(pkg_hyperbole) $(pkg_hyperbole)-$(HYPB_VERSION) && \
COPYFILE_DISABLE=1 $(TAR) -clf $(pkg_dir)/hyperbole-$(HYPB_VERSION).tar hyperbole-$(HYPB_VERSION)
$(INSTALL) HY-ABOUT HY-ANNOUNCE HY-NEWS HY-WHY.kotl INSTALL README $(pkg_dir)/; chmod 644 $(pkg_dir)/*.tar
pkgclean: packageclean
packageclean:
if [ -d $(pkg_hyperbole) ]; then \
cd $(pkg_hyperbole) && $(RM) -r .git* videos ChangeLog.* *autoloads.* *.elc TAGS TODO* HY-ANNOUNCE-* .DS_Store \
core .place* ._* .*~ *~ *\# *- *.orig *.rej .nfs* CVS .cvsignore GNUmakefile.id \
&& gsed '/\f/,/\f/{/\f/!d}' .hypb | tail +2 > .hypb2 && rm -f .hypb && mv .hypb2 .hypb; fi # Filter out unneeded TODO file hbut data from .hypb
if [ -d $(pkg_hyperbole)/kotl ]; then \
cd $(pkg_hyperbole)/kotl && $(RM) -r *autoloads.* *.elc TAGS TODO* .DS_Store \
core .place* ._* .*~ *~ *\# *- *.orig *.rej .nfs* CVS .cvsignore; fi
if [ -d $(pkg_hyperbole)/man ]; then \
cd $(pkg_hyperbole)/man && $(RM) -r .DS_Store core .place* hyperbole.{log,aux,cp*,fn*,ky*,toc,vr*} \
._* .*~ *~ *\# *- *.orig *.rej .nfs* CVS .cvsignore; fi
if [ -d $(pkg_hyperbole)/man/im ]; then \
cd $(pkg_hyperbole)/man/im && $(RM) -r .DS_Store core .place* ._* .*~ *~ \
*.ps *\# *- *.orig *.rej .nfs* CVS .cvsignore; fi
|
