diff mbox series

[2/2] DOCS-WIP: Add some notes about WORKDIR name and SRCPV changes

Message ID 20230902071358.2409016-2-richard.purdie@linuxfoundation.org
State New
Headers show
Series [1/2] Add DOCS-WIP | expand

Commit Message

Richard Purdie Sept. 2, 2023, 7:13 a.m. UTC
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 DOCS-WIP | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
diff mbox series

Patch

diff --git a/DOCS-WIP b/DOCS-WIP
index 0e2baf9e0bf..0286d50a059 100644
--- a/DOCS-WIP
+++ b/DOCS-WIP
@@ -2,3 +2,22 @@  This file is intended to note docs changes that are being made by commits so
 that people working on the documentation know that changes are needed. This
 includes entries that would make sense for the migration guide or release notes.
 
+The path names in WORKDIR have been simplified to remove PE and PR and just use PV. This change
+also applies to the path to stamp files via STAMP.
+
+Changes have been made to the way source control versions are handled in PV. Instead
+of being injected into PV, these are now injected via PKGV at package generation time.
+This further simplifies directory names using PV and means the resolution of revsisions
+can be more controled and predictable at the bitbake level. Previously, PV could be
+expanded at any point during parsing, the expansion point is now much more predicatable.
+
+The code now only injects the revsision information to PKGV, if ends with a "+"
+character, which was our standard convention for this. As such, SRCPV is no longer
+needed/used and is now simply empty. The variable can be removed from PV.
+
+One change of behaviour is that for git SRC_URI entries, invalid revisions that could never
+be a sha will be assumed to be tags and a resolution will be attempted during parsing. This
+will trigger parsing errors. Recipes should raise SkipRecipe rather than set dummy invalid
+revisions.
+
+