zsh-workers
 help / color / mirror / code / Atom feed
From: Bart Schaefer <schaefer@brasslantern.com>
To: zsh-workers@zsh.org
Subject: Re: Install run-help and *.zwc files system wide in build system
Date: Sun, 10 Nov 2013 10:56:03 -0800	[thread overview]
Message-ID: <131110105603.ZM21496@torch.brasslantern.com> (raw)
In-Reply-To: <slrnl7uiji.iif.vaeth@lounge.imp.fu-berlin.de>

On Nov 10,  8:57am, Martin Vaeth wrote:
}
} The "documented way" to produce the files for run-help is only
} suboptimal, because:
} 
} 2. It does not work out-of-the box: With current man/groff versions,
} one must export (an empty) GROFF_NO_SGR, MANWIDTH=80, possibly
} unset MANPL, MANROFFSEQ, set utf8-aware locales etc.

Of course the "right" way to go about this would be to generate the
run-help files directly from the yodl source, or at least to generate
formatted output from the yodl that could more easly be split up by
Util/helpfiles.

That would mean creating a "zhelp.yo" file patterned after Doc/zman.yo
and Doc/ztexi.yo plus Makefile.in rules using "yodl -w zhelp.yo ..."
 
} (b) Similarly, it would be nice if zsh would be able to
} install *.zwc files for the functions it provides in the
} build process.

Someone should do (again? I wonder if it ever was done) benchmarking
of whether .zwc files really save any time/CPU.  I'm sure they do for
sets of functions that are all going to be used during the session;
but I'm doubtful that packing a bunch of autoloads, most of which are
never actually loaded, into one big library file, is more effective
than reading the individual files of only the subset that is used.

It certainly doesn't save disk space; in nearly all cases ZWC files
are bigger than their text counterparts, because they have to retain
the original text for XTRACE purposes and no compression is applied.

} Of course, both should happen only if appropriate ./configure
} options are passed (e.g. compiling *.zwc files is only possible
} in the build process if no cross-compilation is happening,
} and building help-files requires tools like man, groff, and perl
} which one should not require just to _build_ a zsh).

