aboutsummaryrefslogtreecommitdiffstats
path: root/admin
diff options
context:
space:
mode:
authorPaul Eggert2018-03-30 16:11:45 -0700
committerPaul Eggert2018-03-30 16:12:07 -0700
commit20fa40ddd3e49b73cf2127a147d3b4ee03a3b5ba (patch)
tree4306d0885cac75189e022f66b0eb5ab3462d966c /admin
parent6c48146f46a443b1e11b58c52dd8f2e5d9feb21c (diff)
downloademacs-20fa40ddd3e49b73cf2127a147d3b4ee03a3b5ba.tar.gz
emacs-20fa40ddd3e49b73cf2127a147d3b4ee03a3b5ba.zip
Improve doc for web pages; reproducible tarballs
* admin/make-tarball.txt: Make the tarballs more reproducible. Fix instructions for web pages as best I can (they are still incomplete). * make-dist (default_gzip): Add --no-name for gzip. (taropt): Add options to make the build more reproducible.
Diffstat (limited to 'admin')
-rw-r--r--admin/make-tarball.txt34
1 files changed, 25 insertions, 9 deletions
diff --git a/admin/make-tarball.txt b/admin/make-tarball.txt
index ac6d15d6cee..19edeb79e62 100644
--- a/admin/make-tarball.txt
+++ b/admin/make-tarball.txt
@@ -123,7 +123,7 @@ General steps (for each step, check for possible errors):
123 123
1249. Decide what compression schemes to offer. 1249. Decide what compression schemes to offer.
125 For a release, at least gz and xz: 125 For a release, at least gz and xz:
126 gzip --best -c emacs-NEW.tar > emacs-NEW.tar.gz 126 gzip --best --no-name -c emacs-NEW.tar > emacs-NEW.tar.gz
127 xz -c emacs-NEW.tar > emacs-NEW.tar.xz 127 xz -c emacs-NEW.tar > emacs-NEW.tar.xz
128 For pretests, just xz is probably fine (saves bandwidth). 128 For pretests, just xz is probably fine (saves bandwidth).
129 129
@@ -197,7 +197,6 @@ The pages to update are:
197 197
198emacs.html (for a new major release, a more thorough update is needed) 198emacs.html (for a new major release, a more thorough update is needed)
199history.html 199history.html
200add the new NEWS file as news/NEWS.xx.y
201 200
202For every new release, a banner is displayed on top of the emacs.html 201For every new release, a banner is displayed on top of the emacs.html
203page. Uncomment and the release banner in emacs.html. Keep it on the 202page. Uncomment and the release banner in emacs.html. Keep it on the
@@ -210,15 +209,32 @@ manual/html_node directory, delete any old manual pages that are no
210longer present. 209longer present.
211 210
212Tar up the generated html_node/emacs/ and elisp/ directories and update 211Tar up the generated html_node/emacs/ and elisp/ directories and update
213the files manual/elisp.html_node.tar.gz and emacs.html_node.tar.gz. 212the files manual/elisp.html_node.tar.gz and emacs.html_node.tar.gz.
213Use GNU Tar as follows so that the tarballs are reproducible:
214 214
215Use M-x make-manuals-dist from admin/admin.el to update the 215cd manual
216manual/texi/ tarfiles. 216tar='tar --numeric-owner --owner=0 --group=0 --mode=go+u,go-w --sort=name'
217 217gzip='gzip --best --no-name'
218Add compressed copies of the main info pages from the tarfile to manual/info/. 218$tar -cf - html_node/emacs | $gzip >emacs.html_node.tar.gz
219$tar -cf - html_node/elisp | $gzip >elisp.html_node.tar.gz
219 220
220Update the refcards/pdf/ and ps/ directories, and also 221Use M-x make-manuals-dist from admin/admin.el to update the
221refcards/emacs-refcards.tar.gz (use make -C etc/refcards pdf ps dist). 222manual/*.tar files.
223
224Add compressed copies of the main info pages from the tarfile to manual/info/
225as follows:
226
227cd manual
228mkdir info
229gzip --best --no-name <../info/eintr.info >info/eintr.info.gz
230gzip --best --no-name <../info/elisp.info >info/elisp.info.gz
231gzip --best --no-name <../info/emacs.info >info/emacs.info.gz
232
233FIXME: The above instructions are not quite complete, as they do not
234specify how to copy the generated files in the 'manual' directory to
235the corresponding web files. Also, they are missing some files, e.g.,
236they generate manual/html_mono/ada-mode.html but do not generate the
237top-level ada-mode.html file for the one-node-per-page version.
222 238
223Browsing <https://web.cvs.savannah.gnu.org/viewvc/?root=emacs> is one 239Browsing <https://web.cvs.savannah.gnu.org/viewvc/?root=emacs> is one
224way to check for any files that still need updating. 240way to check for any files that still need updating.