[Buildroot] [git commit branch/2025.02.x] docs/manual: mention checkpackageignore file
Titouan Christophe
titouan.christophe at mind.be
Thu Sep 4 11:57:24 UTC 2025
commit: https://git.buildroot.net/buildroot/commit/?id=608a20d7f36b815968ceb40697b6d7d9fbf15ffc
branch: https://git.buildroot.net/buildroot/commit/?id=refs/heads/2025.02.x
Currently, the manual doesn't mention the checkpackageignore file at
all, leaving the user under the assumption that running "make
check-package" and running utils/check-package directly on the package
they have touched would be equivalent, when the former evaluates the
checkpackageignore file while the latter does not. This could cause them
to forget to remove stale entries from that file.
Point out this difference in behavior.
Signed-off-by: Florian Larysch <fl at n621.de>
[Arnout: add that stale lines should be removed from
.checkpackageignore]
Signed-off-by: Arnout Vandecappelle <arnout at rnout.be>
(cherry picked from commit 47181a164cbfc888d81931e6e3950c379db2f786)
Signed-off-by: Titouan Christophe <titouan.christophe at mind.be>
---
docs/manual/contribute.adoc | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/manual/contribute.adoc b/docs/manual/contribute.adoc
index ffaff6f857..f77aff9d6c 100644
--- a/docs/manual/contribute.adoc
+++ b/docs/manual/contribute.adoc
@@ -321,9 +321,12 @@ Now check the coding style for the changes you committed:
$ utils/docker-run make check-package
----
-Now, you are ready to generate then submit your patch set.
+This command (unlike calling +utils/check-package+ directly) will also warn
+about any stale entries in the +.checkpackageignore+ file that your patches
+might have resolved. If this is the case, make sure to remove those lines
+from +.checkpackageignore+ as well.
-To generate it, run:
+Now, you are ready to generate then submit your patch set. To generate it, run:
----
$ git format-patch -M -n -s -o outgoing origin/master
More information about the buildroot
mailing list