[Buildroot] [PATCH] docs/manual: clarify the reinstallation of a package

[Buildroot] [PATCH] docs/manual: clarify the reinstallation of a package

[Vivien Didelot]

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.

Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>
---
 docs/manual/rebuilding-packages.txt | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

diff --git a/docs/manual/rebuilding-packages.txt b/docs/manual/rebuilding-packages.txt
index 6faa67adcb..a63c4886ca 100644
--- a/docs/manual/rebuilding-packages.txt
+++ b/docs/manual/rebuilding-packages.txt
@@ -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
-- 
2.23.0

[Buildroot] [PATCH] docs/manual: clarify the reinstallation of a package

[Thomas Petazzoni]

Hello Vivien,

On Wed, 16 Oct 2019 15:54:44 -0400
Vivien Didelot <vivien.didelot@gmail.com> wrote:

> 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.
> 
> Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>

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

> +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
-- 
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[Buildroot] [PATCH] docs/manual: clarify the reinstallation of a package

[Vivien Didelot]

Hi Thomas,

On Mon, 21 Oct 2019 22:03:32 +0200, Thomas Petazzoni <thomas.petazzoni@bootlin.com> wrote:
> > 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.
> > 
> > Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>
> 
> I've applied, after doing one adjustement, see below.
> 
> > +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.

Much better indeed, thanks!

[Buildroot] [PATCH] docs/manual: clarify the reinstallation of a package

[Peter Korsgaard]

>>>>> "Vivien" == Vivien Didelot <vivien.didelot@gmail.com> 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.

 > 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.

 > Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>

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

-- 
Bye, Peter Korsgaard