From 4c2dd4eeffd612508159b8c5f3d51e2e1bf4bf11 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Wed, 12 Dec 2012 09:19:20 -0800 Subject: [PATCH] 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. --- ChangeLog | 4 +++ doc/misc/ChangeLog | 10 +++++++ doc/misc/Makefile.in | 13 +++++++- doc/misc/makefile.w32-in | 13 ++++++-- doc/misc/srecode.texi | 65 +++++++++++++++++++++++++++++----------- info/dir | 1 + 6 files changed, 85 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index 31add2f140e..2540eaee5da 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2012-12-12 Glenn Morris + + * info/dir: Add srecode. + 2012-12-11 Nicolas Richard (tiny change) * Makefile.in (install-info, uninstall): Ensure make's messages 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 @@ +2012-12-12 Glenn Morris + + * srecode.texi: Small edits. Set copyright to FSF, add explicit + GFDL 1.3+ license, fix up index. + * Makefile.in (INFO_TARGETS, DVI_TARGETS, PDF_TARGETS): Add srecode. + (srecode, $(buildinfodir)/srecode$(INFO_EXT), srecode.dvi) + (srecode.pdf): New targets. + * makefile.w32-in (INFO_TARGETS, DVI_TARGETS, clean): Add srecode. + ($(infodir)/srecode$(INFO_EXT), srecode.dvi): New targets. + 2012-12-12 Eric Ludlam * 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 \ flymake forms gnus emacs-gnutls idlwave info.info \ mairix-el message mh-e newsticker nxml-mode \ org pcl-cvs pgg rcirc remember reftex sasl \ - sc semantic ses sieve smtpmail speedbar tramp \ + sc semantic ses sieve smtpmail speedbar srecode tramp \ url vip viper widget woman DVI_TARGETS = \ @@ -95,6 +95,7 @@ DVI_TARGETS = \ sieve.dvi \ smtpmail.dvi \ speedbar.dvi \ + srecode.dvi \ tramp.dvi \ url.dvi \ vip.dvi \ @@ -147,6 +148,7 @@ PDF_TARGETS = \ sieve.pdf \ smtpmail.pdf \ speedbar.pdf \ + srecode.pdf \ tramp.pdf \ url.pdf \ vip.pdf \ @@ -606,6 +608,15 @@ speedbar.dvi: ${srcdir}/speedbar.texi speedbar.pdf: ${srcdir}/speedbar.texi $(ENVADD) $(TEXI2PDF) ${srcdir}/speedbar.texi +srecode : $(buildinfodir)/srecode$(INFO_EXT) +$(buildinfodir)/srecode$(INFO_EXT): ${srcdir}/srecode.texi + $(mkinfodir) + $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ ${srcdir}/srecode.texi +srecode.dvi: ${srcdir}/srecode.texi + $(ENVADD) $(TEXI2DVI) ${srcdir}/srecode.texi +srecode.pdf: ${srcdir}/srecode.texi + $(ENVADD) $(TEXI2PDF) ${srcdir}/srecode.texi + tramp : $(buildinfodir)/tramp$(INFO_EXT) $(buildinfodir)/tramp$(INFO_EXT): ${srcdir}/tramp.texi ${srcdir}/trampver.texi $(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) \ $(infodir)/remember$(INFO_EXT) $(infodir)/nxml-mode$(INFO_EXT) \ $(infodir)/epa$(INFO_EXT) $(infodir)/mairix-el$(INFO_EXT) $(infodir)/sasl$(INFO_EXT) \ $(infodir)/auth$(INFO_EXT) $(infodir)/eieio$(INFO_EXT) $(infodir)/ede$(INFO_EXT) \ - $(infodir)/semantic$(INFO_EXT) $(infodir)/edt$(INFO_EXT) $(infodir)/emacs-gnutls$(INFO_EXT) + $(infodir)/semantic$(INFO_EXT) $(infodir)/edt$(INFO_EXT) $(infodir)/emacs-gnutls$(INFO_EXT) \ + $(infodir)/srecode$(INFO_EXT) DVI_TARGETS = calc.dvi cc-mode.dvi cl.dvi dbus.dvi dired-x.dvi \ ediff.dvi forms.dvi gnus.dvi message.dvi emacs-mime.dvi \ 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 \ newsticker.dvi rcirc.dvi erc.dvi ert.dvi \ remember.dvi nxml-mode.dvi \ epa.dvi mairix-el.dvi sasl.dvi auth.dvi eieio.dvi ede.dvi \ - semantic.dvi edt.dvi emacs-gnutls.dvi + semantic.dvi edt.dvi emacs-gnutls.dvi srecode.dvi INFOSOURCES = info.texi # 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 emacs-gnutls.dvi: emacs-gnutls.texi doclicense.texi $(ENVADD) $(TEXI2DVI) $(srcdir)/emacs-gnutls.texi +$(infodir)/srecode$(INFO_EXT): srecode.texi doclicense.texi + $(MAKEINFO) $(MAKEINFO_OPTS) $(INFO_OPTS) -o $@ srecode.texi +srecode.dvi: srecode.texi doclicense.texi + $(ENVADD) $(TEXI2DVI) $(srcdir)/srecode.texi + mostlyclean: - $(DEL) *.log *.cp *.fn *.ky *.pg *.vr core *.tp *.core gnustmp.* @@ -385,7 +391,8 @@ clean: mostlyclean $(infodir)/epa* $(infodir)/sasl* \ $(infodir)/mairix-el* $(infodir)/auth* \ $(infodir)/eieio* $(infodir)/ede* \ - $(infodir)/semantic* $(infodir)edt* $(infodir)/emacs-gnutls* + $(infodir)/semantic* $(infodir)edt* \ + $(infodir)/emacs-gnutls* $(infodir)/srecode* distclean: clean - $(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 @@ -\input texinfo @c -*-texinfo-*- -@c -@c $Id: srecode.texi,v 1.24 2010-05-30 20:22:40 scymtym Exp $ -@c +\input texinfo @c %**start of header -@setfilename srecode.info +@setfilename ../../info/srecode @set TITLE SRecoder Manual @set AUTHOR Eric M. Ludlam @settitle @value{TITLE} + +@c Merge all indexes into a single index for now. +@c We can always separate them later into two or more as needed. +@syncodeindex vr cp +@syncodeindex fn cp +@syncodeindex ky cp +@syncodeindex pg cp +@syncodeindex tp cp @c %**end of header -@ifinfo -@dircategory Emacs -@format -START-INFO-DIR-ENTRY -* srecode: (srecode). Template code generator -END-INFO-DIR-ENTRY -@end format -@end ifinfo +@copying +Copyright @copyright{} 2007-2012 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. + +(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and +modify this GNU manual. Buying copies from the FSF supports it in +developing GNU and promoting software freedom.'' +@end quotation +@end copying + +@dircategory Emacs misc features +@direntry +* SRecode: (srecode). Template code generator. +@end direntry @titlepage @sp 10 -@center @titlefont{srecode} +@center @titlefont{SRecode} @vskip 0pt plus 1 fill -Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Eric M. Ludlam +@center by @value{AUTHOR} @end titlepage @macro semantic{} -@i{semantic} +@i{Semantic} @end macro @macro EIEIO{} @@ -55,6 +73,10 @@ someone can write a complex code generator, and the underlying template commonality allows it to work in multiple languages with ease. +@ifnottex +@insertcopying +@end ifnottex + @menu * Quick Start:: Basic Setup for template insertion. * User Templates:: Custom User Templates @@ -66,6 +88,7 @@ ease. * Template Naming Conventions:: Creating a set of core templates * Inserting Tag Lists:: Inserting Semantic tags via templates * Application Writing:: Writing an @srecode{}r application +* GNU Free Documentation License:: The license for this documentation. * Index:: @end menu @@ -1759,10 +1782,18 @@ all template files for that application will be loaded. todo - Add examples. Most core stuff is already described above. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Index -@chapter Index +@unnumbered Index +@printindex cp +@iftex @contents +@summarycontents +@end iftex @bye diff --git a/info/dir b/info/dir index cf039593d52..ef232145f3d 100644 --- a/info/dir +++ b/info/dir @@ -81,6 +81,7 @@ Emacs misc features * Semantic: (semantic). Source code parser library and utilities. * SES: (ses). Simple Emacs Spreadsheet. * Speedbar: (speedbar). File/Tag summarizing utility. +* SRecode: (srecode). Template code generator. * VIP: (vip). An older VI-emulation for Emacs. * VIPER: (viper). A VI-emulation mode for Emacs. * WoMan: (woman). Browse UN*X Manual Pages "W.O. (without) Man".