Skip to contentSkip to conversation

release: don't include temp files

PATCH New Yann E. MORIN 3 participants 6 messages May 8, 2020 – May 10, 2020 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 release: don't include temp files

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Makefile +1 -1
index 3aa4ba4532..2da34b5305 100644
@@ -1190,7 +1190,7 @@ release: OUT = buildroot-$(BR2_VERSION)
 release:
 	git archive --format=tar --prefix=$(OUT)/ HEAD > $(OUT).tar
 	$(MAKE) O=$(OUT) manual-html manual-text manual-pdf
-	$(MAKE) O=$(OUT) clean
+	$(MAKE) O=$(OUT) distclean
 	tar rf $(OUT).tar $(OUT)
 	gzip -9 -c < $(OUT).tar > $(OUT).tar.gz
 	bzip2 -9 -c < $(OUT).tar > $(OUT).tar.bz2
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/1 release: don't include temp files

Quoted 9 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

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

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

Quoted 8 lines

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

I am a bit surprised that our 'make distclean' doesn't delete the generated documentation, but OK - Here it is handy.

Committed, thanks.

Signature · 1 line
Bye, Peter Korsgaard
#2 lore raw

PATCH 1/1 release: don't include temp files

In reply to Yann E. MORIN

Hi Yann,

Quoted 25 lines · Yann E. MORIN

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Makefile +0 -0
index 3aa4ba4532..2da34b5305 100644

Makefile release: OUT = buildroot-$(BR2_VERSION) · line 1193

Quoted 5 lines
Makefile +1 -1
@@ -1190,7 +1190,7 @@ release: OUT = buildroot-$(BR2_VERSION)
 release:
        git archive --format=tar --prefix=$(OUT)/ HEAD > $(OUT).tar
        $(MAKE) O=$(OUT) manual-html manual-text manual-pdf
-       $(MAKE) O=$(OUT) clean
+       $(MAKE) O=$(OUT) distclean

I downloaded the latest rc1, just to do "make distclean", see the files disappear, and add my Tested-by - but I found that the files were not deleted. The distclean target does this:

    rm -rf $(TOPDIR)/dl $(BR2_CONFIG) $(CONFIG_DIR)/.config.old
$(CONFIG_DIR)/..config.tmp \
        $(CONFIG_DIR)/.auto.deps $(BASE_DIR)/.br2-external.*

And BASE_DIR is set to $(CANONICAL_O) - but the .br2-external.* are *not* in the output directory, they are the buildroot directory itself. Maybe it should delete $(CONFIG_DIR)/.br2-external.* instead (or also)?

Danomi -

Quoted 6 lines
Makefile +0 -1
        tar rf $(OUT).tar $(OUT)
        gzip -9 -c < $(OUT).tar > $(OUT).tar.gz
        bzip2 -9 -c < $(OUT).tar > $(OUT).tar.bz2
--

2.20.1

#3 lore raw

PATCH 1/1 release: don't include temp files

Danomi, All,

On 2020-05-08 09:59 -0400, Danomi Manchego spake thusly:

Quoted 20 lines · Yann E. MORIN
Quoted 19 lines

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

Makefile release: OUT = buildroot-$(BR2_VERSION) · line 1193

Quoted 10 lines
Makefile +1 -1
index 3aa4ba4532..2da34b5305 100644
@@ -1190,7 +1190,7 @@ release: OUT = buildroot-$(BR2_VERSION)
 release:
        git archive --format=tar --prefix=$(OUT)/ HEAD > $(OUT).tar
        $(MAKE) O=$(OUT) manual-html manual-text manual-pdf
-       $(MAKE) O=$(OUT) clean
+       $(MAKE) O=$(OUT) distclean

I downloaded the latest rc1,

2020.02-rc1 does not have the fix.

Quoted 4 lines

just to do "make distclean", see the
files disappear, and add my Tested-by - but I found that the files were not deleted. The distclean target does this:

Quoted 8 lines
    rm -rf $(TOPDIR)/dl $(BR2_CONFIG) $(CONFIG_DIR)/.config.old
$(CONFIG_DIR)/..config.tmp \
        $(CONFIG_DIR)/.auto.deps $(BASE_DIR)/.br2-external.*

