Bug#905938: git-rebase(1) has wrong filename for revert-a-faulty-merge.html

2018-08-14 Thread Ben Hutchings
Control: severity -1 minor
Control: retitle -1 Files in git-doc may not be findable by apt-file search

On Mon, 2018-08-13 at 19:27 -0700, Jonathan Nieder wrote:
> tags 905938 + moreinfo
> quit
> 
> Hi Ben,
> 
> Ben Hutchings wrote:
> 
> > git-rebase(1) refers to
> > /usr/share/doc/git/html/howto/revert-a-faulty-merge.html, but this
> > filename does not exist in any package.  git-doc contains
> > /usr/share/doc/git-doc/howto/revert-a-faulty-merge.html which is
> > presumably the right file to refer to.
> 
> $ ls -ld /usr/share/doc/git/html
> lrwxrwxrwx 1 root root 10 May 30  2017 /usr/share/doc/git/html -> ../git-doc
> 
> Is it configured differently on your machine?

No, it's not.  Now that I have git-doc installed, the symlink is there
and I can access the document through both filenames.

Initially I did not have git-doc installed, and "apt-file search"
couldn't find the file by the name given in git-rebase(1) because it
doesn't take symlinks into account.

[...]
> Arguably it would be better to install directly into
> /usr/share/doc/git/html, but that would have broken links (e.g.
> kernel-handbook links to [1]).  Perhaps the package should install
> docs directly to /usr/share/doc/git/html and put some symlinks in
> /usr/share/doc/git-doc --- what do you think?

I don't know.  Do whichever you think is likely to cause least
confusion.

Ben.

-- 
Ben Hutchings
The Peter principle: In a hierarchy, every employee tends to rise to
their level of incompetence.



signature.asc
Description: This is a digitally signed message part


Bug#905938: git-rebase(1) has wrong filename for revert-a-faulty-merge.html

2018-08-13 Thread Jonathan Nieder
tags 905938 + moreinfo
quit

Hi Ben,

Ben Hutchings wrote:

> git-rebase(1) refers to
> /usr/share/doc/git/html/howto/revert-a-faulty-merge.html, but this
> filename does not exist in any package.  git-doc contains
> /usr/share/doc/git-doc/howto/revert-a-faulty-merge.html which is
> presumably the right file to refer to.

$ ls -ld /usr/share/doc/git/html
lrwxrwxrwx 1 root root 10 May 30  2017 /usr/share/doc/git/html -> ../git-doc

Is it configured differently on your machine?  This setup is from

 commit 894cf6b9c9cd7d9e783637a1033169a546c78276
 Author: Jonathan Nieder 
 Date:   Wed Jan 12 21:42:46 2011 -0600

 debian/rules: install /usr/share/doc/git/html -> ../git-doc symlink

 git documentation being installed by the git-doc package is an
 implementation detail that users shouldn't have to care about.
 After this change, all documentation can be found under
 /usr/share/doc/git.

Arguably it would be better to install directly into
/usr/share/doc/git/html, but that would have broken links (e.g.
kernel-handbook links to [1]).  Perhaps the package should install
docs directly to /usr/share/doc/git/html and put some symlinks in
/usr/share/doc/git-doc --- what do you think?

Thanks,
Jonathan

[1] file:///usr/share/doc/git-doc/git-bisect-lk2009.html



Bug#905938: git-rebase(1) has wrong filename for revert-a-faulty-merge.html

2018-08-11 Thread Ben Hutchings
Package: git-man
Version: 1:2.18.0-1
Severity: normal

git-rebase(1) refers to
/usr/share/doc/git/html/howto/revert-a-faulty-merge.html, but this
filename does not exist in any package.  git-doc contains
/usr/share/doc/git-doc/howto/revert-a-faulty-merge.html which is
presumably the right file to refer to.

Ben.

-- System Information:
Debian Release: buster/sid
  APT prefers unstable-debug
  APT policy: (500, 'unstable-debug'), (500, 'stable-updates'), (500, 
'unstable'), (500, 'stable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 4.17.0-1-amd64 (SMP w/4 CPU cores)
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8), 
LANGUAGE=en_GB.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

-- no debconf information