Skip to contentSkip to conversation

docs/manual: expand on why using a branch name is not supported

PATCH New Yann E. MORIN 3 participants 3 messages Aug 23, 2018 – Aug 26, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/manual: expand on why using a branch name is not supported

Cc Thomas Petazzoni <[email protected]>
Cc Thomas De Schampheleire <[email protected]>

---
Changes v1 -> v2
- reference two users building the same thing (Thomas)
- typoes (Thomas)

---
 docs/manual/adding-packages-generic.txt | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)
docs/manual/adding-packages-generic.txt +15 -2
index cc91e894bd..7be1754f54 100644
@@ -200,11 +200,24 @@ information is (assuming the package name is +libfoo+) :
   package. Note that if +HOST_LIBFOO_VERSION+ doesn't exist, it is
   assumed to be the same as +LIBFOO_VERSION+. It can also be a
   revision number or a tag for packages that are fetched directly
-  from their version control system. Do not use a branch name as
-  version; it does not work. Examples:
+  from their version control system. Examples:
   ** a version for a release tarball: +LIBFOO_VERSION = 0.1.2+
   ** a sha1 for a git tree: +LIBFOO_VERSION = cb9d6aa9429e838f0e54faa3d455bcbab5eef057+
   ** a tag for a git tree +LIBFOO_VERSION = v0.1.2+
++
+.Note:
+Using a branch name as +FOO_VERSION+ is not supported, because it does
+not and can not work as people would expect it should:
++
+  1. due to local caching, Buildroot will not re-fetch the repository,
+     so people who expect to be able to follow the remote repository
+     would be quite surprised and disappointed;
+  2. because two builds can never be perfectly simultaneous, and because
+     the remote repository may get new commits on the branch anytime,
+     two users, using the same Buildroot tree and building the same
+     configuration, may get different source, thus rendering the build
+     non reproducible, and people would be quite surprised and
+     disappointed.
 
 * +LIBFOO_SOURCE+ may contain the name of the tarball of the package,
   which Buildroot will use to download the tarball from
Signature · 1 line
2.14.1
#1 lore raw

PATCH 1/1 docs/manual: expand on why using a branch name is not supported

Hello,

Quoted 11 lines · Yann E. MORIN
Cc Thomas Petazzoni <[email protected]>
Cc Thomas De Schampheleire <[email protected]>

---
Changes v1 -> v2
- reference two users building the same thing (Thomas)
- typoes (Thomas)

---
 docs/manual/adding-packages-generic.txt | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

Applied to master, thanks.

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

PATCH 1/1 docs/manual: expand on why using a branch name is not supported

In reply to Yann E. MORIN
Quoted 10 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Yann" == Yann E MORIN <[email protected]> writes:

Cc Thomas Petazzoni <[email protected]>
Cc Thomas De Schampheleire <[email protected]>

---
Changes v1 -> v2
- reference two users building the same thing (Thomas)
- typoes (Thomas)

Committed to 2018.02.x and 2018.05.x, thanks.

Signature · 1 line
Bye, Peter Korsgaard