From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Ralf Thielow <ralf.thielow@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com, larsxschneider@gmail.com,
me@jnm2.com, philipoakley@iee.org, john@keeping.me.uk
Subject: Re: [PATCH 1/2] help: introduce option --command-only
Date: Fri, 19 Aug 2016 10:32:30 +0200 (CEST) [thread overview]
Message-ID: <alpine.DEB.2.20.1608190954461.4924@virtualbox> (raw)
In-Reply-To: <20160818185719.4909-2-ralf.thielow@gmail.com>
Hi Ralf,
On Thu, 18 Aug 2016, Ralf Thielow wrote:
> diff --git a/t/t0012-help.sh b/t/t0012-help.sh
> new file mode 100755
> index 0000000..e20f907
> --- /dev/null
> +++ b/t/t0012-help.sh
> @@ -0,0 +1,21 @@
> +#!/bin/sh
> +
> +test_description='help'
> +
> +. ./test-lib.sh
> +
> +test_expect_success "works for commands and guides by default" "
> + git help status &&
> + git help revisions
> +"
Apart from using double quotes (which is inconsistent with the single
quotes used literally everwhere else in the test suite), this test is
incorrect. If the man page is not *installed*, it will fail:
$ sudo mv /usr/share/man/man1/git-status.1.gz \
/usr/share/man/man1/git-status.old.1.gz
$ sh t0012-help.sh -i -v -x
Initialized empty Git repository in .../trash directory.t0012-help/.git/
expecting success:
git help status &&
git help revisions
+ git help status
No manual entry for git-status
See 'man 7 undocumented' for help when manual pages are not available.
error: last command exited with $?=16
not ok 1 - works for commands and guides by default
#
# git help status &&
# git help revisions
#
It gets even worse.
On Windows, the default format is *not* man pages but html pages. So those
would have to be installed, too, to guarantee that the test succeeds.
It gets *even* worse.
On Windows, there is really no central location for man/html pages for
documentation, so we have to emulate that "prefix" (which is typically
/usr on Linux) via a "runtime prefix", i.e. a prefix determined relative
to the location of the currently running git executable. In the test
suite's case, it is typically the top-level directory of the git.git
checkout [*1*]. There are no man/html pages in that directory structure by
default (I, for one, rarely build them myself), and certainly not in the
place expected by this test.
It gets *even worse*.
Since the help.format is html on Windows, the page is opened by the
default viewer for HTML pages. So even if all of the above would be fixed,
running t0012-help of a supposedly unsupervised test suite would open new
tabs in the web browser. Probably forcing it into the foreground, too.
So how about fixing that? I would suggest to do it this way:
- configure help.format = html (for "man", the current code would always
add $(prefix)/share/man to the MANPATH when testing, not what we want,
and hacking this code *just* for testing is both ugly and unnecessary).
- configure help.htmlpath to point to a subdirectory that is created and
populated in the same test script.
- configure help.browser to point to a script that is created in the same
script and whose output we can verify, too.
The last point actually requires a patch that was recently introduced into
Git for Windows [*1*] (and that did not make it upstream yet) which
reverts that change whereby web--browse was sidestepped. That sidestepping
was well-intentioned but turned out to cause more harm than good.
Ciao,
Johannes
Footnote *1*: That statement is actually not even correct. As the git
executable can live in both $(prefix)/bin/ and $(prefix)/libexec/git-core,
i.e. at different directory levels below the prefix, we need to inspect
the *name* of the directory in which git.exe lives, and a git.git checkout
typically lives in a .../git/ directory which matches *none* of the
expected suffixes, so the runtime prefix defaults to "/", i.e. the
*current drive's root directory*. So your current test would only succeed
if the man pages for git-status and gitrevisions were copied into
C:\mingw64\share\man\man1!
Footnote *2*: https://github.com/git-for-windows/git/commit/243c72f5b0
next prev parent reply other threads:[~2016-08-19 8:32 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-12 2:00 `git stash --help` tries to pull up nonexistent file gitstack.html Joseph Musser
2016-08-12 15:48 ` Junio C Hamano
2016-08-12 16:03 ` Lars Schneider
2016-08-12 16:15 ` Joseph Musser
2016-08-12 16:25 ` Junio C Hamano
2016-08-12 18:14 ` Jacob Keller
2016-08-12 20:10 ` [PATCH] help: make option --help open man pages only for Git commands Ralf Thielow
2016-08-12 21:34 ` Junio C Hamano
2016-08-12 22:53 ` Junio C Hamano
2016-08-13 0:08 ` Philip Oakley
2016-08-13 15:31 ` Junio C Hamano
2016-08-15 5:36 ` [PATCH v2] " Ralf Thielow
2016-08-15 11:25 ` Philip Oakley
2016-08-15 17:57 ` Junio C Hamano
2016-08-15 20:40 ` Philip Oakley
2016-08-15 22:19 ` Junio C Hamano
2016-08-16 10:06 ` John Keeping
2016-08-16 16:20 ` [PATCH v3] " Ralf Thielow
2016-08-16 16:33 ` John Keeping
2016-08-16 16:39 ` Ralf Thielow
2016-08-16 17:27 ` Junio C Hamano
2016-08-16 17:57 ` Ralf Thielow
2016-08-16 19:06 ` Junio C Hamano
2016-08-18 18:57 ` [PATCH 0/2] " Ralf Thielow
2016-08-18 18:57 ` [PATCH 1/2] help: introduce option --command-only Ralf Thielow
2016-08-18 18:57 ` [PATCH 2/2] help: make option --help open man pages only for Git commands Ralf Thielow
2016-08-18 19:51 ` Junio C Hamano
2016-08-23 17:34 ` Ralf Thielow
2016-08-18 21:47 ` [PATCH 1/2] help: introduce option --command-only Philip Oakley
2016-08-19 8:32 ` Johannes Schindelin [this message]
2016-08-19 15:53 ` Junio C Hamano
2016-08-23 17:41 ` Ralf Thielow
2016-08-24 7:47 ` Johannes Schindelin
2016-08-19 8:39 ` Remi Galan Alfonso
2016-08-23 17:37 ` Ralf Thielow
2016-08-26 17:58 ` [PATCH v2 0/3] help: make option --help open man pages only for Git commands Ralf Thielow
2016-08-26 17:58 ` [PATCH v2 1/3] Revert "display HTML in default browser using Windows' shell API" Ralf Thielow
2016-08-26 17:58 ` [PATCH v2 2/3] help: introduce option --exclude-guides Ralf Thielow
2016-08-26 19:06 ` Junio C Hamano
2016-08-26 19:42 ` Junio C Hamano
2016-08-26 20:03 ` Ralf Thielow
2016-08-26 20:28 ` Junio C Hamano
2016-08-26 20:00 ` Ralf Thielow
2016-08-26 20:20 ` Junio C Hamano
2016-08-26 20:39 ` Ralf Thielow
2016-08-26 17:58 ` [PATCH v2 3/3] help: make option --help open man pages only for Git commands Ralf Thielow
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.DEB.2.20.1608190954461.4924@virtualbox \
--to=johannes.schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=john@keeping.me.uk \
--cc=larsxschneider@gmail.com \
--cc=me@jnm2.com \
--cc=philipoakley@iee.org \
--cc=ralf.thielow@gmail.com \
/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://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).