emacs/admin/notes/hydra

-*- mode: outline; coding: utf-8 -*-

Copyright (C) 2013-2020 Free Software Foundation, Inc.
See the end of the file for license conditions.

NOTES FOR EMACS CONTINUOUS BUILD ON HYDRA

A continuous build for Emacs can be found at
https://hydra.nixos.org/jobset/gnu/emacs-trunk

* It builds Emacs on various platforms.
Sometimes jobs fail due to hydra problems rather than Emacs problems.

* Mail notifications
In addition to the web interface, Hydra can send notifications by
email when the build status of a project changes, e.g., from
SUCCEEDED to FAILED.  It sends notifications about build status in
Emacs trunk to emacs-buildstatus@gnu.org.

If you want to receive these notifications, please subscribe at
https://lists.gnu.org/mailman/listinfo/emacs-buildstatus

(This feature seems to have been broken for ages.)

* The Emacs jobset consists of the following jobs:

** The 'tarball' job
which gets a checkout from the repository, and does a bootstrap followed
by running make-dist to create a tarball.  If this job fails, all the
others will too (because they use the tarball as input).

** The 'build' job
which starts from the tarball and does a normal build.

** The 'coverage' job
does a gcov build and then runs 'make check-expensive'.  Fails if any
test fails.

* Nix expressions
The recipe for GNU Emacs are available via Git:
https://git.savannah.gnu.org/cgit/hydra-recipes.git/tree/emacs

To modify the build job, email the patch to hydra-users@gnu.org.  The
build recipes are written in the Nix language.

* Identifying hydra
Lisp packages, Makefiles, scripts, and other software could determine
whether they run on hydra by checking for the environment variable
EMACS_HYDRA_CI.

* Other Information
For a list of other GNU packages that have a continuous build on
Hydra, see https://hydra.nixos.org/project/gnu

See https://www.gnu.org/software/devel.html#Hydra for more information.


This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
-												Update source file encoding list

Update admin/notes/unicode, along with coding system cookies in
other files, so that the two match each other better.
* admin/notes/unicode: lisp/language/ethio-util.el and
lisp/language/ethiopic.el also use utf-8-emacs.
* admin/notes/hydra, doc/misc/dbus.texi, doc/misc/org.texi:
* doc/misc/remember.texi, etc/refcards/cs-dired-ref.tex:
* etc/refcards/cs-refcard.tex, etc/refcards/cs-survival.tex:
* etc/refcards/sk-dired-ref.tex, etc/refcards/sk-refcard.tex:
* etc/refcards/sk-survival.tex:
Add "coding: utf-8" so that this file is not mishandled in a
Latin-1 or Big-5 locale.
* lisp/international/robin.el, lisp/org/ox-ascii.el:
Specify utf-8, not utf-8-emacs, as these are plain UTF-8 files.
* lisp/language/ethio-util.el: Fix trailer.

											
										
										
											2015-04-28 17:51:21 +00:00
+								-*- mode: outline; coding: utf-8 -*-
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												Update copyright year to 2020

Run "TZ=UTC0 admin/update-copyright $(git ls-files)".

											
										
										
											2020-01-01 00:19:43 +00:00
+								Copyright (C) 2013-2020 Free Software Foundation, Inc.
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
+								See the end of the file for license conditions.
 								NOTES FOR EMACS CONTINUOUS BUILD ON HYDRA
-												* admin/notes/hydra: Misc small edits

											
										
										
											2013-08-29 01:12:51 +00:00
+								A continuous build for Emacs can be found at
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								https://hydra.nixos.org/jobset/gnu/emacs-trunk
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												* admin/notes/hydra: Misc small edits

											
										
										
											2013-08-29 01:12:51 +00:00
+								* It builds Emacs on various platforms.
 								Sometimes jobs fail due to hydra problems rather than Emacs problems.
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
 								* Mail notifications
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
+								In addition to the web interface, Hydra can send notifications by
-												Prefer straight quoting in some text files

