Skip to contentSkip to conversation

docs/manual: dependency documentation updates

PATCH New Dan Walkes 3 participants 5 messages Oct 16, 2019 – Jan 10, 2020

lore
Share & tools
lore

Dan Walkes

author
#0 lore raw

PATCH 1/1 docs/manual: dependency documentation updates

Update dependency documentation to detail the order-only relationship associated with the DEPENDENCIES variable. See the thread at [1] for details.

[1] http://lists.busybox.net/pipermail/buildroot/2019-October/262685.html

---
 docs/manual/adding-packages-generic.txt |  8 +++++---
 docs/manual/rebuilding-packages.txt     | 10 ++++++++++
 2 files changed, 15 insertions(+), 3 deletions(-)
docs/manual/adding-packages-generic.txt +5 -3
index b402767b05..af94f5b1ec 100644
@@ -358,9 +358,11 @@ not and can not work as people would expect it should:
 * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
   name) that are required for the current target package to
   compile. These dependencies are guaranteed to be compiled and
-  installed before the configuration of the current package starts. In
-  a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
-  the current host package.
+  installed before the configuration of the current package starts.
+  However, modifications to configuration of these dependencies will
+  not force a rebuild of the current package. In a similar way,
+  +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for the current
+  host package.
 
 * +LIBFOO_EXTRACT_DEPENDENCIES+ lists the dependencies (in terms of
   package name) that are required for the current target package to be
docs/manual/rebuilding-packages.txt +10 -0
index 6faa67adcb..326cd1fe82 100644
@@ -65,6 +65,16 @@ can help you understand how to work with Buildroot:
    there is no need for a full rebuild: a simple +make+ invocation
    will take the changes into account.
 
+ * When a +FOO_DEPENDENCIES+ package is rebuilt or removed, the package
++foo+ is not automatically rebuilt.  For example, if a package +bar+ is
+listed in +FOO_DEPENDENCIES+ with +FOO_DEPENDENCIES = bar+ and the
+configuration of the +bar+ package is changed, the configuration
+change would not result in a rebuild of package +foo+ automatically.
+In this scenario, you may need to either rebuild any packages in your
+build which reference +bar+ in their +DEPENDENCIES+, or perform a
+full rebuild to ensure any +bar+ dependent packages are
+up to date.
+
 Generally speaking, when you're facing a build error and you're unsure
 of the potential consequences of the configuration changes you've
 made, do a full rebuild. If you get the same build error, then you are
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/1 docs/manual: dependency documentation updates

Dan, All,

On 2019-10-16 11:55 -0600, Dan Walkes spake thusly:

Quoted 7 lines

Update dependency documentation to detail the order-only relationship associated with the DEPENDENCIES variable. See the thread at [1] for details.

[1] http://lists.busybox.net/pipermail/buildroot/2019-October/262685.html

Applied to master, after a slight rephrasing, and a bit of indentation fixup. Thanks.

Regards,
Yann E. MORIN.

Quoted 52 lines
---
 docs/manual/adding-packages-generic.txt |  8 +++++---
 docs/manual/rebuilding-packages.txt     | 10 ++++++++++
 2 files changed, 15 insertions(+), 3 deletions(-)
docs/manual/adding-packages-generic.txt +5 -3
index b402767b05..af94f5b1ec 100644
@@ -358,9 +358,11 @@ not and can not work as people would expect it should:
 * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
   name) that are required for the current target package to
   compile. These dependencies are guaranteed to be compiled and
-  installed before the configuration of the current package starts. In
-  a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
-  the current host package.
+  installed before the configuration of the current package starts.
+  However, modifications to configuration of these dependencies will
+  not force a rebuild of the current package. In a similar way,
+  +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for the current
+  host package.
 
 * +LIBFOO_EXTRACT_DEPENDENCIES+ lists the dependencies (in terms of
   package name) that are required for the current target package to be
docs/manual/rebuilding-packages.txt +10 -0
index 6faa67adcb..326cd1fe82 100644
@@ -65,6 +65,16 @@ can help you understand how to work with Buildroot:
    there is no need for a full rebuild: a simple +make+ invocation
    will take the changes into account.
 
