doc: set new doc as standard documentation

.gitignore

@@ -3,7 +3,7 @@
 .*.swp
 \#*
 
-build
+/build
 cov-int
 
 *.data
@@ -51,18 +51,9 @@ regressions/eformat-tests/*.txt
 *.cp*
 *.fn*
 *.log
-/src/doc/new-doc/*.lsp*
 *.toc
 *.tp*
 *.vr*
-/src/doc/new-doc/new-doc.pdf
-/src/doc/new-doc/ecldoc.info*
-/src/doc/new-doc/new-doc.ex
-/src/doc/new-doc/new-doc.exs
-/src/doc/new-doc/new-doc.ft
-/src/doc/new-doc/new-doc.fts
-/src/doc/new-doc/new-doc.cf
-/src/doc/new-doc/new-doc.cfs
 /examples/ecl_qt/qt/ecl_qtdemo
 /examples/ecl_qt/hello-lisp-system--all-systems.fasb
 /examples/ecl_qt/lisp-envi.a
@@ -97,7 +88,6 @@ regressions/eformat-tests/*.txt
 /msvc/rt.asd
 /msvc/sb-bsd-sockets.asd
 /msvc/sockets.asd
-doc/tmp/
 /src/tests/aux-compiler.0058-coerce.lsp
 /publications/
 /src/cmp/notes.md

Makefile.in

@@ -2,7 +2,7 @@
 # DIST: make most of the changes to this file you might want, so try
 # DIST: that first.
 
-# make all	to compile and build Emacs.
+# make all	to compile and build ECL.
 # make install	to install it.
 # make TAGS	to update tags tables.
 #
@@ -51,13 +51,6 @@ infodir=@infodir@
 mandir=@mandir@
 libdir=@libdir@
 
-#  What to release
-TAR_CONTENTS=Makefile.in README.md LGPL ANNOUNCEMENT LICENSE doc \
-	configure src/c src/cmp src/clos src/CHANGELOG src/lsp src/doc \
-	src/h  src/gmp src/config* src/install.sh src/Makefile.in \
-	src/util contrib/ src/gc src/*.in src/*.m4 src/gabriel \
-	src/tests/Makefile.in msvc examples
-
 # ==================== Utility Programs for the Build ====================
 
 #  Allow the user to specify the install program.
@@ -126,11 +119,9 @@ check:
 
 TAR_DIR=ecl-$(VERSION)
 
-doc: build/doc/index.html
+doc:
-	-mkdir doc
+	$(MAKE) -C build/doc
-	(cd build/doc; make html); cp build/doc/*.html doc
+.PHONY: doc
-build/doc/index.html:
-	cd build/doc; $(MAKE)
 
 source-dist: $(TAR_DIR).tgz
 

src/Makefile.in

@@ -2,7 +2,7 @@
 # vim: set filetype=makefile tabstop=8 shiftwidth=4 expandtab:
 
 #
-# Makefile for ECoLisp
+# Makefile for ECL
 #
 top_srcdir= @top_srcdir@
 srcdir	= @srcdir@
@@ -238,9 +238,7 @@ install:
 	for i in LICENSE COPYING; do \
 	  $(INSTALL_DATA) $(top_srcdir)/../$$i $(DESTDIR)$(ecldir); \
 	done
-	$(mkinstalldirs) $(DESTDIR)$(mandir)/man$(manext)
+	$(MAKE) -C doc install
-	$(INSTALL_DATA) doc/ecl.man $(DESTDIR)$(mandir)/man$(manext)/ecl.$(manext)
-	$(INSTALL_DATA) doc/ecl-config.man $(DESTDIR)$(mandir)/man$(manext)/ecl-config.$(manext)
 
 flatinstall: build-stamp
 	$(MAKE) DESTDIR=$(DESTDIR) bindir=$(prefix) libdir=$(prefix) \
@@ -252,8 +250,7 @@ uninstall:
 			@SONAME@ @SONAME1@ @SONAME2@ @SONAME3@; do \
 	  $(RM) $(DESTDIR)$(libdir)/$$i || : ; \
 	done
-	$(RM) $(DESTDIR)$(mandir)/man$(manext)/ecl.$(manext)
+	$(MAKE) -C doc uninstall
-	$(RM) $(DESTDIR)$(mandir)/man$(manext)/ecl-config.$(manext)
 	$(RM) -r $(DESTDIR)$(includedir)/ecl $(DESTDIR)$(ecldir)
 
 clean: mostlyclean

src/configure

@@ -737,7 +737,6 @@ infodir
 docdir
 oldincludedir
 includedir
-runstatedir
 localstatedir
 sharedstatedir
 sysconfdir
@@ -864,7 +863,6 @@ datadir='${datarootdir}'
 sysconfdir='${prefix}/etc'
 sharedstatedir='${prefix}/com'
 localstatedir='${prefix}/var'
-runstatedir='${localstatedir}/run'
 includedir='${prefix}/include'
 oldincludedir='/usr/include'
 docdir='${datarootdir}/doc/${PACKAGE_TARNAME}'
@@ -1117,15 +1115,6 @@ do
   | -silent | --silent | --silen | --sile | --sil)
     silent=yes ;;
 
-  -runstatedir | --runstatedir | --runstatedi | --runstated \
-  | --runstate | --runstat | --runsta | --runst | --runs \
-  | --run | --ru | --r)
-    ac_prev=runstatedir ;;
-  -runstatedir=* | --runstatedir=* | --runstatedi=* | --runstated=* \
-  | --runstate=* | --runstat=* | --runsta=* | --runst=* | --runs=* \
-  | --run=* | --ru=* | --r=*)
-    runstatedir=$ac_optarg ;;
-
   -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb)
     ac_prev=sbindir ;;
   -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \
@@ -1263,7 +1252,7 @@ fi
 for ac_var in	exec_prefix prefix bindir sbindir libexecdir datarootdir \
 		datadir sysconfdir sharedstatedir localstatedir includedir \
 		oldincludedir docdir infodir htmldir dvidir pdfdir psdir \
-		libdir localedir mandir runstatedir
+		libdir localedir mandir
 do
   eval ac_val=\$$ac_var
   # Remove trailing slashes.
@@ -1416,7 +1405,6 @@ Fine tuning of the installation directories:
   --sysconfdir=DIR        read-only single-machine data [PREFIX/etc]
   --sharedstatedir=DIR    modifiable architecture-independent data [PREFIX/com]
   --localstatedir=DIR     modifiable single-machine data [PREFIX/var]
-  --runstatedir=DIR       modifiable per-process data [LOCALSTATEDIR/run]
   --libdir=DIR            object code libraries [EPREFIX/lib]
   --includedir=DIR        C header files [PREFIX/include]
   --oldincludedir=DIR     C header files for non-gcc [/usr/include]
@@ -3020,8 +3008,8 @@ boehm_configure_flags=""
 
 
 					                                                                                                                  TARGETS='bin/ecl$(EXE)'
-SUBDIRS=c
+SUBDIRS='c doc'
-                            LSP_FEATURES='*features*'
+                          LSP_FEATURES='*features*'
 
 
 # Make sure we can run config.sub.

src/configure.ac

@@ -321,7 +321,7 @@ AC_SUBST(SHARED_LDFLAGS)        dnl Flags for shared libraries linker
 AC_SUBST(BUNDLE_LDFLAGS)        dnl Flags for FASL files linker
 AC_SUBST(EXTRA_OBJS)            dnl Extra *.o files to be compiled into libecl.a
 AC_SUBST(TARGETS, ['bin/ecl$(EXE)'])dnl Versions of ECL to be built 
-AC_SUBST(SUBDIRS, [c])          dnl Subdirectories that make should process
+AC_SUBST(SUBDIRS, ['c doc'])        dnl Subdirectories that make should process
 AC_SUBST(LIBRARIES, [])         dnl GMP, Boehm's GC, etc
 AC_SUBST(LSP_LIBRARIES)         dnl Libraries produced by lisp translator
 AC_SUBST(LSP_FEATURES, ['*features*']) dnl Symbols to add to *FEATURES* for conditional compilation

src/doc/Makefile.in

@@ -16,127 +16,35 @@ INSTALL_PROGRAM = @INSTALL_PROGRAM@
 INSTALL_DATA = @INSTALL_DATA@
 INSTALL_INFO = @INSTALL_INFO@
 mkinstalldirs = $(top_srcdir)/bdwgc/install-sh -d
-INFO_FILES = ecl.$(INFOEXT) ecldev.$(INFOEXT)
+INFO_FILE = ecl.$(INFOEXT)
-HTML_FILES = index.html license.html lgpl.html news.html benchmark.html \
-	install.html download.html cvs.html
 
 VERSION=@PACKAGE_VERSION@
 
-FILTER = sed 's,@VERSION@,$(VERSION),g'
+all: manual
+	$(MAKE) -C manual
 
-ECL = ../ecl
+manual:
+	cp -r $(srcdir)/manual .
 
-all: $(INFO_FILES)
+install: install-manual
-
-html: $(HTML_FILES)
-
-ecl.dvi: $(srcdir)/user.txi $(srcdir)/macros.txi clisp.sty ecl.sty
-	tex $(srcdir)/user.txi
-ecldev.dvi: $(srcdir)/devel.txi $(srcdir)/macros.txi clisp.sty ecl.sty
-	tex $(srcdir)/devel.txi
-
-ecl.ps: ecl.dvi $(srcdir)/macros.txi
-	dvips -o $@ ecl.dvi
-ecldev.ps: ecldev.dvi $(srcdir)/macros.txi
-	dvips -o $@ ecldev.dvi
-
-install: all
-	$(mkinstalldirs) $(DESTDIR)$(infodir)
-	for k in $(INFO_FILES); do \
-	  $(INSTALL_DATA) $$k $(DESTDIR)$(infodir); \
-	  if [ -x $(INSTALL_INFO) ]; then \
-	    $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) $$k; \
-	  fi; \
-	done
-	$(mkinstalldirs) $(DESTDIR)$(docdir)
-	for i in LICENSE LGPL; do \
-	  $(INSTALL_DATA) $(top_srcdir)/../$$i $(DESTDIR)$(docdir); \
-	done
 	$(mkinstalldirs) $(DESTDIR)$(mandir)/man$(manext)
 	$(INSTALL_DATA) ecl.man $(DESTDIR)$(mandir)/man$(manext)/ecl.$(manext)
 	$(INSTALL_DATA) ecl-config.man $(DESTDIR)$(mandir)/man$(manext)/ecl-config.$(manext)
-flatinstall: all $(HTML_FILES)
-	$(mkinstalldirs) $(DESTDIR)$(docdir)
-	for k in $(INFO_FILES); do $(INSTALL_DATA) $$k $(DESTDIR)$(docdir); done
-	if [ -f user.html ]; then \
-	  $(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/; \
-	else \
-	  $(mkinstalldirs) $(DESTDIR)$(docdir)/ecl; \
-	  for i in ecl/*; do $(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/ecl/; done; \
-	fi
-	if [ -f devel.html ]; then \
-	  $(INSTALL_DATA) devel.html $(DESTDIR)$(docdir)/; \
-	else \
-	  $(mkinstalldirs) $(DESTDIR)$(docdir)/ecldev; \
-	  for i in ecldev/*; do $(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/ecldev/; done; \
-	fi
-	for i in LICENSE LGPL; do \
-	  $(INSTALL_DATA) $(top_srcdir)/../$$i $(DESTDIR)$(docdir); \
-	done
-	for i in *.html; do $(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/; done
 
-uninstall:
+install-manual: manual
-	-for k in $(INFO_FILES); do \
+	$(MAKE) -C manual info
-	  rm $$k; \
+	$(mkinstalldirs) $(DESTDIR)$(infodir)
-	  if [ -x $(INSTALL_INFO) ]; then \
+	gzip < manual/$(INFO_FILE) > manual/$(INFO_FILE).gz
-	    $(INSTALL_INFO) --remove $$k; \
+	$(INSTALL_DATA) manual/$(INFO_FILE).gz $(DESTDIR)$(infodir)
-	  fi; \
+	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) manual/$(INFO_FILE);
-	done
-	rm -r $(DESTDIR)$(infodir)/ecl.$(INFOEXT) $(DESTDIR)$(infodir)/ecldev.$(INFOEXT); \
-	rm $(DESTDIR)$(mandir)/man$(manext)/ecl.$(manext)
 
-head: developers_manual user_manual $(srcdir)/head
+uninstall: uninstall-manual
-	if [ -f ecl/index.html ]; then \
+	$(RM) $(DESTDIR)$(mandir)/man$(manext)/ecl.$(manext)
-	  sed -e 's,ecl/user.html,ecl/index.html,g' \
+	$(RM) $(DESTDIR)$(mandir)/man$(manext)/ecl-config.$(manext)
-	      -e 's,ecldev/devel.html,ecldev/index.html,g' $(srcdir)/head > head; \
+
-	else \
+uninstall-manual:
-	  cp $(srcdir)/head head; \
+	$(RM) $(DESTDIR)$(infodir)/$(INFO_FILE).gz
-	fi
+	$(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) --remove manual/$(INFO_FILE);
-ecl.info.gz: ecl.info
-	gzip < ecl.info > ecl.info.gz
-ecldev.info.gz: ecldev.info
-	gzip < ecldev.info > ecldev.info.gz
-ecl.info: $(srcdir)/user.txi $(srcdir)/macros.txi
-	makeinfo -I $(srcdir) --no-split $(srcdir)/user.txi
-ecldev.info: $(srcdir)/devel.txi $(srcdir)/macros.txi
-	makeinfo -I $(srcdir) --no-split $(srcdir)/devel.txi
 
-download.html: $(srcdir)/download.in.html head
-	cat head $(srcdir)/download.in.html $(srcdir)/end | $(FILTER) > $@
-index.html: $(srcdir)/index.in.html head
-	cat head $(srcdir)/index.in.html $(srcdir)/end | $(FILTER) > $@
-cvs.html: $(srcdir)/cvs.in.html head
-	cat head $(srcdir)/cvs.in.html $(srcdir)/end | $(FILTER) > $@
-install.html: $(srcdir)/install.in.html head
-	cat head $(srcdir)/install.in.html $(srcdir)/end | $(FILTER) > $@
-news.html: head $(srcdir)/../..ANNOUNCEMENT
-	(cat head; echo '<pre>'; cat $(srcdir)/../../ANNOUNCEMENT; echo '</pre>';\
-	 cat $(srcdir)/end) | $(FILTER) > $@
-benchmark.html: $(srcdir)/benchmark.in.html BENCHMARK head
-	(cat head; cat $(srcdir)/benchmark.in.html; \
-	 echo '<pre>'; cat BENCHMARK; echo '</pre>'; \
-	 cat $(srcdir)/end) | $(FILTER) > $@
-BENCHMARK:
-	echo "No benchmarks available" > $@
-license.html: $(top_srcdir)/../Copyright head
-	(cat head; \
-	 echo '<pre>'; cat $(top_srcdir)/../Copyright; echo '</pre>'; \
-	 cat $(srcdir)/end) | $(FILTER) > $@
-lgpl.html: $(top_srcdir)/../LGPL head
-	(cat head; \
-	 echo '<pre>'; cat $(top_srcdir)/../LGPL; echo '</pre>'; \
-	 cat $(srcdir)/end) | $(FILTER) > $@
-user_manual: $(srcdir)/user.txi $(srcdir)/macros.txi
-	echo "Producing ecl.html; ignore error messages."
-	test -d ecl || mkdir ecl; \
-	(makeinfo --output-indent=0 -I $(srcdir) --css-include=$(srcdir)/basic.css --html $(srcdir)/user.txi || \
-	 texi2html -I=$(srcdir) -subdir=ecl -split=chapter $(srcdir)/user.txi)  \
-	&& touch user_manual
-developers_manual: $(srcdir)/devel.txi $(srcdir)/macros.txi
-	echo "Producing ecldev.html; ignore error messages."
-	test -d ecldev || mkdir ecldev; \
-	(makeinfo --output-indent=0 -I $(srcdir) --css-include=$(srcdir)/basic.css --html $(srcdir)/devel.txi || \
-	 texi2html -I=$(srcdir) -subdir=ecldev -split=chapter $(srcdir)/devel.txi) \
-	&& touch developers_manual
 clean:
-	rm -r -f ecl ecldev ecl.info* ecldev.info* *.html user_manual developers_manual
+	$(MAKE) -C manual clean

src/doc/manual/.gitignore

@@ -0,0 +1,27 @@
+*.html
+*.info
+*.info-1
+*.info-2
+*.aux
+*.cf
+*.cfs
+*.cp
+*.cpp
+*.cpps
+*.cps
+*.ex
+*.exs
+*.fn
+*.fns
+*.ft
+*.fts
+*.log
+*.lsp
+*.lsps
+*.toc
+*.tp
+*.tps
+*.vr
+*.vrs
+*.pdf
+html

src/doc/manual/Makefile

@@ -0,0 +1,24 @@
+FILES= *.txi */*.txi figures/*
+
+.PHONY: all pdf info html
+
+all: pdf info html
+
+pdf: manual.pdf
+info: ecl.info
+html: html/index.html
+
+manual.pdf: $(FILES)
+	texi2pdf manual.txi
+
+ecl.info: $(FILES)
+	makeinfo --no-split manual.txi
+
+html/index.html: $(FILES)
+	makeinfo --html --css-include=ecl.css --split=chapter manual.txi
+	rm -rf html
+	mv ecl html
+	cp -r figures html
+
+clean:
+	rm -rf *.{aux,cf,cfs,cp,cpp,cpps,cps,ex,exs,fn,fns,ft,fts,log,lsp,lsps,toc,tp,tps,vr,vrs,pdf,info,info-1,info-2,html} html

src/doc/manual/extensions/cdr-extensions.txi

@@ -0,0 +1,17 @@
+@node CDR Extensions
+@section CDR Extensions
+
+ECL currently implements the following specifications of the
+@url{https://common-lisp.net/project/cdr/, Common Lisp Document
+Repository}:
+
+@float Table, tab:cdr-extensions
+@caption{Implemented CDR extensions}
+@multitable @columnfractions .2 .8
+@headitem Number @tab Comments
+@item 1 @tab In @code{clos} package; partial implementation, @pxref{Meta-Object Protocol (MOP)}
+@item 5 @tab In @code{ext} package
+@item 7 @tab Only if ECL is compiled with @code{--with-cmuformat} configure option
+@item 14 @tab
+@end multitable
+@end float

src/doc/manual/extensions/index.txi

@@ -65,5 +65,4 @@
 @c Package extensions
 @include extensions/packages.txi
 
-@node CDR Extensions
+@include extensions/cdr-extensions.txi
-@section CDR Extensions

src/doc/manual/manual.txi

@@ -1,6 +1,6 @@
 \input texinfo                  @c -*-texinfo-*-
 @c %**start of header
-@setfilename ecldoc.info
+@setfilename ecl.info
 @settitle ECL User's Guide
 @setchapternewpage odd
 @paragraphindent none

src/doc/new-doc/.gitignore

@@ -1 +0,0 @@
-*.html

src/doc/new-doc/Makefile

@@ -1,22 +0,0 @@
-FILES= *.txi */*.txi figures/*
-
-.PHONY: all pdf info html
-
-all: pdf info html
-
-pdf: new-doc.pdf
-info: ecldoc.info
-html: ecldoc
-
-new-doc.pdf: $(FILES)
-	texi2pdf new-doc.txi
-
-ecldoc.info: $(FILES)
-	makeinfo new-doc.txi
-
-ecldoc: $(FILES)
-	makeinfo --html --css-include=ecl.css --split=chapter new-doc.txi
-	cp -r figures ecldoc
-
-clean:
-	rm -rf *.{aux,cf,cfs,cp,cpp,cpps,cps,ex,exs,fn,fns,ft,fts,log,lsp,lsps,toc,tp,tps,vr,vrs,pdf,info,html}