Mostly this just changes ` to ' in static text.  Some exceptions:
* INSTALL.REPO: Use curved quotes, as the diagnostic in question
typically does that now.
* admin/quick-install-emacs (TRY, top level):
Use straight quoting in diagnostics.
* src/README: Fix working-directory confusion.

											
										
										
											2015-09-11 18:04:24 +00:00
+								email when the build status of a project changes, e.g., from
 								SUCCEEDED to FAILED.  It sends notifications about build status in
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
+								Emacs trunk to emacs-buildstatus@gnu.org.
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
 								If you want to receive these notifications, please subscribe at
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								https://lists.gnu.org/mailman/listinfo/emacs-buildstatus
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												* admin/notes/hydra: Small updates.

											
										
										
											2019-02-12 18:57:34 +00:00
+								(This feature seems to have been broken for ages.)
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
+								* The Emacs jobset consists of the following jobs:
-												Prefer straight quoting in some text files

Mostly this just changes ` to ' in static text.  Some exceptions:
* INSTALL.REPO: Use curved quotes, as the diagnostic in question
typically does that now.
* admin/quick-install-emacs (TRY, top level):
Use straight quoting in diagnostics.
* src/README: Fix working-directory confusion.

											
										
										
											2015-09-11 18:04:24 +00:00
+								** The 'tarball' job
-												Neutralize language specific to a repository type.

											
										
										
											2014-10-25 18:53:20 +00:00
+								which gets a checkout from the repository, and does a bootstrap followed
-												* admin/notes/hydra: Misc small edits

											
										
										
											2013-08-29 01:12:51 +00:00
+								by running make-dist to create a tarball.  If this job fails, all the
 								others will too (because they use the tarball as input).
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												Prefer straight quoting in some text files

Mostly this just changes ` to ' in static text.  Some exceptions:
* INSTALL.REPO: Use curved quotes, as the diagnostic in question
typically does that now.
* admin/quick-install-emacs (TRY, top level):
Use straight quoting in diagnostics.
* src/README: Fix working-directory confusion.

											
										
										
											2015-09-11 18:04:24 +00:00
+								** The 'build' job
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								which starts from the tarball and does a normal build.
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
 								** The 'coverage' job
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								does a gcov build and then runs 'make check-expensive'.  Fails if any
 								test fails.
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
+								* Nix expressions
 								The recipe for GNU Emacs are available via Git:
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								https://git.savannah.gnu.org/cgit/hydra-recipes.git/tree/emacs
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
 								To modify the build job, email the patch to hydra-users@gnu.org.  The
 								build recipes are written in the Nix language.
-												* admin/notes/hydra: Mention environment variable EMACS_HYDRA_CI.

											
										
										
											2017-07-18 20:40:23 +00:00
+								* Identifying hydra
 								Lisp packages, Makefiles, scripts, and other software could determine
 								whether they run on hydra by checking for the environment variable
 								EMACS_HYDRA_CI.
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
+								* Other Information
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
+								For a list of other GNU packages that have a continuous build on
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								Hydra, see https://hydra.nixos.org/project/gnu
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
-												; Editorial changes in admin/notes/hydra

											
										
										
											2017-07-19 09:34:29 +00:00
+								See https://www.gnu.org/software/devel.html#Hydra for more information.
-												* admin/notes/hydra: More information about Hydra.

											
										
										
											2013-08-15 06:23:40 +00:00
-												Add some notes related to continuous build on Hydra

											
										
										
											2013-08-10 22:54:32 +00:00
 								This file is part of GNU Emacs.
 								GNU Emacs is free software: you can redistribute it and/or modify
 								it under the terms of the GNU General Public License as published by
 								the Free Software Foundation, either version 3 of the License, or
 								(at your option) any later version.
 								GNU Emacs is distributed in the hope that it will be useful,
 								but WITHOUT ANY WARRANTY; without even the implied warranty of
 								MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 								GNU General Public License for more details.
 								You should have received a copy of the GNU General Public License
-												Prefer HTTPS to FTP and HTTP in documentation

Most of this change is to boilerplate commentary such as license URLs.
This change was prompted by ftp://ftp.gnu.org's going-away party,
planned for November.  Change these FTP URLs to https://ftp.gnu.org
instead.  Make similar changes for URLs to other organizations moving
away from FTP.  Also, change HTTP to HTTPS for URLs to gnu.org and
fsf.org when this works, as this will further help defend against
man-in-the-middle attacks (for this part I omitted the MS-DOS and
MS-Windows sources and the test tarballs to keep the workload down).
HTTPS is not fully working to lists.gnu.org so I left those URLs alone
for now.

											
										
										
											2017-09-13 22:52:52 +00:00
+								along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.