zsh-workers
 help / color / mirror / code / Atom feed
From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: Re: Documentation about Multios is misleading, and perhaps untrue
Date: Tue, 16 Oct 2018 02:07:35 +0000	[thread overview]
Message-ID: <1539655655.1396893.1543274624.1FAEEE73@webmail.messagingengine.com> (raw)
In-Reply-To: <CAO1rNLgq0pRCkE7FcNgRSq-dT0UU2BspyUtcxwUMHf_wRJuebg@mail.gmail.com>

Tom Boyd wrote on Mon, 15 Oct 2018 20:45 -0400:
>  I think this section should just breifly describe that the file
> descriptors are opened before the command is executed, and that
> 
> command < file1 < file2
> 
> is *similar* to
> 
> cat file1 file2 | command
> 
> except that the first waits for all files to be opened *before* command
> executes and completely fails if any file opening fails, where as cat x y z
> | command immediately starts processing files and simply skips ones that
> fail.

It's really not zsh's job to document cat(1).

However, I agree with your overall point, that the statement about
"equivalence" in the manual is incorrect.  At the same time, I think a
different fix would be better:

1. Ensure that it's documented that all redirections (input and output)
   are opened before the command is even exec'd.  This is true for all
   redirections, not just for MULTIOS syntaxes.

2. In the section that gives analogies to cat(1) and sort(1), simply
   state that the examples assume that all dirent names are ordinary,
   readable files.

Makes sense?  Anybody volunteering to write the patch (not me)?

> On a more general philosophical note though, I get that context is
> important, but man pages and software references should **never** contain
> objectively false statements. It's not ok to say something that factually
> incorrect and justify it by assuming the reader will have enough "common
> sense" to determine what parts are correct and which arent. These
> references are the single souce of truth for a lot of readers.

Cheers,

Daniel

  reply	other threads:[~2018-10-16  2:17 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-11  2:33 Tom Boyd
2018-10-11  4:05 ` dana
2018-10-11 19:12   ` Bart Schaefer
2018-10-11 20:35     ` Daniel Shahaf
2018-10-11 20:59       ` Bart Schaefer
2018-10-12  8:30         ` Peter Stephenson
2018-10-16  0:45           ` Tom Boyd
2018-10-16  2:07             ` Daniel Shahaf [this message]
2018-10-16  9:33               ` Peter Stephenson

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=1539655655.1396893.1543274624.1FAEEE73@webmail.messagingengine.com \
    --to=d.s@daniel.shahaf.name \
    --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).