aboutsummaryrefslogtreecommitdiffhomepage
path: root/generic/proof-easy-config.el
diff options
context:
space:
mode:
Diffstat (limited to 'generic/proof-easy-config.el')
-rw-r--r--generic/proof-easy-config.el35
1 files changed, 26 insertions, 9 deletions
diff --git a/generic/proof-easy-config.el b/generic/proof-easy-config.el
index da3b9c7f..4dc2e1d4 100644
--- a/generic/proof-easy-config.el
+++ b/generic/proof-easy-config.el
@@ -1,16 +1,27 @@
-;; proof-easy-config.el Easy configuration for Proof General
-;;
-;; Copyright (C) 1999-2002 David Aspinall / LFCS.
+;;; proof-easy-config.el --- Easy configuration for Proof General
+
+;; This file is part of Proof General.
+
+;; Portions © Copyright 1994-2012 David Aspinall and University of Edinburgh
+;; Portions © Copyright 2003, 2012, 2014 Free Software Foundation, Inc.
+;; Portions © Copyright 2001-2017 Pierre Courtieu
+;; Portions © Copyright 2010, 2016 Erik Martin-Dorel
+;; Portions © Copyright 2011-2013, 2016-2017 Hendrik Tews
+;; Portions © Copyright 2015-2017 Clément Pit-Claudel
+
;; Author: David Aspinall <David.Aspinall@ed.ac.uk>
+
;; License: GPL (GNU GENERAL PUBLIC LICENSE)
-;;
-;; $Id$
+
+;;; Commentary:
;;
;; Future versions might copy settings instead; consider how best to
;; interface with customization mechanism so a new prover can be
;; configured by editing inside custom buffers.
;;
+;;; Code:
+
(require 'proof-site) ; proof-assistant, proof-assistant-symbol
(require 'proof-auxmodes) ; make sure extra modes available
@@ -51,7 +62,8 @@
`(define-derived-mode ,mode ,parent ,modename nil ,@fullbody)))))
(defun proof-easy-config-check-setup (sym name)
- "A number of simple checks."
+ "Perform a number of simple checks.
+The proof assistant is denoted by symbol SYM and string NAME."
(let ((msg ""))
;; At the moment we just check that the symbol/name used
;; in the macro matches that in `proof-assistant-table'
@@ -73,7 +85,7 @@
(not (eq proof-assistant-symbol sym))
(setq msg (format "\nproof-assistant symbol: '%s doesn't match expected '%s"
proof-assistant-symbol sym))))
- (error "proof-easy-config: PG already in use or name/symbol mismatch %s"
+ (error "Macro proof-easy-config: PG already in use or name/symbol mismatch %s"
msg))
(t
;; Setting these here is nice for testing: no need to get
@@ -83,9 +95,10 @@
;;;###autoload
(defmacro proof-easy-config (sym name &rest body)
- "Configure Proof General for proof-assistant using BODY as a setq body.
+ "Configure Proof General for a given proof assistant.
The symbol SYM and string name NAME must match those given in
-the `proof-assistant-table', which see."
+ the `proof-assistant-table', which see.
+Additional arguments are taken into account as a setq BODY."
`(progn
(proof-easy-config-check-setup ,sym ,name)
(setq
@@ -94,3 +107,7 @@ the `proof-assistant-table', which see."
;;
(provide 'proof-easy-config)
+
+(provide 'proof-easy-config)
+
+;;; proof-easy-config.el ends here