Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update repo structure to non gnu elpa compat #21

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,3 @@
# in git and shouldn't be committed directly.
AUTHORS.md
NEWS.md

aclocal.m4
autom4te.cache/*
c/.deps/*
c/doxymacs_parser
c/doxymacs_parser.o
c/Makefile
c/Makefile.in
config.log
config.status
configure
depcomp
install-sh
lisp/doxymacs.el
lisp/doxymacs.elc
lisp/elc-stamp
lisp/Makefile
lisp/Makefile.in
lisp/xml-parse.elc
Makefile
Makefile.in
missing
no-autoconf/Makefile
no-autoconf/Makefile.in
54 changes: 21 additions & 33 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
$Id: INSTALL,v 1.15 2003/01/26 01:49:55 ryants Exp $
$Id: INSTALL,v 1.16 2023/10/24 22:08:30 L0ren2 Exp $

Doxymacs depends on the following packages:

Expand All @@ -8,46 +8,35 @@ Doxymacs depends on the following packages:

Be sure these are properly configured and installed before proceeding.

- Use the configure script to configure doxymacs:
- The project can be used as is, but you can use the Makefile provided
to compile the *.el files into *.elc and the doxymacs_parser.c into a
binary executable.

$ ./configure
$ make
$ make install
To use as is, execute:
$ make install
To compile only the doxymacs_parser.c, execute:
$ make c
To compile only the emacs lisp files, execute:
$ make elisp
And finally to build all, you can either execute:
$ make
or
$ make all

Use ./configure --help for help on customising your configuration.
After building, you may install using
$ make install

If you get
There also exists
$ make clean
which removes built files to clean the repository.

!! File error (("Cannot open load file" "url"))

(or something similar) then set the variable EMACSLOADPATH before
doing make:

$ EMACSLOADPATH=... make

where ... is a colon separated list of directories to search for
packages. To byte compile with XEmacs, set the variable EMACS:

$ EMACS=xemacs make

If you would rather not byte compile the .el files at all, then do:

$ make ELCFILES=
$ make install ELCFILES=

If you do not want to run or cannot run configure then some pre-baked
.el files are available in the no-autoconf/ directory; simply copy
these to somewhere in your load-path.

- Customise the variable doxymacs-doxygen-dirs.
Doxymacs customisation can be done from the Options | Customize menu,
under Emacs | Programming | Tools | Doxymacs.
Building for XEmacs using this Makefile has not been tested.

- If your tags file is quite large (say, > 1 MB), consider setting
doxymacs-use-external-xml-parser to t and be sure to set
doxymacs-external-xml-parser-executable to the right value (the
default should usually be fine). A suitable program is distributed
in the directory doxymacs/c/. With an 11 MB XML tag file, the
in the directory doxymacs. With an 11 MB XML tag file, the
internal process takes 20 minutes on a PIII 800 with 1 GB of RAM,
whereas the external process takes 12 seconds.

Expand Down Expand Up @@ -81,4 +70,3 @@ Be sure these are properly configured and installed before proceeding.
- C-c d m will insert a blank multi-line Doxygen comment.
- C-c d s will insert a blank single-line Doxygen comment.
- C-c d @ will insert grouping comments around the current region.

20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.PHONY: all elisp c clean

EMACS := /usr/bin/emacs
ELISP := doxymacs.el xml-parse.el

CC := /usr/bin/gcc
INC := /usr/include/libxml2
LNK := /usr/local/lib

all: elisp c
@#
elisp: clean $(ELISP)
$(EMACS) --batch -Q -L . -f batch-byte-compile $(ELISP)
c: doxymacs_parser.c
$(CC) -I$(INC) -L$(LNK) -o doxymacs_parser $< -lxml2
clean:
rm -f *~
rm -f \#*\#
rm -f *.elc
rm -f doxymacs_parser
4 changes: 0 additions & 4 deletions Makefile.am

This file was deleted.

11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,4 @@ Doxymacs depends on the following packages:
- libxml2 http://www.libxml.org/

Be sure these are properly configured and installed before proceeding.

- Use the configure script to configure doxymacs:

$ ./configure
$ make
$ make install

Use ./configure --help for help on customising your configuration.

for details see [INSTALL](INSTALL)
For installation instructions, see [INSTALL](INSTALL)
188 changes: 0 additions & 188 deletions aclocal/libxml.m4

This file was deleted.

5 changes: 0 additions & 5 deletions bootstrap

This file was deleted.

12 changes: 0 additions & 12 deletions c/Makefile.am

This file was deleted.

Loading