← Back to team overview

ert-devs team mailing list archive

ERT Manual and installation procedures

 

I've pushed out a rather-more-finished copy of the manual; at this point
I'm pretty happy with where things are. I will probably revisit it once
I finish up adding more high-level predicates from mode-unit, but for
now it's pretty much done. So it would be great if folks could look over
it and let me know what they think. Once again, this is in the "manual"
branch on my github repo.

Also, there's the matter of how to install the manual. Unfortunately
this requires root permissions, so it's not really a simple task. For
magit, which is a similar project, they bundle a Makefile which handles
the installation in to site-lisp along with the documentation
installation.

But I really don't like the idea of writing a Makefile, so I would
rather not do that. Rinari includes a Rakefile, which is written in
Ruby. That's much more pleasant to write, but it won't work without ruby
installed, so I think that rules it out. Maybe we could just write the
installation script as a series of elisp functions, so it could be
installed by running "emacs -l install.el"? That would be a bit
unconventional, but it would do the trick. Perhaps we could even load it
in an eval-when-compile form in ert.el, though the fact that it would
have to ask for a password would be annoying.

Lastly, makeinfo can compile a nice HTML manual. But I don't know where
we would post this, since ERT doesn't have a web site apart from the
EmacsWiki entry.

Thoughts?

-Phil