And BASE_DIR is set to $(CANONICAL_O) - but the .br2-external.* are *not* in the output directory, they are the buildroot directory itself. Maybe it should delete $(CONFIG_DIR)/.br2-external.* instead (or also)?

If you want to test, you should not use a released tarball; instead, you should try to generate one:

    $ make relase
    $ tar tzf buildroot-2020.05-rc1.tar.gz |grep -E '\.br2-external'
    [empty]

So the temporary files will no longer be part of the next releases.

As for 2020.05-rc1, distclean does not remove them, because they are not created where they appear in the release. In the release, they appear at the top of buildroot's directory, becasue when we make the release, we use a hack to include the generated documentatio in the archive; see the rule used to generate the release:

https://git.buildroot.org/buildroot/tree/Makefile#n1186

and subsequent lines...

Regards,
Yann E. MORIN.

Quoted 10 lines

Danomi -

Quoted 6 lines
Makefile +0 -1
        tar rf $(OUT).tar $(OUT)
        gzip -9 -c < $(OUT).tar > $(OUT).tar.gz
        bzip2 -9 -c < $(OUT).tar > $(OUT).tar.bz2
--

2.20.1

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 release: don't include temp files

Yann, I see - thank you for the clarification.
Danomi -

Quoted 92 lines · Yann E. MORIN

Danomi, All,

On 2020-05-08 09:59 -0400, Danomi Manchego spake thusly:

Quoted 20 lines · Yann E. MORIN
Quoted 19 lines

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 12 lines

Makefile release: OUT = buildroot-$(BR2_VERSION) · line 1193

Quoted 10 lines
Makefile +1 -1
index 3aa4ba4532..2da34b5305 100644
@@ -1190,7 +1190,7 @@ release: OUT = buildroot-$(BR2_VERSION)
 release:
        git archive --format=tar --prefix=$(OUT)/ HEAD > $(OUT).tar
        $(MAKE) O=$(OUT) manual-html manual-text manual-pdf
-       $(MAKE) O=$(OUT) clean
+       $(MAKE) O=$(OUT) distclean

I downloaded the latest rc1,

2020.02-rc1 does not have the fix.

Quoted 4 lines

just to do "make distclean", see the
files disappear, and add my Tested-by - but I found that the files were not deleted. The distclean target does this:

Quoted 8 lines
    rm -rf $(TOPDIR)/dl $(BR2_CONFIG) $(CONFIG_DIR)/.config.old
$(CONFIG_DIR)/..config.tmp \
        $(CONFIG_DIR)/.auto.deps $(BASE_DIR)/.br2-external.*

And BASE_DIR is set to $(CANONICAL_O) - but the .br2-external.* are *not* in the output directory, they are the buildroot directory itself. Maybe it should delete $(CONFIG_DIR)/.br2-external.* instead (or also)?

If you want to test, you should not use a released tarball; instead, you should try to generate one:

    $ make relase
    $ tar tzf buildroot-2020.05-rc1.tar.gz |grep -E '\.br2-external'
    [empty]

So the temporary files will no longer be part of the next releases.

As for 2020.05-rc1, distclean does not remove them, because they are not created where they appear in the release. In the release, they appear at the top of buildroot's directory, becasue when we make the release, we use a hack to include the generated documentatio in the archive; see the rule used to generate the release:

https://git.buildroot.org/buildroot/tree/Makefile#n1186

and subsequent lines...

Regards,
Yann E. MORIN.

Quoted 10 lines

Danomi -

Quoted 6 lines
Makefile +0 -1
        tar rf $(OUT).tar $(OUT)
        gzip -9 -c < $(OUT).tar > $(OUT).tar.gz
        bzip2 -9 -c < $(OUT).tar > $(OUT).tar.bz2
--

2.20.1

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

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

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

#5 lore raw

PATCH 1/1 release: don't include temp files

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

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

When we prepare the release, we generate the manual in various formats, so that it can be consulted locally without needing the miriads of tools needed to generate it.

However, this creates the temporary .br2-external.* files in the output directory, and those end up in the release tarball.

Quoted 8 lines

This is not a problem in practice, but is not clean.

Run 'distclean' in the output directory, to get rid of everything but the generated documentation.

Committed to 2020.02.x, thanks.

Signature · 1 line
Bye, Peter Korsgaard