Bug 14798 - Instructions to checkout a repository missing a cd
Summary: Instructions to checkout a repository missing a cd
Status: RESOLVED FIXED
Alias: None
Product: Quick Start
Classification: Documentation
Component: quick-start (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Medium+ minor
Target Milestone: 4.1 M2
Assignee: Michael Halstead
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2022-05-09 20:51 UTC by Chris Kottaridis
Modified: 2022-06-17 07:23 UTC (History)
5 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Kottaridis 2022-05-09 20:51:17 UTC
If you follow the instructions in the Yocto Project Release section you get an error when trying to perform the checkout:

$ git clone git://git.yoctoproject.org/poky
Cloning into 'poky'...
remote: Enumerating objects: 561221, done.
remote: Counting objects: 100% (1208/1208), done.
remote: Compressing objects: 100% (774/774), done.
remote: Total 561221 (delta 668), reused 674 (delta 416), pack-reused 560013
Receiving objects: 100% (561221/561221), 182.45 MiB | 3.27 MiB/s, done.
Resolving deltas: 100% (407222/407222), done.
Updating files: 100% (5252/5252), done.
chris@creskotdev:~/tmp/yocto$ git checkout tags/yocto-2.4.2 -b poky_2.4.2
fatal: not a git repository (or any of the parent directories): .git

The instructions need to add a cd to poky. They should look like this:

$ git clone git://git.yoctoproject.org/poky
     Cloning into 'poky'...
     remote: Counting objects: 361782, done.
     remote: Compressing objects: 100% (87100/87100), done.
     remote: Total 361782 (delta 268619), reused 361439 (delta 268277)
     Receiving objects: 100% (361782/361782), 131.94 MiB | 6.88 MiB/s, done.
     Resolving deltas: 100% (268619/268619), done.
     Checking connectivity... done.
$ cd poky
$ git checkout tags/yocto-2.4.2 -b poky_2.4.2

This is a minor issue that most people could figure out. But the fix is easy and it saves an error popping up in the steps that will help build confidence in the instructions for a new user.
Comment 1 Michael Opdenacker 2022-05-20 15:38:08 UTC
Hi Chris
Thanks for reporting issues to us!

Where are the instructions you are referring to?
Are you talking about https://www.yoctoproject.org/software-overview/downloads/?
I see no "git checkout" instructions.

At least in the "Quick Build" document (https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html), we tell people to run "cd" after cloning.

Thanks in advance
Michael.
Comment 2 Michael Opdenacker 2022-06-08 18:42:15 UTC
Hi again

I really can't find the instructions missing a "cd" command.
In particular, I see no such issue in the manuals.

Would you mind pointing us directly at where this happens, please?
Thanks in advance
Michael.
Comment 3 Randy MacLeod 2022-06-09 14:59:22 UTC
Chris?
Comment 4 Ross Burton 2022-06-16 15:14:52 UTC
So the problem here is that if you google "yocto quick start", the top hit is https://www.yoctoproject.org/docs/2.4.2/yocto-project-qs/yocto-project-qs.html, which are obsolete docs from 2018.

Michael: why is this URL not redirecting to docs.yoctoproject.org so we get the "this is obsolete!" header?
Comment 6 Michael Halstead 2022-06-16 19:28:05 UTC
I've added a redirect specifically for the .html version to the docs site with the banner present.

I've reenabled a pattern redirect for all of the www.yoctoproject.org/docs to docs.yoctoproject.org. There is a comment noting that the generic redirect caused problems in the past but I think we are ready to try again. I'm watching the logs for issues.
Comment 7 Michael Opdenacker 2022-06-17 07:23:32 UTC
Looks good to me. Thanks Michael!

Closing this bug, as it is fixed in the new versions of the docs and the old docs are now clearly marked as obsolete.