+ * When a +FOO_DEPENDENCIES+ package is rebuilt or removed, the package
++foo+ is not automatically rebuilt.  For example, if a package +bar+ is
+listed in +FOO_DEPENDENCIES+ with +FOO_DEPENDENCIES = bar+ and the
+configuration of the +bar+ package is changed, the configuration
+change would not result in a rebuild of package +foo+ automatically.
+In this scenario, you may need to either rebuild any packages in your
+build which reference +bar+ in their +DEPENDENCIES+, or perform a
+full rebuild to ensure any +bar+ dependent packages are
+up to date.
+
 Generally speaking, when you're facing a build error and you're unsure
 of the potential consequences of the configuration changes you've
 made, do a full rebuild. If you get the same build error, then you are
Signature · 6 lines
2.17.1

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
author
#2 lore raw

PATCH 1/1 docs/manual: dependency documentation updates

Thank you Yann.

I noticed a typo in the modified version at [1] and nightly page at [2] "When a pacjage listed in FOO_DEPENDENCIES is rebuilt or removed" should be
"When a package listed in FOO_DEPENDENCIES is rebuilt or removed"

[1]: https://git.buildroot.net/buildroot/commit/docs/manual/rebuilding-packages.txt?id=05d4ce444580ae54107f3f990e2902169e943d30
[2]: http://nightly.buildroot.org/manual.html

Do you want me to submit a new patch for this?

Quoted 78 lines · Yann E. MORIN

Dan, All,

On 2019-10-16 11:55 -0600, Dan Walkes spake thusly:

Quoted 7 lines

Update dependency documentation to detail the order-only relationship associated with the DEPENDENCIES variable. See the thread at [1] for details.

[1] http://lists.busybox.net/pipermail/buildroot/2019-October/262685.html

Applied to master, after a slight rephrasing, and a bit of indentation fixup. Thanks.

Regards,
Yann E. MORIN.

Quoted 48 lines
---
 docs/manual/adding-packages-generic.txt |  8 +++++---
 docs/manual/rebuilding-packages.txt     | 10 ++++++++++
 2 files changed, 15 insertions(+), 3 deletions(-)
docs/manual/adding-packages-generic.txt +5 -3
index b402767b05..af94f5b1ec 100644
@@ -358,9 +358,11 @@ not and can not work as people would expect it should:
 * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
   name) that are required for the current target package to
   compile. These dependencies are guaranteed to be compiled and
-  installed before the configuration of the current package starts. In
-  a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
-  the current host package.
+  installed before the configuration of the current package starts.
+  However, modifications to configuration of these dependencies will
+  not force a rebuild of the current package. In a similar way,
+  +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for the current
+  host package.
 
 * +LIBFOO_EXTRACT_DEPENDENCIES+ lists the dependencies (in terms of
   package name) that are required for the current target package to be
docs/manual/rebuilding-packages.txt +10 -1
index 6faa67adcb..326cd1fe82 100644
@@ -65,6 +65,16 @@ can help you understand how to work with Buildroot:
    there is no need for a full rebuild: a simple +make+ invocation
    will take the changes into account.
 
+ * When a +FOO_DEPENDENCIES+ package is rebuilt or removed, the package
++foo+ is not automatically rebuilt.  For example, if a package +bar+ is
+listed in +FOO_DEPENDENCIES+ with +FOO_DEPENDENCIES = bar+ and the
+configuration of the +bar+ package is changed, the configuration
+change would not result in a rebuild of package +foo+ automatically.
+In this scenario, you may need to either rebuild any packages in your
+build which reference +bar+ in their +DEPENDENCIES+, or perform a
+full rebuild to ensure any +bar+ dependent packages are
+up to date.
+
 Generally speaking, when you're facing a build error and you're unsure
 of the potential consequences of the configuration changes you've
 made, do a full rebuild. If you get the same build error, then you are
--

2.17.1

Quoted 4 lines

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

--
.-----------------.--------------------.------------------.--------------------.

|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |

'------------------------------^-------^------------------^--------------------'

Signature · 3 lines
Dan Walkes
Trellis-Logic
cell: 720-239-2553
#3 lore raw