This is why the precompiled doc is distributed in a separate tarball
from the shell sources.  If we're going to start building run-help
files (or special Util/helpfiles input) as well, then those will need
to be added to the doc tarball.


      parent reply	other threads:[~2013-11-10 18:56 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-10  8:57 Martin Vaeth
2013-11-10 18:13 ` Peter Stephenson
2013-11-10 22:28   ` Martin Vaeth
2013-11-11  2:30     ` Bart Schaefer
2013-11-11  9:09       ` Martin Vaeth
2013-11-11 16:42         ` Bart Schaefer
2013-11-11 22:59           ` Martin Vaeth
2013-11-12 10:11             ` Peter Stephenson
2013-11-12 17:41               ` Martin Vaeth
2013-11-12 17:48                 ` Peter Stephenson
2013-11-12 21:04                   ` Peter Stephenson
2013-11-12 21:42                     ` Martin Vaeth
2013-11-13  9:28                       ` Peter Stephenson
2013-11-13 10:10                         ` Martin Vaeth
2013-11-13 11:21                           ` Peter Stephenson
2013-11-13 16:06                             ` Bart Schaefer
2013-11-16 12:14                               ` modify functions hierarchy (was: Install run-help and *.zwc files system wide in build system) Martin Vaeth
2013-11-17 18:30                                 ` Bart Schaefer
2013-11-17 19:42                                   ` Martin Vaeth
2013-11-17 21:01                                     ` Bart Schaefer
2013-11-18  7:00                                       ` Martin Vaeth
2013-11-18 16:11                                         ` Doc/Doc/help (was: modify functions hierarchy (was: Install run-help and *.zwc files system wide in build system)) Bart Schaefer
2013-11-18 16:23                                           ` Peter Stephenson
2013-11-18 16:31                                             ` Bart Schaefer
2013-11-18 16:36                                               ` Peter Stephenson
2013-11-18 16:45                                                 ` Bart Schaefer
2013-11-18 16:58                                                   ` Peter Stephenson
2013-11-20 19:26                                       ` modify functions hierarchy (was: Install run-help and *.zwc files system wide in build system) Peter Stephenson
2013-11-21  6:01                                         ` Bart Schaefer
2013-11-23 17:48                                           ` Peter Stephenson
2013-11-23 19:47                                             ` Helpfiles again (was Re: modify functions hierarchy (was: etc.)) Bart Schaefer
2013-11-23 21:25                                               ` Martin Vaeth
2013-11-24  5:06                                                 ` Bart Schaefer
     [not found]                                                   ` <20131124175649.27c2559a@pws!>
2013-11-24 12:26                                                   ` Martin Vaeth
2013-11-24 12:31                                                     ` Martin Vaeth
2013-11-24 17:56                                                   ` Peter Stephenson
2013-11-25  8:18                                                     ` Bart Schaefer
2013-11-25 14:24                                                       ` Jun T.
2013-11-25 15:49                                                         ` Peter Stephenson
2013-11-25 16:56                                                           ` Bart Schaefer
2013-11-25 17:37                                                             ` Peter Stephenson
2013-11-25 20:14                                                             ` Phil Pennock
2013-11-26  9:24                                                               ` Peter Stephenson
2013-12-12 22:17                                                             ` PATCH: Util/helpfiles failing on old-fashioned unix pda
2013-12-13  9:08                                                               ` Martin Vaeth
2013-12-13 23:46                                                                 ` Martin Vaeth
2013-12-14  0:20                                                                 ` Wayne Davison
2013-12-14  9:23                                                                   ` Martin Vaeth
2013-12-14 18:49                                                                     ` Bart Schaefer
2013-12-15 23:37                                                                 ` pda
2013-12-18  8:39                                                                   ` Martin Vaeth
2013-11-17 20:13                                   ` modify functions hierarchy (was: Install run-help and *.zwc files system wide in build system) Peter Stephenson
2013-11-17 20:50                                     ` Bart Schaefer
2013-11-18  7:57                                       ` Martin Vaeth
2013-11-18 16:28                                         ` Bart Schaefer
2013-11-18 10:32                                       ` Peter Stephenson
2013-11-18 16:38                                         ` Bart Schaefer
2013-11-18 16:50                                           ` Peter Stephenson
2013-11-12 21:52                     ` Install run-help and *.zwc files system wide in build system Martin Vaeth
2013-11-13  1:13                       ` Bart Schaefer
2013-11-13  2:40                         ` Bart Schaefer
2013-11-13 13:30                 ` [PATCH] helpfiles: Also accept 'UTF-8' as an encoding name Jun T.
2013-11-13 15:37                   ` Jun T.
2013-11-13 16:56                     ` Martin Vaeth
2013-11-13 17:27                       ` Bart Schaefer
2013-11-13 18:28                         ` Martin Vaeth
2013-11-14  0:06                           ` Phil Pennock
2013-11-14  7:50                             ` Martin Vaeth
2013-11-14  8:18                               ` Phil Pennock
2013-11-14 11:11                                 ` Martin Vaeth
2013-11-15 14:58                                   ` Jun T.
2013-11-15 17:16                                     ` Bart Schaefer
2013-11-15 19:58                                     ` Martin Vaeth
2013-11-16  5:51                                       ` Bart Schaefer
2013-11-16 15:17                                         ` Jun T.
2013-11-16 18:05                                           ` Bart Schaefer
2013-11-18 18:43                                       ` Phil Pennock
2013-11-10 22:44   ` Install run-help and *.zwc files system wide in build system Martin Vaeth
2013-11-10 18:56 ` Bart Schaefer [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=131110105603.ZM21496@torch.brasslantern.com \
    --to=schaefer@brasslantern.com \
    --cc=zsh-workers@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).