Bug 356788 - README in git sources v15.10-16-gdb8826f starts out with factual errors
Summary: README in git sources v15.10-16-gdb8826f starts out with factual errors
Status: RESOLVED FIXED
Alias: None
Product: kdesrc-build
Classification: Developer tools
Component: general (other bugs)
Version First Reported In: Git
Platform: Debian unstable Linux
: NOR normal
Target Milestone: ---
Assignee: Michael Pyne
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-12-16 19:00 UTC by Andreas Koenig
Modified: 2015-12-17 22:58 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed/Implemented In: 15.12
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Andreas Koenig 2015-12-16 19:00:03 UTC
It's a documentation bug, the first section of the README in the git repository git://anongit.kde.org/kdesrc-build.git speaks about a directory that does not exist.

There is the sentence:

      Copy the kdesrc-build directory somewhere where you will be able to find
      it. The whole directory has to go together, so don't just copy the script
      itself.

But there is no kdesrc-build directory, there is just a file kdesrc-build:

% ls -l kdesrc-build
-rwxr-xr-x 1 k k 8026 2015-05-22 11:58:56 kdesrc-build*

Looks like the READMe and reality are a bit out of sync.

Reproducible: Always
Comment 1 Raphael Kubo da Costa 2015-12-16 19:20:51 UTC
Reassigning to the right component.
Comment 2 Michael Pyne 2015-12-17 22:57:11 UTC
The "kdesrc-build directory" is where you cloned kdesrc-build.git to. For any future kdesrc-build tarball releases, the "kdesrc-build directory" would be the directory holding the extracted tarball contents.

I will try to make the wording more clear.
Comment 3 Michael Pyne 2015-12-17 22:58:47 UTC
Git commit 68a5b27f4bfe25aff5ecf0b23ffb0ec0d5160197 by Michael Pyne.
Committed on 17/12/2015 at 22:58.
Pushed by mpyne into branch 'master'.

Update README to be more clear about the install directory.
FIXED-IN:15.12

M  +3    -3    README

http://commits.kde.org/kdesrc-build/68a5b27f4bfe25aff5ecf0b23ffb0ec0d5160197