aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGlenn Morris2012-12-12 09:19:20 -0800
committerGlenn Morris2012-12-12 09:19:20 -0800
commit4c2dd4eeffd612508159b8c5f3d51e2e1bf4bf11 (patch)
tree3bf82ebe319fa2358779cb4e40f2785293f5108e /doc
parentac1d9ddee6098e829f87523a6328e81e98dfba70 (diff)
downloademacs-4c2dd4eeffd612508159b8c5f3d51e2e1bf4bf11.tar.gz
emacs-4c2dd4eeffd612508159b8c5f3d51e2e1bf4bf11.zip
Add srecode manual to build process
* doc/misc/srecode.texi: Small edits. Set copyright to FSF, add explicit GFDL 1.3+ license, fix up index. * doc/misc/Makefile.in (INFO_TARGETS, DVI_TARGETS, PDF_TARGETS): Add srecode. (srecode, $(buildinfodir)/srecode$(INFO_EXT), srecode.dvi) (srecode.pdf): New targets. * doc/misc/makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add srecode. ($(infodir)/srecode$(INFO_EXT), srecode.dvi): New targets. * info/dir: Add srecode.
Diffstat (limited to 'doc')
-rw-r--r--doc/misc/ChangeLog10
-rw-r--r--doc/misc/Makefile.in13
-rw-r--r--doc/misc/makefile.w32-in13
-rw-r--r--doc/misc/srecode.texi65
4 files changed, 80 insertions, 21 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 8bc178e005b..7bbb0384641 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,13 @@
12012-12-12 Glenn Morris <rgm@gnu.org>
2
3 * srecode.texi: Small edits. Set copyright to FSF, add explicit
4 GFDL 1.3+ license, fix up index.
5 * Makefile.in (INFO_TARGETS, DVI_TARGETS, PDF_TARGETS): Add srecode.
6 (srecode, $(buildinfodir)/srecode$(INFO_EXT), srecode.dvi)
7 (srecode.pdf): New targets.
8 * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add srecode.
9 ($(infodir)/srecode$(INFO_EXT), srecode.dvi): New targets.
10
12012-12-12 Eric Ludlam <zappo@gnu.org> 112012-12-12 Eric Ludlam <zappo@gnu.org>
2 12
3 * srecode.texi: New file, imported from CEDET trunk. 13 * srecode.texi: New file, imported from CEDET trunk.
diff --git a/doc/misc/Makefile.in b/doc/misc/Makefile.in
index ea1e87333bd..ecff9a97d4e 100644
--- a/doc/misc/Makefile.in
+++ b/doc/misc/Makefile.in
@@ -47,7 +47,7 @@ INFO_TARGETS = ada-mode auth autotype calc ccmode cl \
47 flymake forms gnus emacs-gnutls idlwave info.info \ 47 flymake forms gnus emacs-gnutls idlwave info.info \
48 mairix-el message mh-e newsticker nxml-mode \ 48 mairix-el message mh-e newsticker nxml-mode \
49 org pcl-cvs pgg rcirc remember reftex sasl \ 49 org pcl-cvs pgg rcirc remember reftex sasl \
50 sc semantic ses sieve smtpmail speedbar tramp \ 50 sc semantic ses sieve smtpmail speedbar srecode tramp \
51 url vip viper widget woman 51 url vip viper widget woman
52 52
53DVI_TARGETS = \ 53DVI_TARGETS = \
@@ -95,6 +95,7 @@ DVI_TARGETS = \
95 sieve.dvi \ 95 sieve.dvi \
96 smtpmail.dvi \ 96 smtpmail.dvi \
97 speedbar.dvi \ 97 speedbar.dvi \
98 srecode.dvi \
98 tramp.dvi \ 99 tramp.dvi \
99 url.dvi \ 100 url.dvi \
100 vip.dvi \ 101 vip.dvi \
@@ -147,6 +148,7 @@ PDF_TARGETS = \
147 sieve.pdf \ 148 sieve.pdf \
148 smtpmail.pdf \ 149 smtpmail.pdf \
149 speedbar.pdf \ 150 speedbar.pdf \
151 srecode.pdf \
150 tramp.pdf \ 152 tramp.pdf \
151 url.pdf \ 153 url.pdf \
152 vip.pdf \ 154 vip.pdf \
@@ -606,6 +608,15 @@ speedbar.dvi: ${srcdir}/speedbar.texi
606speedbar.pdf: ${srcdir}/speedbar.texi 608speedbar.pdf: ${srcdir}/speedbar.texi
607 $(ENVADD) $(TEXI2PDF) ${srcdir}/speedbar.texi 609 $(ENVADD) $(TEXI2PDF) ${srcdir}/speedbar.texi
608 610
611srecode : $(buildinfodir)/srecode$(INFO_EXT)
612$(buildinfodir)/srecode$(INFO_EXT): ${srcdir}/srecode.texi
613 $(mkinfodir)
614 $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/srecode.texi
615srecode.dvi: ${srcdir}/srecode.texi
616 $(ENVADD) $(TEXI2DVI) ${srcdir}/srecode.texi
617srecode.pdf: ${srcdir}/srecode.texi
618 $(ENVADD) $(TEXI2PDF) ${srcdir}/srecode.texi
619
609tramp : $(buildinfodir)/tramp$(INFO_EXT) 620tramp : $(buildinfodir)/tramp$(INFO_EXT)
610$(buildinfodir)/tramp$(INFO_EXT): ${srcdir}/tramp.texi ${srcdir}/trampver.texi 621$(buildinfodir)/tramp$(INFO_EXT): ${srcdir}/tramp.texi ${srcdir}/trampver.texi
611 $(mkinfodir) 622 $(mkinfodir)
diff --git a/doc/misc/makefile.w32-in b/doc/misc/makefile.w32-in
index 9e577c351b7..d8054ce62fe 100644
--- a/doc/misc/makefile.w32-in
+++ b/doc/misc/makefile.w32-in
@@ -54,7 +54,8 @@ INFO_TARGETS = $(infodir)/ccmode$(INFO_EXT) \
54 $(infodir)/remember$(INFO_EXT) $(infodir)/nxml-mode$(INFO_EXT) \ 54 $(infodir)/remember$(INFO_EXT) $(infodir)/nxml-mode$(INFO_EXT) \
55 $(infodir)/epa$(INFO_EXT) $(infodir)/mairix-el$(INFO_EXT) $(infodir)/sasl$(INFO_EXT) \ 55 $(infodir)/epa$(INFO_EXT) $(infodir)/mairix-el$(INFO_EXT) $(infodir)/sasl$(INFO_EXT) \
56 $(infodir)/auth$(INFO_EXT) $(infodir)/eieio$(INFO_EXT) $(infodir)/ede$(INFO_EXT) \ 56 $(infodir)/auth$(INFO_EXT) $(infodir)/eieio$(INFO_EXT) $(infodir)/ede$(INFO_EXT) \
57 $(infodir)/semantic$(INFO_EXT) $(infodir)/edt$(INFO_EXT) $(infodir)/emacs-gnutls$(INFO_EXT) 57 $(infodir)/semantic$(INFO_EXT) $(infodir)/edt$(INFO_EXT) $(infodir)/emacs-gnutls$(INFO_EXT) \
58 $(infodir)/srecode$(INFO_EXT)
58DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \ 59DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \
59 ediff.dvi forms.dvi gnus.dvi message.dvi emacs-mime.dvi \ 60 ediff.dvi forms.dvi gnus.dvi message.dvi emacs-mime.dvi \
60 sieve.dvi pgg.dvi mh-e.dvi \ 61 sieve.dvi pgg.dvi mh-e.dvi \
@@ -65,7 +66,7 @@ DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \
65 newsticker.dvi rcirc.dvi erc.dvi ert.dvi \ 66 newsticker.dvi rcirc.dvi erc.dvi ert.dvi \
66 remember.dvi nxml-mode.dvi \ 67 remember.dvi nxml-mode.dvi \
67 epa.dvi mairix-el.dvi sasl.dvi auth.dvi eieio.dvi ede.dvi \ 68 epa.dvi mairix-el.dvi sasl.dvi auth.dvi eieio.dvi ede.dvi \
68 semantic.dvi edt.dvi emacs-gnutls.dvi 69 semantic.dvi edt.dvi emacs-gnutls.dvi srecode.dvi
69INFOSOURCES = info.texi 70INFOSOURCES = info.texi
70 71
71# The following rule does not work with all versions of `make'. 72# The following rule does not work with all versions of `make'.
@@ -358,6 +359,11 @@ $(infodir)/emacs-gnutls$(INFO_EXT): emacs-gnutls.texi doclicense.texi
358emacs-gnutls.dvi: emacs-gnutls.texi doclicense.texi 359emacs-gnutls.dvi: emacs-gnutls.texi doclicense.texi
359 $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-gnutls.texi 360 $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-gnutls.texi
360 361
362$(infodir)/srecode$(INFO_EXT): srecode.texi doclicense.texi
363 $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ srecode.texi
364srecode.dvi: srecode.texi doclicense.texi
365 $(ENVADD) $(TEXI2DVI) $(srcdir)/srecode.texi
366
361mostlyclean: 367mostlyclean:
362 - $(DEL) *.log *.cp *.fn *.ky *.pg *.vr core *.tp *.core gnustmp.* 368 - $(DEL) *.log *.cp *.fn *.ky *.pg *.vr core *.tp *.core gnustmp.*
363 369
@@ -385,7 +391,8 @@ clean: mostlyclean
385 $(infodir)/epa* $(infodir)/sasl* \ 391 $(infodir)/epa* $(infodir)/sasl* \
386 $(infodir)/mairix-el* $(infodir)/auth* \ 392 $(infodir)/mairix-el* $(infodir)/auth* \
387 $(infodir)/eieio* $(infodir)/ede* \ 393 $(infodir)/eieio* $(infodir)/ede* \
388 $(infodir)/semantic* $(infodir)edt* $(infodir)/emacs-gnutls* 394 $(infodir)/semantic* $(infodir)edt* \
395 $(infodir)/emacs-gnutls* $(infodir)/srecode*
389 396
390distclean: clean 397distclean: clean
391 - $(DEL) makefile 398 - $(DEL) makefile
diff --git a/doc/misc/srecode.texi b/doc/misc/srecode.texi
index e2f0ec79c2e..10a0d8770dc 100644
--- a/doc/misc/srecode.texi
+++ b/doc/misc/srecode.texi
@@ -1,32 +1,50 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo
2@c
3@c $Id: srecode.texi,v 1.24 2010-05-30 20:22:40 scymtym Exp $
4@c
5@c %**start of header 2@c %**start of header
6@setfilename srecode.info 3@setfilename ../../info/srecode
7@set TITLE SRecoder Manual 4@set TITLE SRecoder Manual
8@set AUTHOR Eric M. Ludlam 5@set AUTHOR Eric M. Ludlam
9@settitle @value{TITLE} 6@settitle @value{TITLE}
7
8@c Merge all indexes into a single index for now.
9@c We can always separate them later into two or more as needed.
10@syncodeindex vr cp
11@syncodeindex fn cp
12@syncodeindex ky cp
13@syncodeindex pg cp
14@syncodeindex tp cp
10@c %**end of header 15@c %**end of header
11 16
12@ifinfo 17@copying
13@dircategory Emacs 18Copyright @copyright{} 2007-2012 Free Software Foundation, Inc.
14@format 19
15START-INFO-DIR-ENTRY 20@quotation
16* srecode: (srecode). Template code generator 21Permission is granted to copy, distribute and/or modify this document
17END-INFO-DIR-ENTRY 22under the terms of the GNU Free Documentation License, Version 1.3 or
18@end format 23any later version published by the Free Software Foundation; with no
19@end ifinfo 24Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
25and with the Back-Cover Texts as in (a) below. A copy of the license
26is included in the section entitled ``GNU Free Documentation License''.
27
28(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
29modify this GNU manual. Buying copies from the FSF supports it in
30developing GNU and promoting software freedom.''
31@end quotation
32@end copying
33
34@dircategory Emacs misc features
35@direntry
36* SRecode: (srecode). Template code generator.
37@end direntry
20 38
21@titlepage 39@titlepage
22@sp 10 40@sp 10
23@center @titlefont{srecode} 41@center @titlefont{SRecode}
24@vskip 0pt plus 1 fill 42@vskip 0pt plus 1 fill
25Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Eric M. Ludlam 43@center by @value{AUTHOR}
26@end titlepage 44@end titlepage
27 45
28@macro semantic{} 46@macro semantic{}
29@i{semantic} 47@i{Semantic}
30@end macro 48@end macro
31 49
32@macro EIEIO{} 50@macro EIEIO{}
@@ -55,6 +73,10 @@ someone can write a complex code generator, and the underlying
55template commonality allows it to work in multiple languages with 73template commonality allows it to work in multiple languages with
56ease. 74ease.
57 75
76@ifnottex
77@insertcopying
78@end ifnottex
79
58@menu 80@menu
59* Quick Start:: Basic Setup for template insertion. 81* Quick Start:: Basic Setup for template insertion.
60* User Templates:: Custom User Templates 82* User Templates:: Custom User Templates
@@ -66,6 +88,7 @@ ease.
66* Template Naming Conventions:: Creating a set of core templates 88* Template Naming Conventions:: Creating a set of core templates
67* Inserting Tag Lists:: Inserting Semantic tags via templates 89* Inserting Tag Lists:: Inserting Semantic tags via templates
68* Application Writing:: Writing an @srecode{}r application 90* Application Writing:: Writing an @srecode{}r application
91* GNU Free Documentation License:: The license for this documentation.
69* Index:: 92* Index::
70@end menu 93@end menu
71 94
@@ -1759,10 +1782,18 @@ all template files for that application will be loaded.
1759 todo - Add examples. Most core stuff is already described above. 1782 todo - Add examples. Most core stuff is already described above.
1760 1783
1761 1784
1785@node GNU Free Documentation License
1786@appendix GNU Free Documentation License
1787@include doclicense.texi
1788
1762 1789
1763@node Index 1790@node Index
1764@chapter Index 1791@unnumbered Index
1792@printindex cp
1765 1793
1794@iftex
1766@contents 1795@contents
1796@summarycontents
1797@end iftex
1767 1798
1768@bye 1799@bye