Skip to content

Commit 771cab4

Browse files
committed
Update the documentation and prepare the release 4.4.
1 parent 658fc48 commit 771cab4

File tree

9 files changed

+76
-68
lines changed

9 files changed

+76
-68
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Proof General is a generic Emacs interface for proof assistants.
66
The aim of the Proof General project is to provide a powerful, generic
77
environment for using interactive proof assistants.
88

9-
This is version 4.4pre of Proof General.
9+
This is version 4.4 of Proof General.
1010

1111
## Setup
1212

@@ -43,7 +43,7 @@ See:
4343

4444
Links:
4545

46-
* [https://proofgeneral.github.io/doc](https://proofgeneral.github.io/doc/) for online documentation of Proof General
46+
* [https://proofgeneral.github.io/doc](https://proofgeneral.github.io/doc) for online documentation of Proof General
4747
* [http://proofgeneral.inf.ed.ac.uk/mailinglist](http://proofgeneral.inf.ed.ac.uk/mailinglist) for mailing list information
4848

4949
Supported proof assistants:

acl2/acl2.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@
9292

9393

9494
(warn "ACL2 Proof General is incomplete! Please help improve it!
95-
Please add improvements at http://proofgeneral.inf.ed.ac.uk/trac")
95+
Please add improvements at https://github.com/ProofGeneral/PG")
9696

9797
(provide 'acl2)

doc/PG-adapting.texi

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
@c FIXME: unfortunately, broken in buggy pdftexinfo.
2222
@c so removed for now.
2323
@set URLisamode http://homepages.inf.ed.ac.uk/da/isamode
24-
@set URLpghome http://proofgeneral.inf.ed.ac.uk
24+
@set URLpghome https://proofgeneral.github.io
2525
@set URLpglatestrpm http://proofgeneral.inf.ed.ac.uk/releases/ProofGeneral-latest.noarch.rpm
2626
@set URLpglatesttar http://proofgeneral.inf.ed.ac.uk/releases/ProofGeneral-latest.tar.gz
2727
@set URLpglatestdev http://proofgeneral.inf.ed.ac.uk/releases/ProofGeneral-devel-latest.tar.gz
@@ -51,9 +51,9 @@
5151
@c @ref{node} without "see". Careful for info.
5252

5353

54-
@set version 4.3pre
54+
@set version 4.4
5555
@set emacsversion 24.4
56-
@set last-update April 2015
56+
@set last-update September 2016
5757
@set rcsid $Id$
5858

5959
@dircategory Theorem proving
@@ -84,7 +84,7 @@ END-INFO-DIR-ENTRY
8484
@sp 1
8585
@subtitle Adapting Proof General @value{version} to new provers
8686
@subtitle @value{last-update}
87-
@subtitle @b{proofgeneral.inf.ed.ac.uk}
87+
@subtitle @b{proofgeneral.github.io}
8888

8989
@iftex
9090
@vskip 1cm
@@ -122,7 +122,7 @@ more details.
122122

123123
@sp 1
124124

125-
Visit Proof General on the web at @code{http://proofgeneral.inf.ed.ac.uk}
125+
Visit Proof General on the web at @code{https://proofgeneral.github.io}
126126

127127
@c (commented; dates from CVS) Version control: @code{@value{rcsid}}
128128
@end titlepage
@@ -200,7 +200,7 @@ development method: if you require changes in the generic support,
200200
please contact us (or make adjustments yourself and send them to us).
201201

202202
Proof General has a home page at
203-
@uref{http://proofgeneral.inf.ed.ac.uk}. Visit this page
203+
@uref{https://proofgeneral.github.io}. Visit this page
204204
for the latest version of the manuals, other documentation, system
205205
downloads, etc.
206206

@@ -1264,7 +1264,7 @@ Completion is activated with M-x complete.
12641264

12651265
If this table is empty or needs adjusting, please make changes using
12661266
@samp{@code{customize-variable}} and post suggestions at
1267-
http://proofgeneral.inf.ed.ac.uk/trac
1267+
https://github.com/ProofGeneral/PG/issues
12681268
@end defvar
12691269

12701270
@c TEXI DOCSTRING MAGIC: proof-add-completions
@@ -2031,7 +2031,7 @@ symbol is @code{'systemspecific}.
20312031

20322032
The goals buffer settings allow configuration of Proof General for proof
20332033
by pointing or similar features.
2034-
See the Proof General @uref{http://proofgeneral.inf.ed.ac.uk/doc, documentation web page}
2034+
See the Proof General @uref{https://proofgeneral.github.io/doc, documentation web page}
20352035
for a link to the technical report ECS-LFCS-97-368 which hints
20362036
at how to use these settings.
20372037

@@ -2141,7 +2141,7 @@ Proof General name used internally and in menu titles.
21412141
@defopt proof-general-home-page
21422142
Web address for Proof General.
21432143

2144-
The default value is @code{"http://proofgeneral.inf.ed.ac.uk"}.
2144+
The default value is @code{"https://proofgeneral.github.io"}.
21452145
@end defopt
21462146
@c TEXI DOCSTRING MAGIC: proof-universal-keys
21472147
@defvar proof-universal-keys

doc/ProofGeneral.texi

Lines changed: 58 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
@c so removed for now.
2525
@set URLxsymbol http://x-symbol.sourceforge.net
2626
@set URLisamode http://proofgeneral.inf.ed.ac.uk/~isamode
27-
@set URLpghome http://proofgeneral.inf.ed.ac.uk
27+
@set URLpghome https://proofgeneral.github.io
2828
@set URLpglatestrpm http://proofgeneral.inf.ed.ac.uk/ProofGeneral-latest.noarch.rpm
2929
@set URLpglatesttar http://proofgeneral.inf.ed.ac.uk/ProofGeneral-latest.tar.gz
3030
@set URLpglatestdev http://proofgeneral.inf.ed.ac.uk/ProofGeneral-devel-latest.tar.gz
@@ -57,9 +57,9 @@
5757
@c @ref{node} without "see". Careful for info.
5858
@c
5959

60-
@set version 4.3pre
60+
@set version 4.4
6161
@set emacsversion 24.4
62-
@set last-update April 2015
62+
@set last-update September 2016
6363
@set rcsid $Id$
6464

6565
@dircategory Theorem proving
@@ -89,14 +89,14 @@
8989
@sp 1
9090
@subtitle User Manual for Proof General @value{version}
9191
@subtitle @value{last-update}
92-
@subtitle @b{proofgeneral.inf.ed.ac.uk}
92+
@subtitle @b{proofgeneral.github.io}
9393

9494
@iftex
9595
@vskip 1cm
9696
@image{ProofGeneral-image}
9797
@end iftex
98-
@author David Aspinall and Thomas Kleymann
99-
@author with P. Courtieu, H. Goguen, D. Sequeira, M. Wenzel.
98+
@author D. Aspinall, P. Courtieu, E. Martin-Dorel, C. Pit--Claudel,
99+
@author T. Kleymann, H. Goguen, D. Sequeira, M. Wenzel
100100
@page
101101
@vskip 0pt plus 1filll
102102
This manual and the program Proof General are
@@ -126,7 +126,7 @@ please check the accompanying file @file{COPYING} for more details.
126126

127127
@sp 1
128128

129-
Visit Proof General on the web at @code{http://proofgeneral.inf.ed.ac.uk}
129+
Visit Proof General on the web at @code{https://proofgeneral.github.io}
130130

131131
@sp 1
132132

@@ -188,12 +188,13 @@ news about previous releases, and notes on the development
188188
of Proof General.
189189

190190
Proof General has a home page at
191-
@uref{http://proofgeneral.inf.ed.ac.uk}.
191+
@uref{https://proofgeneral.github.io}.
192192
Visit this page for the latest version of this manual,
193193
other documentation, system downloads, etc.
194194

195195

196196
@menu
197+
* News for Version 4.4::
197198
* News for Version 4.3::
198199
* News for Version 4.2::
199200
* News for Version 4.1::
@@ -202,6 +203,16 @@ other documentation, system downloads, etc.
202203
* Credits::
203204
@end menu
204205

206+
@node News for Version 4.4
207+
@unnumberedsec News for Version 4.4
208+
@cindex news
209+
210+
Proof General 4.4 is the first release since PG has moved to
211+
@uref{https://github.com/ProofGeneral/PG, GitHub}.
212+
213+
This release contains several bugfixes and improvements (see the Git
214+
ChangeLog for more details) and supports both Coq 8.4 and Coq 8.5.
215+
205216
@node News for Version 4.3
206217
@unnumberedsec News for Version 4.3
207218
@cindex news
@@ -355,6 +366,10 @@ for patches and suggestions, to Makarius for many bug reports and help
355366
with Isabelle support and to Pierre Courtieu for providing new
356367
features for Coq support.
357368

369+
Between Proof General 4.3 and 4.4 releases, the PG sources have been
370+
migrated from CVS to to GitHub; special thanks go to Clement
371+
Pit--Claudel for help in this migration.
372+
358373
Proof General 4.4's new icons were contributed by Yoshihiro Imai
359374
(@uref{http://proofcafe.org/wiki/Generaltan}) under CC-BY-SA 3.0
360375
(@uref{https://creativecommons.org/licenses/by-sa/3.0/})
@@ -392,6 +407,7 @@ Assia Mahboubi,
392407
Adam Megacz,
393408
Stefan Monnier,
394409
Tobias Nipkow,
410+
Clement Pit--Claudel,
395411
Leonor Prensa Nieto,
396412
David von Oheimb,
397413
Lawrence Paulson,
@@ -451,7 +467,7 @@ Please help us!
451467

452468
Send us comments, suggestsions, or (the best) patches to improve support
453469
for your chosen proof assistant. Contact us at
454-
@uref{http://proofgeneral.inf.ed.ac.uk/trac}.
470+
@uref{https://github.com/ProofGeneral/PG/issues}.
455471

456472
If your chosen proof assistant isn't supported, read the accompanying
457473
@i{Adapting Proof General} manual to find out how to configure PG for a
@@ -2899,7 +2915,7 @@ Completion is activated with M-x complete.
28992915

29002916
If this table is empty or needs adjusting, please make changes using
29012917
@samp{@code{customize-variable}} and post suggestions at
2902-
http://proofgeneral.inf.ed.ac.uk/trac
2918+
https://github.com/ProofGeneral/PG/issues
29032919
@end defvar
29042920

29052921
The completion facility uses a library @file{completion.el} which
@@ -4028,10 +4044,10 @@ when a file is loaded. File variables and their values
40284044
are written as a list at the end of
40294045
the file.
40304046

4031-
@emph{Remark 1:} The examples in the following are for Coq but the
4047+
@b{Remark 1:} The examples in the following are for Coq but the
40324048
trick is applicable to other provers.
40334049

4034-
@emph{Remark 2:} For Coq specifically, there is a recommended other way
4050+
@b{Remark 2:} For Coq specifically, there is a recommended other way
40354051
of configuring Coq options:
40364052
project files (@ref{Using the Coq project file}).
40374053
Actually, project files are intended to be included in the
@@ -5436,12 +5452,12 @@ model checking crew).
54365452
@appendix Obtaining and Installing
54375453

54385454
Proof General has its own
5439-
@uref{http://proofgeneral.inf.ed.ac.uk,home page} hosted at
5440-
Edinburgh. Visit this page for the latest news!
5455+
@uref{https://proofgeneral.github.io,home page} hosted at
5456+
GitHub. Visit this page for the latest news!
54415457

54425458
@menu
54435459
* Obtaining Proof General::
5444-
* Installing Proof General from tarball::
5460+
* Installing Proof General from sources::
54455461
* Setting the names of binaries::
54465462
* Notes for syssies::
54475463
@end menu
@@ -5452,55 +5468,46 @@ Edinburgh. Visit this page for the latest news!
54525468

54535469
You can obtain Proof General from the URL
54545470
@example
5455-
@uref{http://proofgeneral.inf.ed.ac.uk}.
5471+
@uref{https://github.com/ProofGeneral/PG}.
54565472
@end example
54575473

5458-
The distribution is available in as a tarball. It may be
5459-
redistributed by third party packagers in other forms.
5460-
5461-
Two versions are available:
5462-
@itemize @bullet
5463-
@item The current stable version, @*
5464-
@uref{http://proofgeneral.inf.ed.ac.uk/ProofGeneral-stable.tgz}
5465-
@item The latest development version, @*
5466-
@uref{http://proofgeneral.inf.ed.ac.uk/ProofGeneral-latest.tgz}
5467-
@end itemize
5474+
The distribution is available in the master branch of the repository.
5475+
Tagged versions of the sources may be redistributed by third party
5476+
packagers in other forms.
54685477

5469-
The source tarball includes the generic elisp code, and code for LEGO,
5470-
Coq, Isabelle, and other provers. Also included are installation
5478+
The sources includes the generic elisp code, and code for Coq, LEGO,
5479+
Isabelle, and other provers. Also included are installation
54715480
instructions (reproduced in brief below) and this documentation.
54725481

5473-
For access to the source code repository, please see the
5474-
Proof General web page @uref{http://proofgeneral.inf.ed.ac.uk/devel}.
5482+
@node Installing Proof General from sources
5483+
@section Installing Proof General from sources
54755484

5476-
@node Installing Proof General from tarball
5477-
@section Installing Proof General from tarball
5478-
5479-
Copy the distribution to some directory @var{mydir}.
5480-
Unpack it there. For example:
5485+
Remove old versions of Proof General, then download and install the new
5486+
release from GitHub:
54815487
@example
5482-
# cd @var{mydir}
5483-
# tar -xpzf ProofGeneral-@var{version}.tgz
5488+
$ git clone https://github.com/ProofGeneral/PG ~/.emacs.d/lisp/PG
5489+
$ cd ~/.emacs.d/lisp/PG
5490+
$ make
54845491
@end example
5485-
If you downloaded the version called @var{latest}, you'll find it
5486-
unpacks to a numeric version number.
54875492

5488-
Proof General will now be in some subdirectory of @var{mydir}. The name
5489-
of the subdirectory will depend on the version number of Proof General.
5490-
For example, it might be @file{ProofGeneral-4.0}. It's convenient to
5491-
link it to a fixed name:
5492-
@example
5493-
# ln -sf ProofGeneral-4.0 ProofGeneral
5494-
@end example
5495-
Now put this line in your @file{.emacs} file:
5493+
Then add the following to your @file{.emacs}:
54965494
@lisp
5497-
(load-file "@var{mydir}/ProofGeneral/generic/proof-site.el")
5495+
;; Open .v files with Proof General's Coq mode
5496+
(load "~/.emacs.d/lisp/PG/generic/proof-site")
54985497
@end lisp
54995498

5499+
If Proof General complains about a version mismatch, make sure that the
5500+
shell's @code{emacs} is indeed your usual Emacs. If not, run the Makefile
5501+
again with an explicit path to Emacs. On Mac in particular you'll
5502+
probably need something like
5503+
@example
5504+
make clean; make EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs
5505+
@end example
5506+
55005507
@node Setting the names of binaries
55015508
@section Setting the names of binaries
55025509

5503-
The @code{load-file} command you have added will load @file{proof-site}
5510+
The @code{load} command you have added will load @file{proof-site}
55045511
which sets the Emacs load path for Proof General and add auto-loads and
55055512
modes for the supported assistants.
55065513

@@ -5522,7 +5529,8 @@ If you do not want to use customize, simply add a line like this:
55225529
(setq coq-prog-name "/usr/bin/coqtop -emacs")
55235530
@end lisp
55245531
to your @file{.emacs} file.
5525-
5532+
For more advice on how to customize the @code{coq-prog-name} variable,
5533+
@pxref{Using file variables}, Remark 2.
55265534

55275535

55285536
@node Notes for syssies

etc/ProofGeneral.spec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Summary: Proof General, Emacs interface for Proof Assistants
22
Name: ProofGeneral
3-
Version: 4.4pre
3+
Version: 4.4
44
Release: 1
55
Group: Text Editors/Integrated Development Environments (IDE)
66
License: GPL

generic/pg-custom.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Completion is activated with \\[complete].
150150
151151
If this table is empty or needs adjusting, please make changes using
152152
`customize-variable' and post suggestions at
153-
http://proofgeneral.inf.ed.ac.uk/trac"
153+
https://github.com/ProofGeneral/PG/issues"
154154
:type '(repeat string)
155155
:group 'prover-config)
156156

generic/pg-vars.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ Internal variable dynamically bound.")
247247
:group 'proof-general-internals)
248248

249249
(defcustom proof-general-home-page
250-
"http://proofgeneral.inf.ed.ac.uk"
250+
"https://proofgeneral.github.io"
251251
"*Web address for Proof General."
252252
:type 'string
253253
:group 'proof-general-internals)

generic/proof-faces.el

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
;; But it's difficult to keep track of all that!
1919
;; Please report any bad/failing colour
2020
;; combinations (with suggested improvements) at
21-
;; http://proofgeneral.inf.ed.ac.uk/trac
21+
;; https://github.com/ProofGeneral/PG/issues
2222
;;
2323
;; Some of these faces aren't used by default in Proof General,
2424
;; but you can use them in font lock patterns for specific

generic/proof-splash.el

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ Proof General."
7070
"PG is on Github at https://github.com/ProofGeneral/PG")
7171
:link '("or the " "homepage"
7272
(lambda (button)
73-
(browse-url "http://proofgeneral.inf.ed.ac.uk/"))
74-
"Browse http://proofgeneral.inf.ed.ac.uk/")
73+
(browse-url "https://proofgeneral.github.io"))
74+
"Browse https://proofgeneral.github.io")
7575
nil
7676
:link '("Find out about Emacs on the Help menu -- start with the "
7777
"Emacs Tutorial" (lambda (button) (help-with-tutorial)))

0 commit comments

Comments
 (0)