diff options
| author | Paul Eggert | 2018-03-30 16:11:45 -0700 |
|---|---|---|
| committer | Paul Eggert | 2018-03-30 16:12:07 -0700 |
| commit | 20fa40ddd3e49b73cf2127a147d3b4ee03a3b5ba (patch) | |
| tree | 4306d0885cac75189e022f66b0eb5ab3462d966c /admin | |
| parent | 6c48146f46a443b1e11b58c52dd8f2e5d9feb21c (diff) | |
| download | emacs-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.txt | 34 |
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 | ||
| 124 | 9. Decide what compression schemes to offer. | 124 | 9. 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 | ||
| 198 | emacs.html (for a new major release, a more thorough update is needed) | 198 | emacs.html (for a new major release, a more thorough update is needed) |
| 199 | history.html | 199 | history.html |
| 200 | add the new NEWS file as news/NEWS.xx.y | ||
| 201 | 200 | ||
| 202 | For every new release, a banner is displayed on top of the emacs.html | 201 | For every new release, a banner is displayed on top of the emacs.html |
| 203 | page. Uncomment and the release banner in emacs.html. Keep it on the | 202 | page. 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 | |||
| 210 | longer present. | 209 | longer present. |
| 211 | 210 | ||
| 212 | Tar up the generated html_node/emacs/ and elisp/ directories and update | 211 | Tar up the generated html_node/emacs/ and elisp/ directories and update |
| 213 | the files manual/elisp.html_node.tar.gz and emacs.html_node.tar.gz. | 212 | the files manual/elisp.html_node.tar.gz and emacs.html_node.tar.gz. |
| 213 | Use GNU Tar as follows so that the tarballs are reproducible: | ||
| 214 | 214 | ||
| 215 | Use M-x make-manuals-dist from admin/admin.el to update the | 215 | cd manual |
| 216 | manual/texi/ tarfiles. | 216 | tar='tar --numeric-owner --owner=0 --group=0 --mode=go+u,go-w --sort=name' |
| 217 | 217 | gzip='gzip --best --no-name' | |
| 218 | Add 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 | ||
| 220 | Update the refcards/pdf/ and ps/ directories, and also | 221 | Use M-x make-manuals-dist from admin/admin.el to update the |
| 221 | refcards/emacs-refcards.tar.gz (use make -C etc/refcards pdf ps dist). | 222 | manual/*.tar files. |
| 223 | |||
| 224 | Add compressed copies of the main info pages from the tarfile to manual/info/ | ||
| 225 | as follows: | ||
| 226 | |||
| 227 | cd manual | ||
| 228 | mkdir info | ||
| 229 | gzip --best --no-name <../info/eintr.info >info/eintr.info.gz | ||
| 230 | gzip --best --no-name <../info/elisp.info >info/elisp.info.gz | ||
| 231 | gzip --best --no-name <../info/emacs.info >info/emacs.info.gz | ||
| 232 | |||
| 233 | FIXME: The above instructions are not quite complete, as they do not | ||
| 234 | specify how to copy the generated files in the 'manual' directory to | ||
| 235 | the corresponding web files. Also, they are missing some files, e.g., | ||
| 236 | they generate manual/html_mono/ada-mode.html but do not generate the | ||
| 237 | top-level ada-mode.html file for the one-node-per-page version. | ||
| 222 | 238 | ||
| 223 | Browsing <https://web.cvs.savannah.gnu.org/viewvc/?root=emacs> is one | 239 | Browsing <https://web.cvs.savannah.gnu.org/viewvc/?root=emacs> is one |
| 224 | way to check for any files that still need updating. | 240 | way to check for any files that still need updating. |