After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 599700 - Misleading Info in INSTALL text
Misleading Info in INSTALL text
Status: RESOLVED FIXED
Product: GIMP-manual
Classification: Other
Component: English
git master
Other All
: Normal minor
: 2.6.1Release
Assigned To: Róman Joost
Róman Joost
Depends on:
Blocks:
 
 
Reported: 2009-10-26 21:21 UTC by Holger
Modified: 2010-06-29 08:56 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Holger 2009-10-26 21:21:14 UTC
In 
http://git.gnome.org/cgit/gimp-help-2/tree/INSTALL
you write:

To install the help files, copy them to your GIMP shared data directory:
    $prefix/share/gimp/2.0/help

That is misleading in two ways:
1. It's not clear that the help dir has to be created first in most cases
2. It's not clear, which directory has to be copied, 'gimp-help2' or 'html' or 'en' or the content only.

The problem arises because unzipping isn't resulting in a single dir, but into a folder structure with three directories like:  .../unpackDir/gimp-help2/html/de/files ...

So maybe you better would write:
To install these unzipped help files, copy the folder 'en' inclusive content to
    $prefix/share/gimp/2.0/help/en/..

If the directory 'help' doesn't exist yet, you'll have to create it first.
Comment 1 Ulf-D. Ehlert 2010-06-16 18:55:01 UTC
I think we need two different INSTALL files: one short file
that describes how to install an HTML package, and another
(main) INSTALL residing in the git repository that describes
what to do if you are working with a cloned git repo.

My suggestion is that we

(1) copy the current INSTALL to make.d/INSTALL.html-package,
    fix the description (using Holger's proposed changes as
    starting point), and let 'make' add it the same way we
    add make.d/Makefile.html-package;

(2) revert the INSTALL changes of commit 820583c7 (2009-09-18)
    so that we get the old INSTALL back, and update it according
    to the current state of repo and build-system.

(Since I'm a Linux-only user, I don't know what to do under any 
non-Linux system, especially under Microsoft Windows).
Comment 2 Róman Joost 2010-06-16 23:07:01 UTC
Scheduling this to be fixed for the next release.
Comment 3 Róman Joost 2010-06-29 08:56:09 UTC
This has been changed in the repository to a more user friendly installation. Thank you the report.