Skip to contentSkip to conversation

docs/manual: clarify the reinstallation of a package

PATCH New Vivien Didelot 3 participants 4 messages Oct 16, 2019 – Oct 30, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/manual: clarify the reinstallation of a package

Since <package>-rebuild implies <package>-reinstall and <package>-reconfigure implies <package>-rebuild, it is confusing to mention the make and make <package> commands when describing the restart of the configuration, compilation and installation of the package.

Therefore remove the ", followed by +make+ or +make <package>+" portions in the "8.3. Understanding how to rebuild packages" section, and add a new paragraph clarifying how to include the rebuilt package in the filesystem image, if that is necessary.

---
 docs/manual/rebuilding-packages.txt | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)
docs/manual/rebuilding-packages.txt +14 -10
index 6faa67adcb..a63c4886ca 100644
@@ -99,16 +99,20 @@ re-configure, re-compile and re-install this package from scratch. You
 can ask buildroot to do this with the +make <package>-dirclean+ command.
 
 On the other hand, if you only want to restart the build process of a
-package from its compilation step, you can run +make
-<package>-rebuild+, followed by +make+ or +make <package>+. It will
-restart the compilation and installation of the package, but not from
-scratch: it basically re-executes +make+ and +make install+
-inside the package, so it will only rebuild files that changed.
-
-If you want to restart the build process of a package from its
-configuration step, you can run +make <package>-reconfigure+, followed
-by +make+ or +make <package>+. It will restart the configuration,
-compilation and installation of the package.
+package from its compilation step, you can run +make <package>-rebuild+. It
+will restart the compilation and installation of the package, but not from
+scratch: it basically re-executes +make+ and +make install+ inside the package,
+so it will only rebuild files that changed.
+
+If you want to restart the build process of a package from its configuration
+step, you can run +make <package>-reconfigure+. It will restart the
+configuration, compilation and installation of the package.
+
+While +<package>-rebuild+ implies +<package>-reinstall+ and
++<package>-reconfigure+ implies +<package>-rebuild+, these targets as well
+as +<package>+ only act on the said package, and do not trigger re-creating
+the root filesystem image. If re-creating the root filesystem in necessary,
+one should run +make+ or +make all+.
 
 Internally, Buildroot creates so-called _stamp files_ to keep track of
 which build steps have been completed for each package. They are
Signature · 1 line
2.23.0
#1 lore raw

PATCH 1/1 docs/manual: clarify the reinstallation of a package

Hello Vivien,

Quoted 6 lines · On Wed, 16 Oct 2019 15:54:44 -0400 Vivien Didelot <[email protected]>…

Since <package>-rebuild implies <package>-reinstall and <package>-reconfigure implies <package>-rebuild, it is confusing to mention the make and make <package> commands when describing the restart of the configuration, compilation and installation of the package.

Quoted 6 lines

Therefore remove the ", followed by +make+ or +make <package>+" portions in the "8.3. Understanding how to rebuild packages" section, and add a new paragraph clarifying how to include the rebuilt package in the filesystem image, if that is necessary.

I've applied, after doing one adjustement, see below.

docs/manual/rebuilding-packages.txt re-configure, re-compile and re-install this package from scratch. You · line 115

Quoted 5 lines
docs/manual/rebuilding-packages.txt +5 -0
+While +<package>-rebuild+ implies +<package>-reinstall+ and
++<package>-reconfigure+ implies +<package>-rebuild+, these targets as well
+as +<package>+ only act on the said package, and do not trigger re-creating
+the root filesystem image. If re-creating the root filesystem in necessary,
+one should run +make+ or +make all+.

change the last line to:

one should in addition run +make+ or +make all+

just to make it clear that "make" or "make all" is not sufficient to force the rebuild of a package: it should be in addition to using <pkg>-rebuild.

Thanks!

Thomas

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

PATCH 1/1 docs/manual: clarify the reinstallation of a package

Hi Thomas,

Quoted 23 lines · Thomas Petazzoni
Quoted 6 lines

Since <package>-rebuild implies <package>-reinstall and <package>-reconfigure implies <package>-rebuild, it is confusing to mention the make and make <package> commands when describing the restart of the configuration, compilation and installation of the package.

Quoted 6 lines

Therefore remove the ", followed by +make+ or +make <package>+" portions in the "8.3. Understanding how to rebuild packages" section, and add a new paragraph clarifying how to include the rebuilt package in the filesystem image, if that is necessary.

I've applied, after doing one adjustement, see below.

docs/manual/rebuilding-packages.txt re-configure, re-compile and re-install this package from scratch. You · line 115

Quoted 5 lines
docs/manual/rebuilding-packages.txt +5 -0
+While +<package>-rebuild+ implies +<package>-reinstall+ and
++<package>-reconfigure+ implies +<package>-rebuild+, these targets as well
+as +<package>+ only act on the said package, and do not trigger re-creating
+the root filesystem image. If re-creating the root filesystem in necessary,
+one should run +make+ or +make all+.

change the last line to:

Quoted 5 lines

one should in addition run +make+ or +make all+

just to make it clear that "make" or "make all" is not sufficient to force the rebuild of a package: it should be in addition to using <pkg>-rebuild.

Much better indeed, thanks!

#3 lore raw

PATCH 1/1 docs/manual: clarify the reinstallation of a package

In reply to Vivien Didelot
Quoted 8 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Vivien" == Vivien Didelot <[email protected]> writes:

Since <package>-rebuild implies <package>-reinstall and <package>-reconfigure implies <package>-rebuild, it is confusing to mention the make and make <package> commands when describing the restart of the configuration, compilation and installation of the package.

Quoted 6 lines

Therefore remove the ", followed by +make+ or +make <package>+" portions in the "8.3. Understanding how to rebuild packages" section, and add a new paragraph clarifying how to include the rebuilt package in the filesystem image, if that is necessary.

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

Signature · 1 line
Bye, Peter Korsgaard