Bug 15834

Summary: Building documentation from a release tarball fails
Product: [Documentation] General Docs Reporter: Antonin Godard <antonin.godard>
Component: docs-generalAssignee: Antonin Godard <antonin.godard>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium    
Version: unspecified   
Target Milestone: 6.0 M4   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Antonin Godard 2025-04-17 07:18:47 UTC
When building from a release tarball (for example from https://downloads.yoctoproject.org/releases/yocto/yocto-5.1/poky-8f01ae5c7cba251ed25c80f0141a950ebc8a5f73.tar.bz2), going in poky/documentation and running `make html` prints:

  ./set_versions.py
  Please run 'git fetch --tags' before building the documentation
  make: *** [Makefile:72: html] Error 1

Because our build scripts rely on Git to build the documentation.

NB: The bitbake documentation does not have that problem.
Comment 1 Antonin Godard 2025-04-17 14:49:20 UTC
After triage meeting we decided to not support building the docs from tarballs, but make the build print a message saying we don't support building without a Git repo.
Comment 2 Antonin Godard 2026-02-13 09:14:47 UTC
We now explicitly say that we don't support building without Git:
https://git.yoctoproject.org/yocto-docs/commit/?id=f40dc0b42e5e66c5b4618063f8fea72e9f8e4d7c

Moving to Resolved Fixed.