Skip to contentSkip to conversation

ref-manual: Document BUILDHISTORY_PATH_PREFIX_STRIP

PATCH Applied Joshua Watt 2 participants 2 messages Jul 9, 2021 – Jul 12, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ref-manual: Document BUILDHISTORY_PATH_PREFIX_STRIP

---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
documentation/ref-manual/variables.rst +14 -0
index 71c2e11d9..f78b3beec 100644
@@ -1021,6 +1021,20 @@ system and gives an overview of their function and contents.
 
          BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
 
+   :term:`BUILDHISTORY_PATH_PREFIX_STRIP`
+      When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
+      class, this variable specifies a common path prefix that should be
+      stripped off the beginning of paths in the task signature list when the
+      ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be
+      useful when build history is populated from multiple sources that may not
+      all use the same top level directory.
+
+      By default, the ``buildhistory`` class sets the variable as follows::
+
+         BUILDHISTORY_PATH_PREFIX_STRIP ?= ""
+
+      and no prefixes will be stripped.
+
    :term:`BUILDHISTORY_PUSH_REPO`
       When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
       class, this variable optionally specifies a remote repository to
Signature · 1 line
2.32.0
Reviewed-by on v1 1/1 Applied
#1 lore raw

Hi Joshua,

Many thanks for this addition to the reference manual!

Quoted 20 lines · Joshua Watt
---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
documentation/ref-manual/variables.rst +7 -0
index 71c2e11d9..f78b3beec 100644
@@ -1021,6 +1021,20 @@ system and gives an overview of their function and contents.
 
          BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
 
+   :term:`BUILDHISTORY_PATH_PREFIX_STRIP`
+      When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
+      class, this variable specifies a common path prefix that should be
+      stripped off the beginning of paths in the task signature list when the
+      ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be
+      useful when build history is populated from multiple sources that may not
+      all use the same top level directory.

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 1040

Quoted 10 lines
documentation/ref-manual/variables.rst +7 -0
+
+      By default, the ``buildhistory`` class sets the variable as follows::
+
+         BUILDHISTORY_PATH_PREFIX_STRIP ?= ""
+
+      and no prefixes will be stripped.
+
    :term:`BUILDHISTORY_PUSH_REPO`
       When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
       class, this variable optionally specifies a remote repository to

I just modified the last line to be a full sentence. Otherwise, it was looking a bit strange in my opinion.

Merged into master-next. Thanks again!
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com