On Apr 16, 2014, at 11:11, Junio C Hamano wrote:
Junio C Hamano <gits...@pobox.com> writes:

"Kyle J. McKay" <mack...@gmail.com> writes:

If I'm the only one getting a wrong meaning from the comments, then no
reason to change them.

I agree that the description does not read well with the work-around
already there.  I am not sure what would be a better way to phrase
it, though.

Here is a tentative rewrite at the beginning and the end of rebase-am:

   # The whole contents of the file is run by dot-sourcing this
   # file from inside a shell function.  It used to be that
   # "return"s we see below were not inside any function, and
   # expected to return from the function that dot-sourced us.

I think it's the "return from the function that dot-sourced us" that gives me the wrong meaning. The "return from" part says to me that function will be returning which it will not unless the dot command was the last command in the function.

Either "return to the function that dot-sourced us" or "return from the dot command that dot-sourced us", but using the original wording implies to me that the function that dot-sourced us will return as soon as the dot-sourced script executes the return and that is exactly one of the bugs we're working around.

I think just the s/from/to/ would fix it so it does not give me the wrong impression, but that doesn't mean that would not confuse everyone else. ;)

   #
   # However, FreeBSD /bin/sh misbehaves on such a construct and
   # continues to run the statements that follow such a "return".
   # As a work-around, we introduce an extra layer of a function
   # here, and immediately call it after defining it.
   git_rebase__am () {

   ...

   }
   # ... and then we call the whole thing.
   git_rebase__am

On Apr 16, 2014, at 11:23, Junio C Hamano wrote:
Junio C Hamano <gits...@pobox.com> writes:
By the way, you have this in your log message:

   ... the git-rebase--*.sh scripts have used a "return" to return
   from the "dot" command that runs them.  While this is allowed by
   POSIX,...


Is it "this is allowed", or is it "this should be the way and shells
that do not do so are buggy"?

Answering myself...

The only "unspecified" I see is this:

   If the shell is not currently executing a function or dot
   script, the results are unspecified.

which clearly does not apply to the version before this patch (we
are executing a dot script).  And

   The return utility shall cause the shell to stop executing the
   current function or dot script.

would mean that we are correct to expect that "should not get here"
is not reached, as the "return 5" would cause the shell to stop
executing the dot script there.

So "while this is allowed by POSIX" may be a bit misleading and
needs to be reworded, I guess?

"allowed by POSIX" is not incorrect. ;)

But perhaps the log message should say 'While POSIX specifies that a "return" may be used to exit a "dot" sourced script,' there instead to be clearer. Which would make that whole first paragraph become:

Since a1549e10, 15d4bf2e and 01a1e646 (first appearing in v1.8.4) the git-rebase--*.sh scripts have used a "return" to return from the "dot" command that runs them. While POSIX specifies that a "return" may be
    used to exit a "dot" sourced script, the FreeBSD /bin/sh utility
behaves poorly under some circumstances when such a "return" is executed.

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to