PATCH 1/1 docs/manual: dependency documentation updates

Dan, All,

On 2020-01-01 17:41 -0700, Dan Walkes spake thusly:

Quoted 4 lines

I noticed a typo in the modified version at [1] and nightly page at [2] "When a pacjage listed in FOO_DEPENDENCIES is rebuilt or removed" should be
"When a package listed in FOO_DEPENDENCIES is rebuilt or removed"

Fixed, thank you!

Regards,
Yann E. MORIN.

Quoted 96 lines

[1]: https://git.buildroot.net/buildroot/commit/docs/manual/rebuilding-packages.txt?id=05d4ce444580ae54107f3f990e2902169e943d30
[2]: http://nightly.buildroot.org/manual.html

Do you want me to submit a new patch for this?

Quoted 78 lines · Yann E. MORIN

Dan, All,

On 2019-10-16 11:55 -0600, Dan Walkes spake thusly:

Quoted 7 lines

Update dependency documentation to detail the order-only relationship associated with the DEPENDENCIES variable. See the thread at [1] for details.

[1] http://lists.busybox.net/pipermail/buildroot/2019-October/262685.html

Applied to master, after a slight rephrasing, and a bit of indentation fixup. Thanks.

Regards,
Yann E. MORIN.

Quoted 48 lines
---
 docs/manual/adding-packages-generic.txt |  8 +++++---
 docs/manual/rebuilding-packages.txt     | 10 ++++++++++
 2 files changed, 15 insertions(+), 3 deletions(-)
docs/manual/adding-packages-generic.txt +5 -3
index b402767b05..af94f5b1ec 100644
@@ -358,9 +358,11 @@ not and can not work as people would expect it should:
 * +LIBFOO_DEPENDENCIES+ lists the dependencies (in terms of package
   name) that are required for the current target package to
   compile. These dependencies are guaranteed to be compiled and
-  installed before the configuration of the current package starts. In
-  a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
-  the current host package.
+  installed before the configuration of the current package starts.
+  However, modifications to configuration of these dependencies will
+  not force a rebuild of the current package. In a similar way,
+  +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for the current
+  host package.
 
 * +LIBFOO_EXTRACT_DEPENDENCIES+ lists the dependencies (in terms of
   package name) that are required for the current target package to be
docs/manual/rebuilding-packages.txt +10 -1
index 6faa67adcb..326cd1fe82 100644
@@ -65,6 +65,16 @@ can help you understand how to work with Buildroot:
    there is no need for a full rebuild: a simple +make+ invocation
    will take the changes into account.
 
+ * When a +FOO_DEPENDENCIES+ package is rebuilt or removed, the package
++foo+ is not automatically rebuilt.  For example, if a package +bar+ is
+listed in +FOO_DEPENDENCIES+ with +FOO_DEPENDENCIES = bar+ and the
+configuration of the +bar+ package is changed, the configuration
+change would not result in a rebuild of package +foo+ automatically.
+In this scenario, you may need to either rebuild any packages in your
+build which reference +bar+ in their +DEPENDENCIES+, or perform a
+full rebuild to ensure any +bar+ dependent packages are
+up to date.
+
 Generally speaking, when you're facing a build error and you're unsure
 of the potential consequences of the configuration changes you've
 made, do a full rebuild. If you get the same build error, then you are
--

2.17.1

Quoted 4 lines

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

--
.-----------------.--------------------.------------------.--------------------.

|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |

'------------------------------^-------^------------------^--------------------'

Signature · 7 lines
Dan Walkes
Trellis-Logic
cell: 720-239-2553
_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#4 lore raw

PATCH 1/1 docs/manual: dependency documentation updates

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

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

Dan, All,
On 2019-10-16 11:55 -0600, Dan Walkes spake thusly:

Quoted 7 lines

Update dependency documentation to detail the order-only relationship associated with the DEPENDENCIES variable. See the thread at [1] for details.

[1] http://lists.busybox.net/pipermail/buildroot/2019-October/262685.html

Committed to 2019.02.x and 2019.11.x, thanks.

Signature · 1 line
Bye, Peter Korsgaard